WorkGroupEntity

Manage work group entities, which represent the association between work groups and entities (such as equipment, work environments, or substances).
You can create, update, delete, and search for work group entities with advanced filtering and pagination.

Version

2.0.0

OpenAPI version

3.0.0

Operations

index

POST

/v2/work-group-entity/index

Returns a paginated and filterable list of work group entities.
Use POST to allow complex filters via JSON payload.

Request Body

Parameters for searching work group entities

object

filter

object

work_group_entity_id

string format: uuid

work_group_id

string format: uuid

entity_id

string format: uuid

entity_type

string

Allowed values: EQUIPMENT WORK_ENVIRONMENT SUBSTANCE

work_group_code

string

work_group_name

string

work_group_type

string

entity_name

string

entity_code

string

office_name

string

office_code

string

project_name

string

project_type

string

per-page

integer

default: 100 >= 1

page

integer

default: 1 >= 1

sort

string

Allowed values: work_group_code work_group_name work_group_type entity_name entity_code entity_type

history

boolean

Example

{
  "filter": {
    "work_group_name": "My group",
    "entity_type": "EQUIPMENT"
  },
  "per-page": 50,
  "page": 2,
  "sort": "-work_group_name"
}

Responses

200

List of work group entities

Array<object>

object

work_group_entity_id

string format: uuid

work_group_id

string format: uuid

entity_id

string format: uuid

entity_type

string

Allowed values: EQUIPMENT WORK_ENVIRONMENT SUBSTANCE

description

string

time_spent_measure

string

unit_of_measure_id

string format: uuid

work_group_code

string

work_group_name

string

work_group_type

string

unit_of_measure_code

string

unit_of_measure_name

string

entity_name

string

entity_code

string

office_name

string

office_code

string

project_name

string

project_type

string

owned_active

boolean

parent_active

boolean

Example

{
  "work_group_entity_id": "wge-1",
  "work_group_id": "wg-1",
  "entity_id": "eq-1",
  "entity_type": "EQUIPMENT",
  "description": "Main excavator",
  "work_group_code": "GRP-001",
  "work_group_name": "My group",
  "entity_name": "Excavator",
  "office_name": "Main Office"
}

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

view

GET

/v2/work-group-entity/view/{id}

Retrieve a work group entity by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the work group entity to retrieve

Responses

200

Work group entity found

object

work_group_entity_id

required

string

work_group_id

required

string

entity_id

required

string

entity_type

required

string

Allowed values: EQUIPMENT WORK_ENVIRONMENT SUBSTANCE

description

string

time_spent_measure

string

unit_of_measure_id

string

Example

{
  "work_group_entity_id": "wge-1",
  "work_group_id": "wg-1",
  "entity_id": "eq-1",
  "entity_type": "EQUIPMENT",
  "description": "Main excavator",
  "work_group_code": "GRP-001",
  "work_group_name": "My group",
  "entity_name": "Excavator",
  "office_name": "Main Office"
}

404

Work group entity not found

create

POST

/v2/work-group-entity/create

Create a new work group entity by providing the required details.

Request Body ^required

Work group entity object to be created

object

work_group_entity_id

required

string

work_group_id

required

string

entity_id

required

string

entity_type

required

string

Allowed values: EQUIPMENT WORK_ENVIRONMENT SUBSTANCE

description

string

time_spent_measure

string

unit_of_measure_id

string

Example

{
  "work_group_id": "wg-2",
  "entity_id": "eq-2",
  "entity_type": "EQUIPMENT",
  "description": "Support excavator"
}

Responses

201

Work group entity created successfully

object

work_group_entity_id

required

string

work_group_id

required

string

entity_id

required

string

entity_type

required

string

Allowed values: EQUIPMENT WORK_ENVIRONMENT SUBSTANCE

description

string

time_spent_measure

string

unit_of_measure_id

string

Example

{
  "work_group_entity_id": "wge-2",
  "work_group_id": "wg-2",
  "entity_id": "eq-2",
  "entity_type": "EQUIPMENT",
  "description": "Support excavator"
}

update

PUT

/v2/work-group-entity/update/{id}

Update an existing work group entity by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the work group entity to update

Request Body ^required

Work group entity object with updated data

object

work_group_entity_id

required

string

work_group_id

required

string

entity_id

required

string

entity_type

required

string

Allowed values: EQUIPMENT WORK_ENVIRONMENT SUBSTANCE

description

string

time_spent_measure

string

unit_of_measure_id

string

Example

{
  "description": "Updated description"
}

Responses

200

Work group entity updated successfully

object

work_group_entity_id

required

string

work_group_id

required

string

entity_id

required

string

entity_type

required

string

Allowed values: EQUIPMENT WORK_ENVIRONMENT SUBSTANCE

description

string

time_spent_measure

string

unit_of_measure_id

string

Example

{
  "work_group_entity_id": "wge-1",
  "description": "Updated description"
}

404

Work group entity not found

delete

DELETE

/v2/work-group-entity/delete/{id}

Delete a work group entity by its unique ID.
If force=true, all related entities will also be deleted.

Path Parameters

id

required

string format: uuid

ID of the work group entity to delete

Query Parameters

force

boolean

Force the deletion of the entity and all related entities

Responses

204

Work group entity 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