IncidentResource

Manage incident resources, which represent entities involved in incidents (such as materials, equipment, or work environments).
You can create, update, delete, and search for incident resources with advanced filtering and pagination.

Version

2.0.0

OpenAPI version

3.0.0

Operations

index

POST

/v2/incident-resource/index

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

Request Body

Parameters for searching incident resources

object

filter

object

office_incident_resource_id

Primary key for the office incident resource

string format: uuid

office_incident_id

ID of the related office incident

string format: uuid

entity_id

ID of the associated entity

string format: uuid

entity_type

Type of the entity involved in the office incident

string

Allowed values: MATERIAL MATERIAL_ITEM WORK_ENVIRONMENT EQUIPMENT SUBSTANCE WORK_GROUP ACTION

entity_name

Name of the entity

string

entity_code

Code of the entity

string

nullable

tenant_id

ID of the tenant

string format: uuid

subtenant_id

ID of the subtenant

string format: uuid

description

Additional description for the office incident resource

string

nullable

incident_code

Code of the incident

string

nullable

incident_name

Name of the incident

string

incident_date

Date of the incident

string format: date

incident_category

Category of the incident

string

nullable

incident_description_event

Event description of the incident

string

nullable

incident_description_actions_involved

Actions involved in the incident

string

nullable

incident_deponent

Deponent of the incident

string

nullable

incident_status

Status of the incident

string

nullable

Allowed values: open closed

project_name

Name of the project

string

project_type

Type of the project

string

office_name

Name of the office

string

equipment_code

Code of the equipment

string

nullable

equipment_name

Name of the equipment

string

nullable

work_environment_code

Code of the work environment

string

nullable

work_environment_name

Name of the work environment

string

nullable

substance_code

Code of the substance

string

nullable

substance_name

Name of the substance

string

nullable

work_groupF_code

Code of the work group F

string

nullable

work_groupF_name

Name of the work group F

string

nullable

material_code

Code of the material

string

nullable

material_name

Name of the material

string

nullable

material_item_code

Code of the material item

string

nullable

material_item_name

Name of the material item

string

nullable

action_code

Code of the action

string

nullable

action_name

Name of the action

string

nullable

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

Responses

200

List of incident resources

Array<object>

object

office_incident_resource_id

Primary key for the office incident resource

string format: uuid

office_incident_id

ID of the related office incident

string format: uuid

entity_id

ID of the associated entity

string format: uuid

entity_type

Type of the entity involved in the office incident

string

Allowed values: MATERIAL MATERIAL_ITEM WORK_ENVIRONMENT EQUIPMENT SUBSTANCE WORK_GROUP ACTION

entity_name

Name of the entity

string

entity_code

Code of the entity

string

nullable

tenant_id

ID of the tenant

string format: uuid

subtenant_id

ID of the subtenant

string format: uuid

description

Additional description for the office incident resource

string

nullable

incident_code

Code of the incident

string

nullable

incident_name

Name of the incident

string

incident_date

Date of the incident

string format: date

incident_category

Category of the incident

string

nullable

incident_description_event

Event description of the incident

string

nullable

incident_description_actions_involved

Actions involved in the incident

string

nullable

incident_deponent

Deponent of the incident

string

nullable

incident_status

Status of the incident

string

nullable

Allowed values: open closed

project_name

Name of the project

string

project_type

Type of the project

string

office_name

Name of the office

string

equipment_code

Code of the equipment

string

nullable

equipment_name

Name of the equipment

string

nullable

work_environment_code

Code of the work environment

string

nullable

work_environment_name

Name of the work environment

string

nullable

substance_code

Code of the substance

string

nullable

substance_name

Name of the substance

string

nullable

work_groupF_code

Code of the work group F

string

nullable

work_groupF_name

Name of the work group F

string

nullable

material_code

Code of the material

string

nullable

material_name

Name of the material

string

nullable

material_item_code

Code of the material item

string

nullable

material_item_name

Name of the material item

string

nullable

action_code

Code of the action

string

nullable

action_name

Name of the action

string

nullable

Example

{
  "office_incident_resource_id": "ir-1",
  "office_incident_id": "inc-1",
  "entity_id": "eq-1",
  "entity_type": "EQUIPMENT",
  "tenant_id": "ten-1",
  "subtenant_id": "sub-1",
  "description": "Excavator involved in incident"
}

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/incident-resource/create

Create a new incident resource by providing the required details.

Request Body ^required

Incident resource object to be created

object

office_incident_resource_id

Primary key for the office incident resource

string

office_incident_id

ID of the related office incident

string

entity_id

ID of the associated entity

string

entity_type

Type of the entity involved in the office incident

string

Allowed values: MATERIAL WORK_ENVIRONMENT EQUIPMENT SUBSTANCE WORK_GROUP ACTION

tenant_id

ID of the tenant

string

subtenant_id

ID of the subtenant

string

description

Additional description for the office incident resource

