Tasks

Get Tasks

get

Returns a list of “Remedial Action“ tasks. Other types, such as “Create Assessment”, are not included.

Authorizations

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Query parameters

limitinteger · min: 1 · max: 1000OptionalDefault: 1000

pageintegerOptionalDefault: 1

taskstringOptional

Comma separated task IDs

Example: cle72jm2q0001pxwhqnf5qfoc

statusstringOptional

Comma separated status IDs
See GET /tasks/statuses

Default: notstarted,inprogress

propertystringOptional

Comma separated property IDs

Example: cksq4ybpq104zwgwh2gd1vvha

assetstringOptionalDeprecated

Use property instead

includeusersbooleanOptional

Include names and emails of assigned users

Default: false

includeteamsbooleanOptional

Include names of assigned teams

Default: false

includecategoriesbooleanOptional

Include names of categories

Default: false

includeseveritiesbooleanOptional

Include names of severities

Default: false

includetimescalesbooleanOptional

Include names of timescales

Default: false

Responses

200Success

application/json

totalintegerOptionalExample: 30341

get/tasks

GET /tasks HTTP/1.1
Host: api3.riskbase.uk
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "total": 30341,
  "tasks": [
    {
      "id": "cle72jm2q0001pxwhqnf5qfoc",
      "property": "cksq4ybpq104zwgwh2gd1vvha",
      "asset": "cksq4ybpq104zwgwh2gd1vvha",
      "element": "clo4al25g0004e4wh1j8v2adq",
      "reference": "RB-ABC123",
      "customReference": "MyTaskRef0001",
      "status": "inprogress",
      "what": "Description of task",
      "why": "Why the task is required",
      "location": "Location of task",
      "dueDate": "2024-01-01",
      "category": "ckuqwxk32011i11oooozx3vc2",
      "severity": "dkgcscowkkwcwsw0c40c4gcs",
      "timescale": "scc4o0wc80800gkwg0cc4sk8",
      "assignedTeams": [
        {
          "id": "cksq3a5ux03nx0ns0jntekwfm",
          "manual": true,
          "auto": false
        }
      ],
      "assignedUsers": [
        {
          "id": "cliylzuy600010nl44ox1hsqf",
          "manual": false,
          "auto": true
        }
      ],
      "photoIds": [
        "cksq3jhl500ga0ls0oiibt7q2",
        "cksq3j7tz006v0ls0bn0zeuq8"
      ]
    }
  ],
  "users": [
    {
      "id": "text",
      "email": "[e-mail]",
      "name": "text"
    }
  ],
  "teams": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "categories": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "severities": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "timescales": [
    {
      "id": "text",
      "name": "text"
    }
  ]
}

Deprecated

Update Task Status

post

See PATCH: Update Task Status

Authorizations

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

post/tasks/{task}/status

POST /tasks/{task}/status HTTP/1.1
Host: api3.riskbase.uk
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Update Task Status

patch

Update a task's status

• Triggers the task webhook.

Authorizations

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Path parameters

taskstring · UIDRequired

Body

statusstringRequired

See GET /tasks/statuses

Example: completed

userstring · nullableOptional

Email or ID of the user who performed the change. If not provided or not recognised the update will be applied but the API user will be used instead

Example: [e-mail]

commentstring · nullableOptionalExample: Combustibles have been removed

skipWebhookbooleanOptionalDefault: false

Responses

204Success

400Error

application/json

patch/tasks/{task}/status

PATCH /tasks/{task}/status HTTP/1.1
Host: api3.riskbase.uk
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 116

{
  "status": "completed",
  "user": "[e-mail]",
  "comment": "Combustibles have been removed",
  "skipWebhook": false
}

Get Task Statuses

get

Authorizations

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Responses

200Success

application/json

get/tasks/statuses

GET /tasks/statuses HTTP/1.1
Host: api3.riskbase.uk
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "statuses": [
    {
      "id": "notstarted",
      "name": "Not Started",
      "isIncomplete": true
    },
    {
      "id": "inprogress",
      "name": "In Progress",
      "isIncomplete": true
    },
    {
      "id": "completed",
      "name": "Completed",
      "isIncomplete": false
    },
    {
      "id": "cancelled",
      "name": "Cancelled",
      "isIncomplete": false
    }
  ]
}