RiskDemand

Manage risk demands, which represent the association between risks and demands for compliance or mitigation.
You can create, update, delete, and search for risk demands with advanced filtering and pagination.

Version

2.0.0

OpenAPI version

3.0.0

Operations

index

POST

/v2/risk-demand/index

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

Request Body

Parameters for searching risk demands

object

filter

object

risk_demand_id

The unique identifier of the risk demand.

string

risk_id

The unique identifier of the associated risk.

string

demand_id

The unique identifier of the associated demand.

string

office_id

The unique identifier of the associated office.

string

project_id

The unique identifier of the associated project.

string

data

Additional data related to the risk demand in JSON format.

object

probability

The probability of the risk occurring.

integer

damage

The potential damage caused by the risk.

integer

risk_code

The code associated with the risk, if available.

string

nullable

risk_name

The name of the associated risk.

string

action_id

The unique identifier of the associated action.

string

action_code

The code associated with the action, if available.

string

nullable

action_name

The name of the associated action.

string

action_type

The type of action associated with the risk demand.

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": {
    "risk_id": "risk-1",
    "demand_id": "dem-1"
  },
  "per-page": 10,
  "page": 1,
  "sort": "risk_id"
}

Responses

200

List of risk demands

Array<object>

object

risk_demand_id

The unique identifier of the risk demand.

string

risk_id

The unique identifier of the associated risk.

string

demand_id

The unique identifier of the associated demand.

string

office_id

The unique identifier of the associated office.

string

project_id

The unique identifier of the associated project.

string

data

Additional data related to the risk demand in JSON format.

object

probability

The probability of the risk occurring.

integer

damage

The potential damage caused by the risk.

integer

risk_code

The code associated with the risk, if available.

string

nullable

risk_name

The name of the associated risk.

string

action_id

The unique identifier of the associated action.

string

action_code

The code associated with the action, if available.

string

nullable

action_name

The name of the associated action.

string

action_type

The type of action associated with the risk demand.

string

Example

{
  "risk_demand_id": "rd-1",
  "risk_id": "risk-1",
  "demand_id": "dem-1",
  "probability": 3,
  "damage": 4,
  "office_id": "off-1",
  "project_id": "proj-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/risk-demand/create

Create a new risk demand by providing the required details.

Request Body ^required

Risk demand object to be created

object

risk_demand_id

The unique identifier of the risk demand.

string

risk_id

The unique identifier of the associated risk.

string

demand_id

The unique identifier of the associated demand.

string

data

Additional data related to the risk demand in JSON format.

object

probability

The probability of the risk occurring, if available.

integer

nullable

damage

The potential damage caused by the risk, if available.

integer

nullable

Example

{
  "risk_id": "risk-2",
  "demand_id": "dem-2",
  "probability": 2,
  "damage": 5
}

Responses

201

Risk demand created successfully

object

risk_demand_id

The unique identifier of the risk demand.

string

risk_id

The unique identifier of the associated risk.

string

demand_id

The unique identifier of the associated demand.

string

data

Additional data related to the risk demand in JSON format.

object

probability

The probability of the risk occurring, if available.

integer

nullable

damage

The potential damage caused by the risk, if available.

integer

nullable

Example

{
  "risk_demand_id": "rd-2",
  "risk_id": "risk-2",
  "demand_id": "dem-2",
  "probability": 2,
  "damage": 5
}

view

GET

/v2/risk-demand/view/{id}

Retrieve a risk demand by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the risk demand to retrieve

Responses

200

Risk demand found

object

risk_demand_id

The unique identifier of the risk demand.

string

risk_id

The unique identifier of the associated risk.

string

demand_id

The unique identifier of the associated demand.

string

office_id

The unique identifier of the associated office.

string

project_id

The unique identifier of the associated project.

string

data

Additional data related to the risk demand in JSON format.

object

probability

The probability of the risk occurring.

integer

damage

The potential damage caused by the risk.

integer

risk_code

The code associated with the risk, if available.

string

nullable

risk_name

The name of the associated risk.

string

action_id

The unique identifier of the associated action.

string

action_code

The code associated with the action, if available.

string

nullable

action_name

The name of the associated action.

string

action_type

The type of action associated with the risk demand.

string

Example

{
  "risk_demand_id": "rd-1",
  "risk_id": "risk-1",
  "demand_id": "dem-1",
  "probability": 3,
  "damage": 4,
  "office_id": "off-1",
  "project_id": "proj-1"
}

404

Risk demand not found

delete

DELETE

/v2/risk-demand/delete/{id}

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

Path Parameters

id

required

string format: uuid

ID of the risk demand to delete

Query Parameters

force

boolean

Force the deletion of the entity and all related entities

Responses

204

Risk demand 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/risk-demand/update/{id}

Update an existing risk demand by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the risk demand to update

Request Body ^required

Risk demand object with updated data

object

risk_demand_id

The unique identifier of the risk demand.

string

risk_id

The unique identifier of the associated risk.

string

demand_id

The unique identifier of the associated demand.

string

data

Additional data related to the risk demand in JSON format.

object

probability

The probability of the risk occurring, if available.

integer

nullable

damage

The potential damage caused by the risk, if available.

integer

nullable

Example

{
  "probability": 5,
  "damage": 2
}

Responses

200

Risk demand updated successfully

object

risk_demand_id

The unique identifier of the risk demand.

string

risk_id

The unique identifier of the associated risk.

string

demand_id

The unique identifier of the associated demand.

string

data

Additional data related to the risk demand in JSON format.

object

probability

The probability of the risk occurring, if available.

integer

nullable

damage

The potential damage caused by the risk, if available.

integer

nullable

Example

{
  "risk_demand_id": "rd-1",
  "probability": 5,
  "damage": 2
}

404

Risk demand not found