Esc

↑↓ move↵ openIndex · Pagefind
REST reference · Project Management

Incidents

23 endpoints19 implementedAll modules →
  1. GET /rest/v1.0/projects/{project_id}/incidentsList Incidents
  2. POST /rest/v1.0/projects/{project_id}/incidentsCreate Incident
  3. GET /rest/v1.0/projects/{project_id}/incidents/{id}Show Incident
  4. PATCH /rest/v1.0/projects/{project_id}/incidents/{id}Update Incident
  5. DELETE /rest/v1.0/projects/{project_id}/incidents/{id}Delete Incident
  6. GET /rest/v1.0/projects/{project_id}/incidents/actionsList Actions
  7. POST /rest/v1.0/projects/{project_id}/incidents/actionsCreate Action
  8. GET /rest/v1.0/projects/{project_id}/incidents/actions/{id}Show Action
  9. PATCH /rest/v1.0/projects/{project_id}/incidents/actions/{id}Update Action
  10. DELETE /rest/v1.0/projects/{project_id}/incidents/actions/{id}Destroy Action
  11. GET /rest/v1.0/projects/{project_id}/incidents/filter_options/assigneesGet Assignee Filter Options
  12. GET /rest/v1.0/projects/{project_id}/incidents/filter_options/locationsGet Location Filter Options
  13. GET /rest/v1.0/projects/{project_id}/incidents/filter_options/statusesGet Status Filter Options
  14. GET /rest/v1.0/projects/{project_id}/incidents/injuriesList Injuries
  15. POST /rest/v1.0/projects/{project_id}/incidents/injuriesCreate Injury
  16. GET /rest/v1.0/projects/{project_id}/incidents/injuries/{id}Show Injury
  17. PATCH /rest/v1.0/projects/{project_id}/incidents/injuries/{id}Update Injury
  18. DELETE /rest/v1.0/projects/{project_id}/incidents/injuries/{id}Destroy Injury
  19. GET /rest/v1.0/projects/{project_id}/incidents/witness_statementsList Witness Statements
  20. POST /rest/v1.0/projects/{project_id}/incidents/witness_statementsCreate Witness Statement
  21. GET /rest/v1.0/projects/{project_id}/incidents/witness_statements/{id}Show Witness Statement
  22. PATCH /rest/v1.0/projects/{project_id}/incidents/witness_statements/{id}Update Witness Statement
  23. DELETE /rest/v1.0/projects/{project_id}/incidents/witness_statements/{id}Destroy Witness Statement
GET /rest/v1.0/projects/{project_id}/incidents

List Incidents

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • filters[id]
    integer[]query
  • filters[created_at]
    string (date)query
  • filters[updated_at]
    string (date)query
  • filters[event_date]
    string (date)query
  • filters[location_id]
    integer[]query
  • filters[status]
    string[]query
  • filters[contributing_behavior_id]
    integer[]query
  • filters[contributing_condition_id]
    integer[]query
  • filters[hazard_id]
    integer[]query
  • filters[time_unknown]
    booleanquery
  • filters[recordable]
    booleanquery
  • filters[with_record_types]
    string[]query
  • filters[has_root_cause_analysis]
    booleanquery
  • filters[custom_status_id]
    integer[]query
  • filters[type_id]
    integer[]query
  • filters[assignee_id]
    integer[]query
  • filters[query]
    stringquery
  • sort
    stringquery

Response · 200 · object[]

  • id
    integer
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • event_date
    string (date-time)
  • number
    integer
  • private
    boolean
  • recordable
    boolean
  • records_count
    integer
  • open_observations_count
    integer
  • closed_observations_count
    integer
  • actions_count
    integer
  • witness_statements_count
    integer
  • status
    string
  • time_unknown
    boolean
  • title
    string
  • updated_at
    string (date-time)
  • created_by
    object
  • contributing_behavior
    object
  • contributing_condition
    object
  • hazard
    object
  • location
    object
  • attachments_count
    integer
  • custom_fields
    object
POST /rest/v1.0/projects/{project_id}/incidents

Create Incident

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • run_configurable_validations
    booleanquery

Request body

  • incident
    objectrequired

