Skip to content
4HSE

Risk

Manage risks, which represent hazards or potential issues in projects, work groups, or offices.
You can create, update, delete, and search for risks with advanced filtering and pagination.

Version
2.0.0
OpenAPI version
3.0.0

Operations

Section titled “Operations”

index

Section titled “index”
POST
/v2/risk/index

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

Request Body

Section titled “Request Body ”

Parameters for searching risks

object
filter
object
risk_id
string
name
string
code
string
work_group_id
string
work_group_code
string
work_group_name
string
office_name
string
present
integer
project_id
string
office_id
string
project_name
string
project_type
string
{
  "name": "Risk 1",
  "status": "open"
}
per-page
integer
default: 10 >= 1
page
integer
default: 1 >= 1
sort
string
Allowed values: code name work_group_code work_group_name residual
history
boolean
Example
{
  "filter": {
    "name": "Risk 1",
    "work_group_id": "wg-1"
  },
  "per-page": 10,
  "page": 1,
  "sort": "name"
}

Responses

Section titled “ Responses ”
200
Section titled “200 ”

List of risks

Array<object>
object
risk_id
string
name
string
code
string
description
string
probability
integer
damage
integer
work_group_id
string
work_group_code
string
work_group_name
string
office_name
string
present
integer
initial
integer
ridution
integer
residual
integer
project_id
string
office_id
string
project_name
string
project_type
string
owned_active
boolean
parent_active
boolean
Example
{
  "risk_id": "risk-1",
  "name": "Risk 1",
  "code": "R001",
  "description": "Risk of falling",
  "probability": 3,
  "damage": 4,
  "work_group_id": "wg-1",
  "work_group_code": "WG001",
  "work_group_name": "Work Group 1",
  "office_name": "Main Office",
  "present": 1,
  "initial": 2,
  "ridution": 1,
  "residual": 1,
  "project_id": "proj-1",
  "office_id": "off-1",
  "project_name": "Project X",
  "project_type": "safety",
  "owned_active": true,
  "parent_active": true
}

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/risk/create

Create a new risk by providing the required details.

Request Body required

Section titled “Request Body required ”

Risk object to be created

object
risk_id
string
name
required
string
code
string
description
string
probability
integer
damage
integer
work_group_id
required
string
Example
{
  "name": "Risk 2",
  "code": "R002",
  "description": "Risk of fire",
  "probability": 2,
  "damage": 5,
  "work_group_id": "wg-2"
}

Responses

Section titled “ Responses ”
201
Section titled “201 ”

Risk created successfully

object
risk_id
string
name
required
string
code
string
description
string
probability
integer
damage
integer
work_group_id
required
string
Example
{
  "risk_id": "risk-2",
  "name": "Risk 2",
  "code": "R002",
  "description": "Risk of fire",
  "probability": 2,
  "damage": 5,
  "work_group_id": "wg-2"
}

view

Section titled “view”
GET
/v2/risk/view/{id}

Retrieve a risk by its unique ID.

Path Parameters

Section titled “Path Parameters ”
id
required
integer format: int64

ID of the risk to retrieve

Responses

Section titled “ Responses ”
200
Section titled “200 ”

Risk found

object
risk_id
string
name
string
code
string
description
string
probability
integer
damage
integer
work_group_id
string
work_group_code
string
work_group_name
string
office_name
string
present
integer
initial
integer
ridution
integer
residual
integer
project_id
string
office_id
string
project_name
string
project_type
string
owned_active
boolean
parent_active
boolean
Example
{
  "risk_id": "risk-1",
  "name": "Risk 1",
  "code": "R001",
  "description": "Risk of falling",
  "probability": 3,
  "damage": 4,
  "work_group_id": "wg-1",
  "work_group_code": "WG001",
  "work_group_name": "Work Group 1",
  "office_name": "Main Office",
  "present": 1,
  "initial": 2,
  "ridution": 1,
  "residual": 1,
  "project_id": "proj-1",
  "office_id": "off-1",
  "project_name": "Project X",
  "project_type": "safety",
  "owned_active": true,
  "parent_active": true
}
404
Section titled “404 ”

Risk not found

update

Section titled “update”
PUT
/v2/risk/update/{id}

Update an existing risk by its unique ID.

Path Parameters

Section titled “Path Parameters ”
id
required
integer format: int64

ID of the risk to update

Request Body required

Section titled “Request Body required ”

Risk object with updated data

object
risk_id
string
name
required
string
code
string
description
string
probability
integer
damage
integer
work_group_id
required
string
Example
{
  "name": "Updated Risk",
  "probability": 4
}

Responses

Section titled “ Responses ”
200
Section titled “200 ”

Risk updated successfully

object
risk_id
string
name
required
string
code
string
description
string
probability
integer
damage
integer
work_group_id
required
string
Example
{
  "risk_id": "risk-1",
  "name": "Updated Risk",
  "probability": 4
}
404
Section titled “404 ”

Risk not found

delete

Section titled “delete”
DELETE
/v2/risk/delete/{id}

Delete a risk by its unique ID.
If force=true, all related entities will also be deleted.

Path Parameters

Section titled “Path Parameters ”
id
required
integer format: int64

ID of the risk to delete

Query Parameters

Section titled “Query Parameters ”
force
boolean

Force the deletion of the entity and all related entities

Responses

Section titled “ Responses ”
204
Section titled “204 ”

Risk deleted successfully

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