Assets

Deprecated

Get Asset Groups

get

Authorizations

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Query parameters

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

pageintegerOptionalDefault: 1

Responses

200Success

application/json

totalintegerOptionalExample: 50

get/assets/groups

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

200Success

{
  "total": 50,
  "assetGroups": [
    {
      "id": "cksq39rnv02vf0ns0t3o834uv",
      "name": "London South",
      "reference": "RB-Z0LMKJ",
      "customReference": null
    }
  ]
}

Deprecated

Get Assets

get

Authorizations

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Query parameters

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

pageintegerOptionalDefault: 1

assetstringOptional

Comma separated asset IDs

Example: cksq4ybpq104zwgwh2gd1vvha

customreferencestringOptional

Comma separated asset custom references

Example: CustomReference1,CustomReference2

Responses

200Success

application/json

totalintegerOptionalExample: 9250

get/assets

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

200Success

{
  "total": 9250,
  "assets": [
    {
      "id": "cksq4ybpq104zwgwh2gd1vvha",
      "name": "Demo Asset",
      "reference": "RB-ABC123",
      "customReference": "YourUprn0001",
      "photoId": "cksq3jhl500ga0ls0oiibt7q2,",
      "address": {
        "line1": "33 Magnolia Avenue",
        "line2": "",
        "city": "London",
        "county": "",
        "postcode": "SW10 2BT"
      }
    }
  ]
}

Deprecated

Create Asset

post

Triggers the asset webhook.

Authorizations

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Body

namestringRequired

parentAssetstring · UID · nullableOptional

Parent asset or asset group ID. If null is provided, the asset will be created in an asset group called "Created by API"

customReferencestringOptional

skipWebhookbooleanOptionalDefault: false

Responses

200Success

application/json

idstring · UIDOptionalExample: yok0w80s0sckwwgo0c8sko4o

400Error

application/json

post/assets

POST /assets HTTP/1.1
Host: api3.riskbase.uk
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 163

{
  "parentAsset": "u400ko8sk848gc40kss400sg",
  "name": "Building 1",
  "customReference": "B000001",
  "address": {
    "line1": "101 Wood Lane",
    "city": "London",
    "postcode": "W12 7FA"
  }
}

{
  "id": "yok0w80s0sckwwgo0c8sko4o"
}

Deprecated

Get Asset Tree

get

Authorizations

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Responses

200Success

application/json

get/assets/tree

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

200Success

{
  "tree": {
    "tree": [
      {
        "id": "cl8br0oe40001kkwhdglcu74r",
        "name": "Fox Residential",
        "type": "Organisation",
        "children": [
          {
            "id": "cl8br1p900001mgwhcpbhopcp",
            "name": "Manchester",
            "type": "Asset Group",
            "children": [
              {
                "id": "cl8br4pnc0001opwhfidszqwt",
                "name": "Blonde Retreat",
                "type": "Asset",
                "children": []
              },
              {
                "id": "cl8br4pph0003opwhouu2j0ew",
                "name": "The Blade Building",
                "type": "Asset",
                "children": []
              }
            ]
          }
        ]
      }
    ]
  }
}

Deprecated

Update Asset

patch

Update an asset's name and address.

Triggers the asset webhook.

Authorizations

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Path parameters

assetIdstring · UIDRequired

Body

namestringOptional

customReferencestringOptional

skipWebhookbooleanOptionalDefault: false

Responses

204Success

400Error

application/json

patch/assets/{assetId}

PATCH /assets/{assetId} HTTP/1.1
Host: api3.riskbase.uk
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 163

{
  "parentAsset": "u400ko8sk848gc40kss400sg",
  "name": "Building 1",
  "customReference": "B000001",
  "address": {
    "line1": "101 Wood Lane",
    "city": "London",
    "postcode": "W12 7FA"
  }
}

Deprecated

Move Asset

patch

Move an asset to a different position in the asset tree; either below an asset group or another asset.

Triggers the asset webhook.

Authorizations

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Path parameters

assetIdstring · UIDRequired

Body

parentAssetstring · UIDRequired

skipWebhookbooleanOptionalDefault: false

Responses

204Success

400Error

application/json

patch/assets/{assetId}/parent

PATCH /assets/{assetId}/parent HTTP/1.1
Host: api3.riskbase.uk
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "parentAsset": "u400ko8sk848gc40kss400sg"
}

Deprecated

Get Asset Team Users

get

Get a list of users responsible for teams for all assets in your organisation.

Responsible users are auto-assigned to tasks that are assigned to their team.
Users are automatically given access to assets they are responsible for.

Authorizations

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Query parameters

assetstring · UIDOptional

Comma separated asset IDs

Example: cksq4ybpq104zwgwh2gd1vvha

userstring · UIDOptional

Comma separated user IDs

Example: cksq4xkxh012173wh9agrq0iz

includeinheritedbooleanOptional

Responsibility is inherited down the asset tree. By default this endpoint will list responsbility which has been set explicitly. Set this to true to include inherited responsibility.

Default: falseExample: true

Responses

200Success

application/json

get/assets/teamusers

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

200Success

{
  "assets": {
    "cksq4ofmx07arhowhtzzdqwxa": {
      "cksq5ee6p07fxedwh1pfowuxc": [
        "cksq4xga4078iwgwhn6dwvm2q"
      ],
      "cksq5ee5j0776edwhh347ruab": [
        "cksq4y6f700iswjwhhwdsb9mo",
        "cksq4xga4078iwgwhn6dwvm2q",
        "cksq5ev5f00ylw9whbmkwku7z"
      ]
    },
    "cksq4p0aa070mhowhbw5gomri": {
      "cksq5ee6p07fxedwh1pfowuxc": [
        "cksq4xga4078iwgwhn6dwvm2q"
      ]
    }
  }
}

Deprecated

Add Asset Team Users

patch

Set which users are responsible for teams at this asset.

Users are added as members of the team if they aren't already. Triggers the team webhook if users are added to the team.
Invalid user IDs are silently ignored.

Authorizations

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Path parameters

assetIdstring · UIDRequired

Body

teamstring · UIDRequired

usersstring · UID[]Required

skipWebhookbooleanOptionalDefault: false

Responses

204Success

400Error

application/json

patch/assets/{assetId}/teamusers/add

PATCH /assets/{assetId}/teamusers/add HTTP/1.1
Host: api3.riskbase.uk
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "team": "cksq5ee6607bwedwhkb6ra827",
  "users": [
    "cksq50h7g0638hywhasfzw7cd"
  ]
}

Deprecated

Remove Asset Team Users

patch

Remove users as responsible for teams at this asset.

Users are unassigned from any tasks they were auto-assigned to.
Invalid user IDs are silently ignored.
Users are not removed as members of the team.

Authorizations

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Path parameters

assetIdstring · UIDRequired

Body

teamstring · UIDRequired

usersstring · UID[]Required

Responses

204Success

400Error

application/json

patch/assets/{assetId}/teamusers/remove

PATCH /assets/{assetId}/teamusers/remove HTTP/1.1
Host: api3.riskbase.uk
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "team": "cksq5ee6607bwedwhkb6ra827",
  "users": [
    "cksq50h7g0638hywhasfzw7cd"
  ]
}

PreviousFiles NextElements

Last updated 1 month ago

Was this helpful?