Incident

Manage incidents, including reporting, updating, deleting, and advanced search.
Incidents can be linked to offices, projects, and categories, and support metadata and filtering.

Version

2.0.0

OpenAPI version

3.0.0

Operations

index

POST

/v2/incident/index

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

Request Body

Parameters for searching incidents

object

filter

object

office_incident_id

string format: uuid

code

string

name

string

date_incident

string format: date

category

string

description_event

string

description_actions_involved

string

deponent

string

manager

string format: json

assignee

string format: json

watcher

string format: json

to

string format: json

status

string

Allowed values: open closed new

creator

string

created_at

string

tenant_id

string format: uuid

subtenant_id

string format: uuid

office_name

string

project_name

string

project_type

string

totSicknessDays

integer

totInvolvedPerson

integer

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": {
    "name": "Incident 1",
    "category": "Injury"
  },
  "per-page": 10,
  "page": 1,
  "sort": "name"
}

Responses

200

List of incidents

Array<object>

object

office_incident_id

string format: uuid

code

string

name

string

date_incident

string format: date

category

string

description_event

string

description_actions_involved

string

deponent

string

manager

string format: json

assignee

string format: json

watcher

string format: json

to

string format: json

status

string

Allowed values: open closed new

creator

string

created_at

string

tenant_id

string format: uuid

subtenant_id

string format: uuid

office_name

string

project_name

string

project_type

string

totSicknessDays

integer

totInvolvedPerson

integer

Example

{
  "office_incident_id": "inc-1",
  "code": "INC-001",
  "name": "Incident 1",
  "date_incident": "2024-01-01",
  "category": "Injury",
  "description_event": "Minor injury occurred",
  "status": "open",
  "tenant_id": "ten-1",
  "subtenant_id": "sub-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/create

Create a new incident by providing the required details.

Request Body ^required

Incident object to be created

object

office_incident_id

string

code

string

name

string

date_incident

string format: date

category

string

description_event

string

description_actions_involved

string

deponent

string

manager

string format: json

assignee

string format: json

watcher

string format: json

to

string format: json

status

string

Allowed values: new open closed

creator

string

created_at

string

tenant_id

string

subtenant_id

string

Example

{
  "code": "INC-002",
  "name": "Incident 2",
  "date_incident": "2024-02-01",
  "category": "Fire",
  "description_event": "Small fire in warehouse",
  "status": "new",
  "tenant_id": "ten-1",
  "subtenant_id": "sub-1"
}

Responses

201

Incident created successfully

object

office_incident_id

string

code

string

name

string

date_incident

string format: date

category

string

description_event

string

description_actions_involved

string

deponent

string

manager

string format: json

assignee

string format: json

watcher

string format: json

to

string format: json

status

string

Allowed values: new open closed

creator

string

created_at

string

tenant_id

string

subtenant_id

string

Example

{
  "office_incident_id": "inc-2",
  "code": "INC-002",
  "name": "Incident 2",
  "date_incident": "2024-02-01",
  "category": "Fire",
  "description_event": "Small fire in warehouse",
  "status": "new",
  "tenant_id": "ten-1",
  "subtenant_id": "sub-1"
}

view

GET

/v2/incident/view/{id}

Retrieve an incident by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the incident to retrieve

Responses

200

Incident found

object

office_incident_id

string format: uuid

code

string

name

string

date_incident

string format: date

category

string

description_event

string

description_actions_involved

string

deponent

string

manager

string format: json

assignee

string format: json

watcher

string format: json

to

string format: json

status

string

Allowed values: open closed new

creator

string

created_at

string

tenant_id

string format: uuid

subtenant_id

string format: uuid

office_name

string

project_name

string

project_type

string

totSicknessDays

integer

totInvolvedPerson

integer

Example

{
  "office_incident_id": "inc-1",
  "code": "INC-001",
  "name": "Incident 1",
  "date_incident": "2024-01-01",
  "category": "Injury",
  "description_event": "Minor injury occurred",
  "status": "open",
  "tenant_id": "ten-1",
  "subtenant_id": "sub-1"
}

404

Incident not found

delete

DELETE

/v2/incident/delete/{id}

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

Query Parameters

force

boolean

Force the deletion of the entity and all related entities

Responses

204

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

Update an existing incident by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the incident to update

Request Body ^required

Incident object with updated data

object

office_incident_id

string

code

string

name

string

date_incident

string format: date

category

string

description_event

string

description_actions_involved

string

deponent

string

manager

string format: json

assignee

string format: json

watcher

string format: json

to

string format: json

status

string

Allowed values: new open closed

creator

string

created_at

string

tenant_id

string

subtenant_id

string

Example

{
  "name": "Updated Incident",
  "category": "Near Miss"
}

Responses

200

Incident updated successfully

object

office_incident_id

string

code

string

name

string

date_incident

string format: date

category

string

description_event

string

description_actions_involved

string

deponent

string

manager

string format: json

assignee

string format: json

watcher

string format: json

to

string format: json

status

string

Allowed values: new open closed

creator

string

created_at

string

tenant_id

string

subtenant_id

string

Example

{
  "office_incident_id": "inc-1",
  "name": "Updated Incident",
  "category": "Near Miss"
}

404

Incident not found