string

nullable

Example

{
  "office_incident_id": "inc-1",
  "entity_id": "eq-1",
  "entity_type": "EQUIPMENT",
  "tenant_id": "ten-1",
  "subtenant_id": "sub-1",
  "description": "Excavator involved in incident"
}

Responses

201

Incident resource created successfully

object

office_incident_resource_id

Primary key for the office incident resource

string

office_incident_id

ID of the related office incident

string

entity_id

ID of the associated entity

string

entity_type

Type of the entity involved in the office incident

string

Allowed values: MATERIAL WORK_ENVIRONMENT EQUIPMENT SUBSTANCE WORK_GROUP ACTION

tenant_id

ID of the tenant

string

subtenant_id

ID of the subtenant

string

description

Additional description for the office incident resource

string

nullable

Example

{
  "office_incident_resource_id": "ir-2",
  "office_incident_id": "inc-1",
  "entity_id": "eq-1",
  "entity_type": "EQUIPMENT",
  "tenant_id": "ten-1",
  "subtenant_id": "sub-1",
  "description": "Excavator involved in incident"
}

view

GET

/v2/incident-resource/view/{id}

Retrieve an incident resource by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the incident resource to retrieve

Responses

200

Incident resource found

object

office_incident_resource_id

Primary key for the office incident resource

string format: uuid

office_incident_id

ID of the related office incident

string format: uuid

entity_id

ID of the associated entity

string format: uuid

entity_type

Type of the entity involved in the office incident

string

Allowed values: MATERIAL MATERIAL_ITEM WORK_ENVIRONMENT EQUIPMENT SUBSTANCE WORK_GROUP ACTION

entity_name

Name of the entity

string

entity_code

Code of the entity

string

nullable

tenant_id

ID of the tenant

string format: uuid

subtenant_id

ID of the subtenant

string format: uuid

description

Additional description for the office incident resource

string

nullable

incident_code

Code of the incident

string

nullable

incident_name

Name of the incident

string

incident_date

Date of the incident

string format: date

incident_category

Category of the incident

string

nullable

incident_description_event

Event description of the incident

string

nullable

incident_description_actions_involved

Actions involved in the incident

string

nullable

incident_deponent

Deponent of the incident

string

nullable

incident_status

Status of the incident

string

nullable

Allowed values: open closed

project_name

Name of the project

string

project_type

Type of the project

string

office_name

Name of the office

string

equipment_code

Code of the equipment

string

nullable

equipment_name

Name of the equipment

string

nullable

work_environment_code

Code of the work environment

string

nullable

work_environment_name

Name of the work environment

string

nullable

substance_code

Code of the substance

string

nullable

substance_name

Name of the substance

string

nullable

work_groupF_code

Code of the work group F

string

nullable

work_groupF_name

Name of the work group F

string

nullable

material_code

Code of the material

string

nullable

material_name

Name of the material

string

nullable

material_item_code

Code of the material item

string

nullable

material_item_name

Name of the material item

string

nullable

action_code

Code of the action

string

nullable

action_name

Name of the action

string

nullable

Example

{
  "office_incident_resource_id": "ir-1",
  "office_incident_id": "inc-1",
  "entity_id": "eq-1",
  "entity_type": "EQUIPMENT",
  "tenant_id": "ten-1",
  "subtenant_id": "sub-1",
  "description": "Excavator involved in incident"
}

404

Incident resource not found

delete

DELETE

/v2/incident-resource/delete/{id}

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

Path Parameters

id

required

string format: uuid

ID of the incident resource to delete

Query Parameters

force

boolean

Force the deletion of the entity and all related entities

Responses

204

Incident resource 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/incident-resource/update/{id}

Update an existing incident resource by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the incident resource to update

Request Body ^required

Incident resource object with updated data

object

office_incident_resource_id

Primary key for the office incident resource

string

office_incident_id

ID of the related office incident

string

entity_id

ID of the associated entity

string

entity_type

Type of the entity involved in the office incident

string

Allowed values: MATERIAL WORK_ENVIRONMENT EQUIPMENT SUBSTANCE WORK_GROUP ACTION

tenant_id

ID of the tenant

string

subtenant_id

ID of the subtenant

string

description

Additional description for the office incident resource

string

nullable

Example

{
  "description": "Updated description"
}

Responses

200

Incident resource updated successfully

object

office_incident_resource_id

Primary key for the office incident resource

string

office_incident_id

ID of the related office incident

string

entity_id

ID of the associated entity

string

entity_type

Type of the entity involved in the office incident

string

Allowed values: MATERIAL WORK_ENVIRONMENT EQUIPMENT SUBSTANCE WORK_GROUP ACTION

tenant_id

ID of the tenant

string

subtenant_id

ID of the subtenant

string

description

Additional description for the office incident resource

string

nullable

Example

{
  "office_incident_resource_id": "ir-1",
  "description": "Updated description"
}

404

Incident resource not found