Response · 201 · object

  • id
    integer
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • event_date
    string (date-time)
  • number
    integer
  • private
    boolean
  • recordable
    boolean
  • records_count
    integer
  • open_observations_count
    integer
  • closed_observations_count
    integer
  • actions_count
    integer
  • witness_statements_count
    integer
  • status
    string
  • time_unknown
    boolean
  • title
    string
  • updated_at
    string (date-time)
  • created_by
    object
  • contributing_behavior
    object
  • contributing_condition
    object
  • hazard
    object
  • location
    object
  • attachments_count
    integer
  • custom_fields
    object
  • attachments
    object[]
  • type
    object
  • custom_status
    object
  • assignees
    object[]
  • distribution_members
    object[]
  • environmentals
    object[]
  • injuries
    object[]
  • near_misses
    object[]
  • property_damages
    object[]
  • witness_statements
    object[]
  • actions
    object[]
GET /rest/v1.0/projects/{project_id}/incidents/{id}

Show Incident

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · object

  • id
    integer
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • event_date
    string (date-time)
  • number
    integer
  • private
    boolean
  • recordable
    boolean
  • records_count
    integer
  • open_observations_count
    integer
  • closed_observations_count
    integer
  • actions_count
    integer
  • witness_statements_count
    integer
  • status
    string
  • time_unknown
    boolean
  • title
    string
  • updated_at
    string (date-time)
  • created_by
    object
  • contributing_behavior
    object
  • contributing_condition
    object
  • hazard
    object
  • location
    object
  • attachments_count
    integer
  • custom_fields
    object
  • attachments
    object[]
  • type
    object
  • custom_status
    object
  • assignees
    object[]
  • distribution_members
    object[]
  • environmentals
    object[]
  • injuries
    object[]
  • near_misses
    object[]
  • property_damages
    object[]
  • witness_statements
    object[]
  • actions
    object[]
PATCH /rest/v1.0/projects/{project_id}/incidents/{id}

Update Incident

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired
  • run_configurable_validations
    booleanquery

Request body

  • incident
    objectrequired

Response · 200 · object

  • id
    integer
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • event_date
    string (date-time)
  • number
    integer
  • private
    boolean
  • recordable
    boolean
  • records_count
    integer
  • open_observations_count
    integer
  • closed_observations_count
    integer
  • actions_count
    integer
  • witness_statements_count
    integer
  • status
    string
  • time_unknown
    boolean
  • title
    string
  • updated_at
    string (date-time)
  • created_by
    object
  • contributing_behavior
    object
  • contributing_condition
    object
  • hazard
    object
  • location
    object
  • attachments_count
    integer
  • custom_fields
    object
  • attachments
    object[]
  • type
    object
  • custom_status
    object
  • assignees
    object[]
  • distribution_members
    object[]
  • environmentals
    object[]
  • injuries
    object[]
  • near_misses
    object[]
  • property_damages
    object[]
  • witness_statements
    object[]
  • actions
    object[]
DELETE /rest/v1.0/projects/{project_id}/incidents/{id}

Delete Incident

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired

Response · 204

No response body.

GET /rest/v1.0/projects/{project_id}/incidents/actions

List Actions

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • incident_id
    integerquery
  • page
    integerquery
  • per_page
    integerquery
  • filters[created_at]
    string (date)query
  • filters[updated_at]
    string (date)query
  • filters[query]
    stringquery
  • sort
    stringquery

Response · 200 · object[]

  • id
    integer
  • incident_id
    integer
  • action_type
    object
  • attachments
    object[]
  • description_plain_text
    string
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • updated_at
    string (date-time)
  • observation_id
    integer
  • custom_fields
    object
POST /rest/v1.0/projects/{project_id}/incidents/actions

Create Action

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • run_configurable_validations
    booleanquery

Request body

  • incident_action
    objectrequired

Response · 201 · object

  • id
    integer
  • incident_id
    integer
  • action_type
    object
  • attachments
    object[]
  • description_plain_text
    string
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • updated_at
    string (date-time)
  • observation_id
    integer
  • custom_fields
    object
GET /rest/v1.0/projects/{project_id}/incidents/actions/{id}

Show Action

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • incident_id
    integerquery
  • id
    integerpathrequired

Response · 200 · object

  • id
    integer
  • incident_id
    integer
  • action_type
    object
  • attachments
    object[]
  • description_plain_text
    string
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • updated_at
    string (date-time)
  • observation_id
    integer
  • custom_fields
    object
PATCH /rest/v1.0/projects/{project_id}/incidents/actions/{id}

Update Action

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • incident_id
    integerquery
  • id
    integerpathrequired
  • run_configurable_validations
    booleanquery

Request body

  • incident_action
    objectrequired

Response · 200 · object

  • id
    integer
  • incident_id
    integer
  • action_type
    object
  • attachments
    object[]
  • description_plain_text
    string
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • updated_at
    string (date-time)
  • observation_id
    integer
  • custom_fields
    object
