EntityEmployee

Manage entity employees, which represent the association between entities and employees (such as people, equipment, or roles).
You can create, update, delete, and search for entity employees with advanced filtering and pagination.

Version

2.0.0

OpenAPI version

3.0.0

Operations

index

POST

/v2/entity-employee/index

Returns a paginated and filterable list of entity employees.
Use POST to allow complex filters via JSON payload.

Request Body

Parameters for searching entity employees

object

filter

object

entity_employee_id

string format: uuid

entity_id

string format: uuid

person_office_id

string format: uuid

type

string

Allowed values: EQUIPMENT WORK_ENVIRONMENT SUBSTANCE ROLE

office_id

string format: uuid

project_id

string format: uuid

person_id

string format: uuid

person_code

string

person_last_name

string

person_first_name

string

person_is_external

string

owned_active

boolean

parent_active

boolean

office_name

string

project_name

string

project_type

string

entity_code

string

entity_name

string

per-page

integer

default: 100 >= 1

page

integer

default: 1 >= 1

sort

The field of the model to sort the list for, use a minus to revert the sort. Es -name is to require the sort in reverse order

string

history

The field establishes whether to also include historized elements that are no longer active in the results. If you leave this parameter empty the response returns only actual entries.

boolean

Example

{
  "filter": {
    "type": "EQUIPMENT"
  },
  "per-page": 10,
  "page": 1,
  "sort": "entity_id"
}

Responses

200

List of entity employees

Array<object>

object

entity_employee_id

string format: uuid

entity_id

string format: uuid

person_office_id

string format: uuid

type

string

Allowed values: EQUIPMENT WORK_ENVIRONMENT SUBSTANCE ROLE

office_id

string format: uuid

project_id

string format: uuid

person_id

string format: uuid

person_code

string

person_last_name

string

person_first_name

string

person_is_external

string

owned_active

boolean

parent_active

boolean

office_name

string

project_name

string

project_type

string

entity_code

string

entity_name

string

Example

{
  "entity_employee_id": "ee-1",
  "entity_id": "ent-1",
  "person_office_id": "po-1",
  "type": "EQUIPMENT",
  "office_id": "off-1",
  "project_id": "proj-1"
}

Headers

X-Pagination-Current-Page

integer

Current page

X-Pagination-Page-Count

integer

Total number of pages

X-Pagination-Per-Page

integer

Number of items per page

X-Pagination-Total-Count

integer

Total number of items

create

POST

/v2/entity-employee/create

Create a new entity employee by providing the required details.

Request Body ^required

Entity employee object to be created

object

entity_employee_id

string

entity_id

string

person_office_id

string

type

string

Allowed values: EQUIPMENT WORK_ENVIRONMENT SUBSTANCE ROLE

office_id

string

project_id

string

Example

{
  "entity_id": "ent-1",
  "person_office_id": "po-1",
  "type": "EQUIPMENT",
  "office_id": "off-1",
  "project_id": "proj-1"
}

Responses

201

Entity employee created successfully

object

entity_employee_id

string

entity_id

string

person_office_id

string

type

string

Allowed values: EQUIPMENT WORK_ENVIRONMENT SUBSTANCE ROLE

office_id

string

project_id

string

Example

{
  "entity_employee_id": "ee-2",
  "entity_id": "ent-1",
  "person_office_id": "po-1",
  "type": "EQUIPMENT",
  "office_id": "off-1",
  "project_id": "proj-1"
}

view

GET

/v2/entity-employee/view/{id}

Retrieve an entity employee by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the entity employee to retrieve

Responses

200

Entity employee found

object

entity_employee_id

string format: uuid

entity_id

string format: uuid

person_office_id

string format: uuid

type

string

Allowed values: EQUIPMENT WORK_ENVIRONMENT SUBSTANCE ROLE

office_id

string format: uuid

project_id

string format: uuid

person_id

string format: uuid

person_code

string

person_last_name

string

person_first_name

string

person_is_external

string

owned_active

boolean

parent_active

boolean

office_name

string

project_name

string

project_type

string

entity_code

string

entity_name

string

Example

{
  "entity_employee_id": "ee-1",
  "entity_id": "ent-1",
  "person_office_id": "po-1",
  "type": "EQUIPMENT",
  "office_id": "off-1",
  "project_id": "proj-1"
}

404

Entity employee not found

delete

DELETE

/v2/entity-employee/delete/{id}

Delete an entity employee by its unique ID.
If force=true, all related entities will also be deleted.

Path Parameters

id

required

string format: uuid

ID of the entity employee to delete

Query Parameters

force

boolean

Force the deletion of the entity and all related entities

Responses

204

Entity employee deleted successfully

400

If force=false, the operation is interrupted and the list of connected entities that will be deleted in case of confirmation (force=true) is returned

update

PUT

/v2/entity-employee/update/{id}

Update an existing entity employee by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the entity employee to update

Request Body ^required

Entity employee object with updated data

object

entity_employee_id

string

entity_id

string

person_office_id

string

type

string

Allowed values: EQUIPMENT WORK_ENVIRONMENT SUBSTANCE ROLE

office_id

string

project_id

string

Example

{
  "type": "WORK_ENVIRONMENT"
}

Responses

200

Entity employee updated successfully

object

entity_employee_id

string

entity_id

string

person_office_id

string

type

string

Allowed values: EQUIPMENT WORK_ENVIRONMENT SUBSTANCE ROLE

office_id

string

project_id

string

Example

{
  "entity_employee_id": "ee-1",
  "type": "WORK_ENVIRONMENT"
}

404

Entity employee not found