IncidentPerson

Manage incident persons, which represent people involved in incidents.
You can create, update, delete, and search for incident persons with advanced filtering and pagination.

Version

2.0.0

OpenAPI version

3.0.0

Operations

index

POST

/v2/incident-person/index

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

Request Body

Parameters for searching incident persons

object

filter

object

office_incident_person_id

Primary key for office incident person

string format: uuid

office_incident_id

ID of the related office incident

string format: uuid

person_office_id

ID of the person involved in the office incident

string format: uuid

code

string

nullable

description

string

nullable

days

integer

nullable

tenant_id

ID of the tenant

string format: uuid

subtenant_id

ID of the subtenant

string format: uuid

person_id

ID of the person involved

string

person_code

string

nullable

person_first_name

string

person_last_name

string

person_is_employee

boolean

incident_code

string

nullable

incident_name

string

incident_date

string format: date

incident_category

string

nullable

incident_description_event

string

nullable

incident_description_actions_involved

string

nullable

incident_deponent

string

nullable

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": {
    "office_incident_id": "inc-1"
  },
  "per-page": 10,
  "page": 1,
  "sort": "office_incident_person_id"
}

Responses

200

List of incident persons

Array<object>

object

office_incident_person_id

Primary key for office incident person

string format: uuid

office_incident_id

ID of the related office incident

string format: uuid

person_office_id

ID of the person involved in the office incident

string format: uuid

code

string

nullable

description

string

nullable

days

integer

nullable

tenant_id

ID of the tenant

string format: uuid

subtenant_id

ID of the subtenant

string format: uuid

person_id

ID of the person involved

string

person_code

string

nullable

person_first_name

string

person_last_name

string

person_is_employee

boolean

incident_code

string

nullable

incident_name

string

incident_date

string format: date

incident_category

string

nullable

incident_description_event

string

nullable

incident_description_actions_involved

string

nullable

incident_deponent

string

nullable

incident_status

string

Allowed values: open closed

project_name

string

project_type

string

office_name

string

Example

{
  "office_incident_person_id": "ip-1",
  "office_incident_id": "inc-1",
  "person_office_id": "po-1",
  "code": "P001",
  "description": "Injured person",
  "days": 2,
  "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-person/create

Create a new incident person by providing the required details.

Request Body ^required

Incident person object to be created

object

office_incident_person_id

Primary key for office incident person

string

office_incident_id

ID of the related office incident

string

person_office_id

ID of the person involved in the office incident

string

code

string

nullable

description

string

nullable

days

integer

nullable

tenant_id

ID of the tenant

string

subtenant_id

ID of the subtenant

string

Example

{
  "office_incident_id": "inc-1",
  "person_office_id": "po-1",
  "code": "P002",
  "description": "Witness",
  "days": 0,
  "tenant_id": "ten-1",
  "subtenant_id": "sub-1"
}

Responses

201

Incident person created successfully

object

office_incident_person_id

Primary key for office incident person

string

office_incident_id

ID of the related office incident

string

person_office_id

ID of the person involved in the office incident

string

code

string

nullable

description

string

nullable

days

integer

nullable

tenant_id

ID of the tenant

string

subtenant_id

ID of the subtenant

string

Example

{
  "office_incident_person_id": "ip-2",
  "office_incident_id": "inc-1",
  "person_office_id": "po-1",
  "code": "P002",
  "description": "Witness",
  "days": 0,
  "tenant_id": "ten-1",
  "subtenant_id": "sub-1"
}

view

GET

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

Retrieve an incident person by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the incident person to retrieve

Responses

200

Incident person found

object

office_incident_person_id

Primary key for office incident person

string format: uuid

office_incident_id

ID of the related office incident

string format: uuid

person_office_id

ID of the person involved in the office incident

string format: uuid

code

string

nullable

description

string

nullable

days

integer

nullable

tenant_id

ID of the tenant

string format: uuid

subtenant_id

ID of the subtenant

string format: uuid

person_id

ID of the person involved

string

person_code

string

nullable

person_first_name

string

person_last_name

string

person_is_employee

boolean

incident_code

string

nullable

incident_name

string

incident_date

string format: date

incident_category

string

nullable

incident_description_event

string

nullable

incident_description_actions_involved

string

nullable

incident_deponent

string

nullable

incident_status

string

Allowed values: open closed

project_name

string

project_type

string

office_name

string

Example

{
  "office_incident_person_id": "ip-1",
  "office_incident_id": "inc-1",
  "person_office_id": "po-1",
  "code": "P001",
  "description": "Injured person",
  "days": 2,
  "tenant_id": "ten-1",
  "subtenant_id": "sub-1"
}

404

Incident person not found

delete

DELETE

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

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

Query Parameters

force

boolean

Force the deletion of the entity and all related entities

Responses

204

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

Update an existing incident person by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the incident person to update

Request Body ^required

Incident person object with updated data

object

office_incident_person_id

Primary key for office incident person

string

office_incident_id

ID of the related office incident

string

person_office_id

ID of the person involved in the office incident

string

code

string

nullable

description

string

nullable

days

integer

nullable

tenant_id

ID of the tenant

string

subtenant_id

ID of the subtenant

string

Example

{
  "description": "Updated description",
  "days": 3
}

Responses

200

Incident person updated successfully

object

office_incident_person_id

Primary key for office incident person

string

office_incident_id

ID of the related office incident

string

person_office_id

ID of the person involved in the office incident

string

code

string

nullable

description

string

nullable

days

integer

nullable

tenant_id

ID of the tenant

string

subtenant_id

ID of the subtenant

string

Example

{
  "office_incident_person_id": "ip-1",
  "description": "Updated description",
  "days": 3
}

404

Incident person not found