DELETE /rest/v1.0/projects/{project_id}/incidents/actions/{id}

Destroy Action

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • incident_id
    integerquery
  • id
    integerpathrequired

Response · 204

No response body.

GET /rest/v1.0/projects/{project_id}/incidents/filter_options/assignees

Get Assignee Filter Options

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Response · 200 · object[]

  • key
    string
  • value
    string
GET /rest/v1.0/projects/{project_id}/incidents/filter_options/locations

Get Location Filter Options

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Response · 200 · object[]

  • key
    string
  • value
    string
GET /rest/v1.0/projects/{project_id}/incidents/filter_options/statuses

Get Status Filter Options

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Response · 200 · object[]

  • key
    string
  • value
    string
GET /rest/v1.0/projects/{project_id}/incidents/injuries

List Injuries

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • incident_id
    integerquery
  • page
    integerquery
  • per_page
    integerquery
  • filters[created_at]
    string (date)query
  • filters[affected_company_id]
    integer[]query
  • filters[affected_party_id]
    integer[]query
  • filters[affected_person_id]
    integer[]query
  • filters[harm_source_id]
    integer[]query
  • filters[work_activity_id]
    integer[]query
  • filters[managed_equipment_id]
    integerquery
  • filters[recordable]
    booleanquery
  • filters[affected_body_part]
    string[]query
  • filters[affliction_type_id]
    integerquery
  • filters[body_part_id]
    integer[]query
  • filters[filing_type]
    string[]query
  • filters[query]
    stringquery
  • sort
    stringquery

Response · 200 · object[]

  • type
    string
  • date_returned_to_work
    string (date)
  • affected_party
    object
  • affected_person
    object
  • harm_source
    object
  • date_of_death
    string (date)
  • filing_type
    string
  • hospitalized_overnight
    boolean
  • recordable
    boolean
  • treated_in_er
    boolean
  • treatment_facility_address
    string
  • treatment_facility
    string
  • treatment_provider
    string
  • work_days_absent
    integer
  • work_days_restricted
    integer
  • work_days_transferred
    integer
  • body_diagram_type
    string
  • affliction_type
    object
  • affected_body_part
    string
  • affected_body_parts
    string[]
  • afflictions
    object[]
  • custom_fields
    object
  • body_parts
    object[]
  • id
    integer
  • number
    integer
  • full_number
    string
  • incident_id
    integer
  • incident_title
    string
  • incident_private
    boolean
  • summary
    string
  • description_plain_text
    string
  • affected_company
    object
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • managed_equipment
    object
  • incident_created_by
    object
  • updated_at
    string (date-time)
  • work_activity
    object
POST /rest/v1.0/projects/{project_id}/incidents/injuries

Create Injury

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • run_configurable_validations
    booleanquery

Request body

  • injury
    objectrequired

Response · 201 · object

  • type
    string
  • date_returned_to_work
    string (date)
  • affected_party
    object
  • affected_person
    object
  • harm_source
    object
  • date_of_death
    string (date)
  • filing_type
    string
  • hospitalized_overnight
    boolean
  • recordable
    boolean
  • treated_in_er
    boolean
  • treatment_facility_address
    string
  • treatment_facility
    string
  • treatment_provider
    string
  • work_days_absent
    integer
  • work_days_restricted
    integer
  • work_days_transferred
    integer
  • body_diagram_type
    string
  • affliction_type
    object
  • affected_body_part
    string
  • affected_body_parts
    string[]
  • afflictions
    object[]
  • custom_fields
    object
  • body_parts
    object[]
  • id
    integer
  • number
    integer
  • full_number
    string
  • incident_id
    integer
  • incident_title
    string
  • incident_private
    boolean
  • summary
    string
  • description_plain_text
    string
  • affected_company
    object
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • managed_equipment
    object
  • incident_created_by
    object
  • updated_at
    string (date-time)
  • work_activity
    object
GET /rest/v1.0/projects/{project_id}/incidents/injuries/{id}

Show Injury

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • incident_id
    integerquery
  • id
    integerpathrequired

Response · 200 · object

  • type
    string
  • date_returned_to_work
    string (date)
  • affected_party
    object
  • affected_person
    object
  • harm_source
    object
  • date_of_death
    string (date)
  • filing_type
    string
  • hospitalized_overnight
    boolean
  • recordable
    boolean
  • treated_in_er
    boolean
  • treatment_facility_address
    string
  • treatment_facility
    string
  • treatment_provider
    string
  • work_days_absent
    integer
  • work_days_restricted
    integer
  • work_days_transferred
    integer
  • body_diagram_type
    string
  • affliction_type
    object
  • affected_body_part
    string
  • affected_body_parts
    string[]
  • afflictions
    object[]
  • custom_fields
    object
  • body_parts
    object[]
  • id
    integer
  • number
    integer
  • full_number
    string
  • incident_id
    integer
  • incident_title
    string
  • incident_private
    boolean
  • summary
    string
  • description_plain_text
    string
  • affected_company
    object
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • managed_equipment
    object
  • incident_created_by
    object
  • updated_at
    string (date-time)
  • work_activity
    object
