Risk Registers

The risk registers resource.

Basehttps://rest.carbon.ms/riskRegisters

GET/riskRegisters

List risk registerss

Retrieve a paginated list of risk registerss. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/riskRegisters

curl --request GET \
  --url 'https://rest.carbon.ms/riskRegisters?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "workCenterId": "xyz789",
    "companyId": "xyz789",
    "title": "string",
    "description": "string",
    "source": "string",
    "sourceId": "xyz789",
    "severity": 0
  }
]

GET/riskRegisters

Retrieve a risk registers

Fetch a single risk registers by filtering on `id`.

Query parameters

idstring

Match on the risk registers's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/riskRegisters

curl --request GET \
  --url 'https://rest.carbon.ms/riskRegisters?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "workCenterId": "xyz789",
  "companyId": "xyz789",
  "title": "string",
  "description": "string",
  "source": "string",
  "sourceId": "xyz789",
  "severity": 0
}