IncidentAction

Manage incident actions, which represent actions linked to incidents (such as corrective or preventive actions).
You can create, update, delete, and search for incident actions with advanced filtering and pagination.

Version

2.0.0

OpenAPI version

3.0.0

Operations

index

POST

/v2/incident-action/index

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

Request Body

Parameters for searching incident actions

object

filter

object

office_incident_action_id

string format: uuid

office_incident_id

string format: uuid

entity_type

Always ACTION

string

entity_id

Action_id

string format: uuid

description

string

subtenant_id

string format: uuid

tenant_id

string format: uuid

action_code

string

action_name

string

action_type

string

incident_code

string

incident_name

string

incident_date

string format: date

incident_category

string

incident_description_event

string

incident_description_actions_involved

string

incident_deponent

string

incident_status

string

Allowed values: open closed

project_name

string

project_type

string

office_name

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

Responses

200

List of incident actions

Array<object>

object

office_incident_action_id

string format: uuid

office_incident_id

string format: uuid

entity_type

Always ACTION

string

entity_id

Action_id

string format: uuid

description

string

subtenant_id

string format: uuid

tenant_id

string format: uuid

action_code

string

action_name

string

action_type

string

incident_code

string

incident_name

string

incident_date

string format: date

incident_category

string

incident_description_event

string

incident_description_actions_involved

string

incident_deponent

string

incident_status

string

Allowed values: open closed

project_name

string

project_type

string

office_name

string

Example

{
  "office_incident_action_id": "ia-1",
  "office_incident_id": "inc-1",
  "entity_type": "ACTION",
  "entity_id": "act-1",
  "description": "Corrective action",
  "subtenant_id": "sub-1",
  "tenant_id": "ten-1"
}

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

Create a new incident action by providing the required details.

Request Body ^required

Incident action object to be created

object

office_incident_action_id

string

office_incident_id

string

entity_type

Always ACTION

string

entity_id

Action_id

string

description

string

subtenant_id

string

tenant_id

string

Example

{
  "office_incident_id": "inc-1",
  "entity_type": "ACTION",
  "entity_id": "act-1",
  "description": "Preventive action",
  "subtenant_id": "sub-1",
  "tenant_id": "ten-1"
}

Responses

201

Incident action created successfully

object

office_incident_action_id

string

office_incident_id

string

entity_type

Always ACTION

string

entity_id

Action_id

string

description

string

subtenant_id

string

tenant_id

string

Example

{
  "office_incident_action_id": "ia-2",
  "office_incident_id": "inc-1",
  "entity_type": "ACTION",
  "entity_id": "act-1",
  "description": "Preventive action",
  "subtenant_id": "sub-1",
  "tenant_id": "ten-1"
}

view

GET

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

Retrieve an incident action by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the incident action to retrieve

Responses

200

Incident action found

object

office_incident_action_id

string format: uuid

office_incident_id

string format: uuid

entity_type

Always ACTION

string

entity_id

Action_id

string format: uuid

description

string

subtenant_id

string format: uuid

tenant_id

string format: uuid

action_code

string

action_name

string

action_type

string

incident_code

string

incident_name

string

incident_date

string format: date

incident_category

string

incident_description_event

string

incident_description_actions_involved

string

incident_deponent

string

incident_status

string

Allowed values: open closed

project_name

string

project_type

string

office_name

string

Example

{
  "office_incident_action_id": "ia-1",
  "office_incident_id": "inc-1",
  "entity_type": "ACTION",
  "entity_id": "act-1",
  "description": "Corrective action",
  "subtenant_id": "sub-1",
  "tenant_id": "ten-1"
}

404

Incident action not found

delete

DELETE

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

Delete an incident action 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 action to delete

Query Parameters

force

boolean

Force the deletion of the entity and all related entities

Responses

204

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

Update an existing incident action by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the incident action to update

Request Body ^required

Incident action object with updated data

object

office_incident_action_id

string

office_incident_id

string

entity_type

Always ACTION

string

entity_id

Action_id

string

description

string

subtenant_id

string

tenant_id

string

Example

{
  "description": "Updated action description"
}

Responses

200

Incident action updated successfully

object

office_incident_action_id

string

office_incident_id

string

entity_type

Always ACTION

string

entity_id

Action_id

string

description

string

subtenant_id

string

tenant_id

string

Example

{
  "office_incident_action_id": "ia-1",
  "description": "Updated action description"
}

404

Incident action not found