WorkPlaceEntity

Manage work place entities, which represent the association between work places and entities (such as equipment, work environments, or substances).
You can search for work place entities with advanced filtering and pagination.

Version

2.0.0

OpenAPI version

3.0.0

Operations

index

POST

/v2/work-place-entity/index

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

Request Body

Parameters for searching work place entities

object

filter

object

office_entity_work_place_id

The unique identifier for the office entity work place.

string format: uuid

office_work_place_id

The unique identifier for the office work place.

string format: uuid

entity_id

The unique identifier for the entity associated with the work place.

string format: uuid

entity_type

The type of the entity associated with the work place.

string

Allowed values: EQUIPMENT WORK_ENVIRONMENT SUBSTANCE

office_id

The unique identifier for the office.

string format: uuid

project_id

The unique identifier for the project.

string format: uuid

description

A description of the office entity work place, if available.

string

nullable

time_spent_measure

The measure for the time spent at the office work place.

string

nullable

unit_of_measure_id

The unique identifier for the unit of measure.

string format: uuid

nullable

work_place_code

The code for the office work place.

string

work_place_name

The name of the office work place.

string

unit_of_measure_code

The code for the unit of measure.

string

unit_of_measure_name

The name of the unit of measure.

string

entity_name

The name of the entity associated with the office work place.

string

entity_code

The code for the entity associated with the office work place.

string

office_name

The name of the office.

string

office_code

The code for the office.

string

project_name

The name of the project.

string

project_type

The type of the project.

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": {
    "office_work_place_id": "wp-1",
    "entity_type": "EQUIPMENT"
  },
  "per-page": 10,
  "page": 1,
  "sort": "office_work_place_id"
}

Responses

200

List of work place entities

Array<object>

object

office_entity_work_place_id

The unique identifier for the office entity work place.

string format: uuid

office_work_place_id

The unique identifier for the office work place.

string format: uuid

entity_id

The unique identifier for the entity associated with the work place.

string format: uuid

entity_type

The type of the entity associated with the work place.

string

Allowed values: EQUIPMENT WORK_ENVIRONMENT SUBSTANCE

office_id

The unique identifier for the office.

string format: uuid

project_id

The unique identifier for the project.

string format: uuid

description

A description of the office entity work place, if available.

string

nullable

time_spent_measure

The measure for the time spent at the office work place.

string

nullable

unit_of_measure_id

The unique identifier for the unit of measure.

string format: uuid

nullable

work_place_code

The code for the office work place.

string

work_place_name

The name of the office work place.

string

unit_of_measure_code

The code for the unit of measure.

string

unit_of_measure_name

The name of the unit of measure.

string

entity_name

The name of the entity associated with the office work place.

string

entity_code

The code for the entity associated with the office work place.

string

office_name

The name of the office.

string

office_code

The code for the office.

string

project_name

The name of the project.

string

project_type

The type of the project.

string

Example

{
  "office_entity_work_place_id": "wpe-1",
  "office_work_place_id": "wp-1",
  "entity_id": "eq-1",
  "entity_type": "EQUIPMENT",
  "office_id": "off-1",
  "project_id": "proj-1",
  "work_place_name": "Work Place 1",
  "entity_name": "Excavator"
}

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-place-entity/view/{id}

Retrieve a work place entity by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the work place entity to retrieve

Responses

200

Work place entity found

object

office_entity_work_place_id

The unique identifier for the office entity work place.

string format: uuid

office_work_place_id

The unique identifier for the office work place.

string format: uuid

entity_id

The unique identifier for the entity associated with the work place.

string format: uuid

entity_type

The type of the entity associated with the work place.

string

Allowed values: EQUIPMENT WORK_ENVIRONMENT SUBSTANCE

office_id

The unique identifier for the office.

string format: uuid

project_id

The unique identifier for the project.

string format: uuid

description

A description of the office entity work place, if available.

string

nullable

time_spent_measure

The measure for the time spent at the office work place.

string

nullable

unit_of_measure_id

The unique identifier for the unit of measure.

string format: uuid

nullable

work_place_code

The code for the office work place.

string

work_place_name

The name of the office work place.

string

unit_of_measure_code

The code for the unit of measure.

string

unit_of_measure_name

The name of the unit of measure.

string

entity_name

The name of the entity associated with the office work place.

string

entity_code

The code for the entity associated with the office work place.

string

office_name

The name of the office.

string

office_code

The code for the office.

string

project_name

The name of the project.

string

project_type

The type of the project.

string

Example

{
  "office_entity_work_place_id": "wpe-1",
  "office_work_place_id": "wp-1",
  "entity_id": "eq-1",
  "entity_type": "EQUIPMENT",
  "office_id": "off-1",
  "project_id": "proj-1",
  "work_place_name": "Work Place 1",
  "entity_name": "Excavator"
}

404

Work place entity not found