Skip to content
4HSE Developers DEV

IncidentAction

An IncidentAction links an incident to a corrective or preventive action. It indicates that an action has been taken or must be taken in response to the incident.

Use this API to:

  • Link corrective/preventive actions to an incident
  • Find all actions linked to an incident (filter by office_incident_id)
  • Find all incidents linked to an action (filter by entity_id)
Version
2.0.0
OpenAPI version
3.0.0

Authentication

Section titled “ Authentication ”

OAuth2

Section titled “OAuth2 ”

Security scheme type: oauth2

Flow type: password

Token URL: https://auth.4hse.com/realms/4hse/protocol/openid-connect/token

AccessToken

Section titled “AccessToken ”

Security scheme type: apiKey

Query parameter name: access-token

Operations

Section titled “Operations”

index

Section titled “index”
POST
/v2/incident-action/index

Returns a paginated list of incident-action links.

Most useful filters:

  • office_incident_id: all actions linked to a specific incident
  • entity_id (action_id): all incidents linked to a specific action
  • action_type: filter by action type

Authorizations

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”

Parameters for searching

object
filter
object
office_incident_action_id
string format: uuid
office_incident_id
string format: uuid
entity_type
string
entity_id
string format: uuid
description
string
subtenant_id
string format: uuid
tenant_id
string format: uuid
action_code

Code of the linked action.

string
action_name

Name of the linked action.

string
action_type

Type of the linked action.

string
Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER
incident_code
string
incident_name
string
incident_date
string format: date
incident_category
string
incident_status
string
Allowed values: new open closed
project_name
string
project_type
string
Allowed values: safety template
office_name
string
per-page
integer
default: 100 >= 1
page
integer
default: 1 >= 1
sort
string
Allowed values: action_code action_name action_type incident_name incident_date office_name
Example
{
  "filter": {
    "office_incident_id": "5c6d7e8f-9012-3456-abcd-ef5678901234"
  },
  "per-page": 20,
  "page": 1,
  "sort": "action_name"
}

Responses

Section titled “ Responses ”
200
Section titled “200 ”

List of incident-action links

Array<object>
object
office_incident_action_id
string format: uuid
office_incident_id
string format: uuid
entity_type
string
entity_id
string format: uuid
description
string
subtenant_id
string format: uuid
tenant_id
string format: uuid
action_code

Code of the linked action.

string
action_name

Name of the linked action.

string
action_type

Type of the linked action.

string
Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER
incident_code
string
incident_name
string
incident_date
string format: date
incident_category
string
incident_status
string
Allowed values: new open closed
project_name
string
project_type
string
Allowed values: safety template
office_name
string

Headers

Section titled “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

Section titled “create”
POST
/v2/incident-action/create

Links a corrective/preventive action to an incident.

Requires office_incident_id, entity_id (the action_id), entity_type (always ACTION), subtenant_id (office_id), and tenant_id (project_id). The office_incident_action_id is auto-generated if not provided.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”

Incident-action link to create

object
office_incident_action_id

Unique identifier. Auto-generated if not provided.

string format: uuid
office_incident_id
required

The incident. Pass the office_incident_id from the Incident API.

string format: uuid
<= 50 characters
entity_type
required

Always ACTION.

string
<= 50 characters
entity_id
required

The corrective/preventive action. Pass the action_id from the Action API.

string format: uuid
<= 50 characters
description

Optional description of why this action was linked (e.g. corrective action rationale).

string
nullable
subtenant_id
required

The office. Pass the office_id.

string format: uuid
<= 50 characters
tenant_id
required

The project (company). Pass the project_id.

string format: uuid
<= 50 characters

Responses

Section titled “ Responses ”
201
Section titled “201 ”

Action linked to incident successfully

object
office_incident_action_id

Unique identifier. Auto-generated if not provided.

string format: uuid
office_incident_id
required

The incident. Pass the office_incident_id from the Incident API.

string format: uuid
<= 50 characters
entity_type
required

Always ACTION.

string
<= 50 characters
entity_id
required

The corrective/preventive action. Pass the action_id from the Action API.

string format: uuid
<= 50 characters
description

Optional description of why this action was linked (e.g. corrective action rationale).

string
nullable
subtenant_id
required

The office. Pass the office_id.

string format: uuid
<= 50 characters
tenant_id
required

The project (company). Pass the project_id.

string format: uuid
<= 50 characters

view

Section titled “view”
GET
/v2/incident-action/view/{id}

Retrieves a single incident-action link by its ID.

Authorizations

Section titled “Authorizations ”

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

The office_incident_action_id to retrieve.

Responses

Section titled “ Responses ”
200
Section titled “200 ”

Incident-action link found

object
office_incident_action_id
string format: uuid
office_incident_id
string format: uuid
entity_type
string
entity_id
string format: uuid
description
string
subtenant_id
string format: uuid
tenant_id
string format: uuid
action_code

Code of the linked action.

string
action_name

Name of the linked action.

string
action_type

Type of the linked action.

string
Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER
incident_code
string
incident_name
string
incident_date
string format: date
incident_category
string
incident_status
string
Allowed values: new open closed
project_name
string
project_type
string
Allowed values: safety template
office_name
string
404
Section titled “404 ”

Not found

update

Section titled “update”
PUT
/v2/incident-action/update/{id}

Updates an existing incident-action link.

Authorizations

Section titled “Authorizations ”

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

The office_incident_action_id to update.

Request Body required

Section titled “Request Body required ”

Fields to update

object
office_incident_action_id

Unique identifier. Auto-generated if not provided.

string format: uuid
office_incident_id
required

The incident. Pass the office_incident_id from the Incident API.

string format: uuid
<= 50 characters
entity_type
required

Always ACTION.

string
<= 50 characters
entity_id
required

The corrective/preventive action. Pass the action_id from the Action API.

string format: uuid
<= 50 characters
description

Optional description of why this action was linked (e.g. corrective action rationale).

string
nullable
subtenant_id
required

The office. Pass the office_id.

string format: uuid
<= 50 characters
tenant_id
required

The project (company). Pass the project_id.

string format: uuid
<= 50 characters

Responses

Section titled “ Responses ”
200
Section titled “200 ”

Updated successfully

object
office_incident_action_id

Unique identifier. Auto-generated if not provided.

string format: uuid
office_incident_id
required

The incident. Pass the office_incident_id from the Incident API.

string format: uuid
<= 50 characters
entity_type
required

Always ACTION.

string
<= 50 characters
entity_id
required

The corrective/preventive action. Pass the action_id from the Action API.

string format: uuid
<= 50 characters
description

Optional description of why this action was linked (e.g. corrective action rationale).

string
nullable
subtenant_id
required

The office. Pass the office_id.

string format: uuid
<= 50 characters
tenant_id
required

The project (company). Pass the project_id.

string format: uuid
<= 50 characters
404
Section titled “404 ”

Not found

delete

Section titled “delete”
DELETE
/v2/incident-action/delete/{id}

Deletes an incident-action link.

Authorizations

Section titled “Authorizations ”

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

The office_incident_action_id to delete.

Query Parameters

Section titled “Query Parameters ”
force
boolean

If true, deletes the link.

Responses

Section titled “ Responses ”
204
Section titled “204 ”

Deleted successfully

400
Section titled “400 ”

Preview of affected entities (returned when force=false)