Demand

Manage demands, which represent requirements or requests for resources, actions, or compliance.
You can create, update, delete, and search for demands with advanced filtering and pagination.

Version

2.0.0

OpenAPI version

3.0.0

Operations

index

POST

/v2/demand/index

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

Request Body

Parameters for searching demands

object

filter

object

demand_id

string format: uuid

action_id

string format: uuid

action_type

string

Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER

resource_id

string format: uuid

resource_type

string

Allowed values: MATERIAL_ITEM ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT

office_id

string format: uuid

project_id

string format: uuid

data

Additional data

string format: json

action_code

string

action_name

string

resource_code

string

resource_name

string

owned_active

boolean

parent_active

boolean

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": {
    "action_type": "TRAINING",
    "resource_type": "WORK_ENVIRONMENT"
  },
  "per-page": 20,
  "page": 1,
  "sort": "action_name"
}

Responses

200

List of demands

Array<object>

object

demand_id

string format: uuid

action_id

string format: uuid

action_type

string

Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER

resource_id

string format: uuid

resource_type

string

Allowed values: MATERIAL_ITEM ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT

office_id

string format: uuid

project_id

string format: uuid

data

Additional data

string format: json

action_code

string

action_name

string

resource_code

string

resource_name

string

owned_active

boolean

parent_active

boolean

Example

{
  "demand_id": "dem-1",
  "action_id": "act-1",
  "action_type": "TRAINING",
  "resource_id": "res-1",
  "resource_type": "WORK_ENVIRONMENT",
  "office_id": "off-1",
  "project_id": "proj-1",
  "action_name": "Safety Training",
  "resource_name": "Main Room"
}

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/demand/create

Create a new demand by providing the required details.

Request Body ^required

Demand object to be created

object

demand_id

string

action_id

string

action_type

string

Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER

resource_id

string

resource_type

string

Allowed values: MATERIAL_ITEM ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT

data

Additional data

string format: json

Example

{
  "action_id": "act-1",
  "action_type": "TRAINING",
  "resource_id": "res-1",
  "resource_type": "WORK_ENVIRONMENT"
}

Responses

201

Demand created successfully

object

demand_id

string

action_id

string

action_type

string

Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER

resource_id

string

resource_type

string

Allowed values: MATERIAL_ITEM ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT

data

Additional data

string format: json

Example

{
  "demand_id": "dem-2",
  "action_id": "act-1",
  "action_type": "TRAINING",
  "resource_id": "res-1",
  "resource_type": "WORK_ENVIRONMENT"
}

view

GET

/v2/demand/view/{id}

Retrieve a demand by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the demand to retrieve

Responses

200

Demand found

object

demand_id

string format: uuid

action_id

string format: uuid

action_type

string

Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER

resource_id

string format: uuid

resource_type

string

Allowed values: MATERIAL_ITEM ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT

office_id

string format: uuid

project_id

string format: uuid

data

Additional data

string format: json

action_code

string

action_name

string

resource_code

string

resource_name

string

owned_active

boolean

parent_active

boolean

Example

{
  "demand_id": "dem-1",
  "action_id": "act-1",
  "action_type": "TRAINING",
  "resource_id": "res-1",
  "resource_type": "WORK_ENVIRONMENT",
  "office_id": "off-1",
  "project_id": "proj-1",
  "action_name": "Safety Training",
  "resource_name": "Main Room"
}

404

Demand not found

delete

DELETE

/v2/demand/delete/{id}

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

Path Parameters

id

required

string format: uuid

ID of the demand to delete

Query Parameters

force

boolean

Force the deletion of the entity and all related entities

Responses

204

Demand 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/demand/update/{id}

Update an existing demand by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the demand to update

Request Body ^required

Demand object with updated data

object

demand_id

string

action_id

string

action_type

string

Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER

resource_id

string

resource_type

string

Allowed values: MATERIAL_ITEM ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT

data

Additional data

string format: json

Example

{
  "resource_type": "WORK_ENVIRONMENT"
}

Responses

200

Demand updated successfully

object

demand_id

string

action_id

string

action_type

string

Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER

resource_id

string

resource_type

string

Allowed values: MATERIAL_ITEM ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT

data

Additional data

string format: json

Example

{
  "demand_id": "dem-1",
  "resource_type": "WORK_ENVIRONMENT"
}

404

Demand not found