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
Section titled “Operations” 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
Section titled “Request Body ”Parameters for searching incident actions
object
object
Always ACTION
Action_id
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
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.
Example
{ "filter": { "entity_type": "ACTION", "description": "Corrective action" }, "per-page": 10, "page": 1, "sort": "entity_id"}Responses
Section titled “ Responses ”List of incident actions
object
Always ACTION
Action_id
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
Section titled “Headers ”Current page
Total number of pages
Number of items per page
Total number of items
create
Section titled “create” POST /v2/incident-action/create
Create a new incident action by providing the required details.
Request Body required
Section titled “Request Body required ”Incident action object to be created
object
Always ACTION
Action_id
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
Section titled “ Responses ”Incident action created successfully
object
Always ACTION
Action_id
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"} GET /v2/incident-action/view/{id}
Retrieve an incident action by its unique ID.
Path Parameters
Section titled “Path Parameters ”ID of the incident action to retrieve
Responses
Section titled “ Responses ”Incident action found
object
Always ACTION
Action_id
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"}Incident action not found
delete
Section titled “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
Section titled “Path Parameters ”ID of the incident action to delete
Query Parameters
Section titled “Query Parameters ”Force the deletion of the entity and all related entities
Responses
Section titled “ Responses ”Incident action deleted successfully
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
Section titled “update” PUT /v2/incident-action/update/{id}
Update an existing incident action by its unique ID.
Path Parameters
Section titled “Path Parameters ”ID of the incident action to update
Request Body required
Section titled “Request Body required ”Incident action object with updated data
object
Always ACTION
Action_id
Example
{ "description": "Updated action description"}Responses
Section titled “ Responses ”Incident action updated successfully
object
Always ACTION
Action_id
Example
{ "office_incident_action_id": "ia-1", "description": "Updated action description"}Incident action not found