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
Section titled “Operations” 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
Section titled “Request Body ”Parameters for searching entity employees
object
object
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
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.
Example
{ "filter": { "type": "EQUIPMENT" }, "per-page": 10, "page": 1, "sort": "entity_id"}Responses
Section titled “ Responses ”List of entity employees
object
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
Section titled “Headers ”Current page
Total number of pages
Number of items per page
Total number of items
create
Section titled “create” POST /v2/entity-employee/create
Create a new entity employee by providing the required details.
Request Body required
Section titled “Request Body required ”Entity employee object to be created
object
Example
{ "entity_id": "ent-1", "person_office_id": "po-1", "type": "EQUIPMENT", "office_id": "off-1", "project_id": "proj-1"}Responses
Section titled “ Responses ”Entity employee created successfully
object
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"} GET /v2/entity-employee/view/{id}
Retrieve an entity employee by its unique ID.
Path Parameters
Section titled “Path Parameters ”ID of the entity employee to retrieve
Responses
Section titled “ Responses ”Entity employee found
object
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"}Entity employee not found
delete
Section titled “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
Section titled “Path Parameters ”ID of the entity employee to delete
Query Parameters
Section titled “Query Parameters ”Force the deletion of the entity and all related entities
Responses
Section titled “ Responses ”Entity employee deleted successfully
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
Section titled “update” PUT /v2/entity-employee/update/{id}
Update an existing entity employee by its unique ID.
Path Parameters
Section titled “Path Parameters ”ID of the entity employee to update
Request Body required
Section titled “Request Body required ”Entity employee object with updated data
object
Example
{ "type": "WORK_ENVIRONMENT"}Responses
Section titled “ Responses ”Entity employee updated successfully
object
Example
{ "entity_employee_id": "ee-1", "type": "WORK_ENVIRONMENT"}Entity employee not found