PATCH /rest/v1.0/projects/{project_id}/incidents/injuries/{id}

Update Injury

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • incident_id
    integerquery
  • id
    integerpathrequired
  • run_configurable_validations
    booleanquery

Request body

  • injury
    objectrequired

Response · 200 · object

  • type
    string
  • date_returned_to_work
    string (date)
  • affected_party
    object
  • affected_person
    object
  • harm_source
    object
  • date_of_death
    string (date)
  • filing_type
    string
  • hospitalized_overnight
    boolean
  • recordable
    boolean
  • treated_in_er
    boolean
  • treatment_facility_address
    string
  • treatment_facility
    string
  • treatment_provider
    string
  • work_days_absent
    integer
  • work_days_restricted
    integer
  • work_days_transferred
    integer
  • body_diagram_type
    string
  • affliction_type
    object
  • affected_body_part
    string
  • affected_body_parts
    string[]
  • afflictions
    object[]
  • custom_fields
    object
  • body_parts
    object[]
  • id
    integer
  • number
    integer
  • full_number
    string
  • incident_id
    integer
  • incident_title
    string
  • incident_private
    boolean
  • summary
    string
  • description_plain_text
    string
  • affected_company
    object
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • managed_equipment
    object
  • incident_created_by
    object
  • updated_at
    string (date-time)
  • work_activity
    object
DELETE /rest/v1.0/projects/{project_id}/incidents/injuries/{id}

Destroy Injury

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • incident_id
    integerquery
  • id
    integerpathrequired

Response · 204

No response body.

GET /rest/v1.0/projects/{project_id}/incidents/witness_statements

List Witness Statements

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • incident_id
    integerquery
  • page
    integerquery
  • per_page
    integerquery
  • filters[created_at]
    string (date)query
  • filters[date_received]
    string (date)query
  • filters[witness_id]
    integer[]query
  • filters[query]
    stringquery
  • sort
    stringquery

Response · 200 · object[]

  • id
    integer
  • incident_id
    integer
  • attachments
    object[]
  • statement
    string
  • statement_plain_text
    string
  • date_received
    string (date)
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • updated_at
    string (date-time)
  • witness
    object
  • custom_fields
    object
  • recording
    object
POST /rest/v1.0/projects/{project_id}/incidents/witness_statements

Create Witness Statement

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Request body

  • witness_statement
    objectrequired

Response · 201 · object

  • id
    integer
  • incident_id
    integer
  • attachments
    object[]
  • statement
    string
  • statement_plain_text
    string
  • date_received
    string (date)
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • updated_at
    string (date-time)
  • witness
    object
  • custom_fields
    object
  • recording
    object
GET /rest/v1.0/projects/{project_id}/incidents/witness_statements/{id}

Show Witness Statement

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • incident_id
    integerquery
  • id
    integerpathrequired

Response · 200 · object

  • id
    integer
  • incident_id
    integer
  • attachments
    object[]
  • statement
    string
  • statement_plain_text
    string
  • date_received
    string (date)
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • updated_at
    string (date-time)
  • witness
    object
  • custom_fields
    object
  • recording
    object
PATCH /rest/v1.0/projects/{project_id}/incidents/witness_statements/{id}

Update Witness Statement

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • incident_id
    integerquery
  • id
    integerpathrequired

Request body

  • witness_statement
    objectrequired

Response · 200 · object

  • id
    integer
  • incident_id
    integer
  • attachments
    object[]
  • statement
    string
  • statement_plain_text
    string
  • date_received
    string (date)
  • created_at
    string (date-time)
  • deleted_at
    string (date-time)
  • updated_at
    string (date-time)
  • witness
    object
  • custom_fields
    object
  • recording
    object
DELETE /rest/v1.0/projects/{project_id}/incidents/witness_statements/{id}

Destroy Witness Statement

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • incident_id
    integerquery
  • id
    integerpathrequired

Response · 204

No response body.

Ask the OS

Reading this page

Ask anything about this page. Answers use what you're reading as context.

Suggested

    AI · may be imperfect · sample data where shown

    Open file