Elements

Deprecated

Get Elements

get

Authorizations

Bearer Authentication

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Query parameters

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

pageintegerOptionalDefault: 1

typestring · Comma-Separated: ID or nameOptional

Limit list by property asset type. See GET /properties/assets/types

Example: Flat Entrance Door,firedoors,cksq3o1qn00j20hs0ayi7qagu

idstring · Comma-Separated: IDOptional

Limit list by elements

Example: cksq3o1qn00j10hs07j31i9l1

Responses

200Success

application/json

totalintegerOptionalExample: 1288

get/elements

HTTPcURLJavaScriptPython

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

200Success

{
  "elements": [
    {
      "id": "cksq3o1qn00j20hs0ayi7qagu",
      "property": "cksq39rno02kj0ns0qcqi1sz1",
      "asset": "cksq39rno02kj0ns0qcqi1sz1",
      "type": "cksq3ocb600mu0hs0qhachlip",
      "fields": [
        {
          "id": "cksq3ocb600mu0hs0qhachlip",
          "identifier": "flatNumber",
          "type": "text",
          "result": {
            "value": "Flat 1A"
          }
        },
        {
          "id": "eowcg4w4w84sk4o4w440k8k0",
          "identifier": null,
          "type": "string",
          "result": {
            "ids": [
              "x480ws4sks0kskc0wssogkg4",
              "uwcwsoo00g0swosg4w00oc4g",
              "d8kswcsk8k08c4g8k4cc8044"
            ]
          },
          "contentMediaType": "application/octet-stream"
        },
        {
          "id": "i0sg4o4c0sgkkogsg4wsgwco",
          "identifier": null,
          "type": "image",
          "result": {
            "ids": [
              "e80wo0k4oks0gs4ks404s4k4"
            ]
          }
        },
        {
          "id": "cksq3oc5y004i0hs0ff0cbyk3",
          "identifier": "occupancyType",
          "type": "option",
          "result": {
            "ids": [
              "cloirzzkg00058usq5r0kbhbw",
              "cloirzzkp00068usqc2as5d93"
            ],
            "values": [
              "Residential",
              "Business"
            ]
          }
        },
        {
          "id": "cksq3ocb800n00hs0249bbds3",
          "identifier": "pin",
          "type": "pin",
          "result": {
            "planId": "vs8wco44wosgssscww4o880c",
            "percentageFromLeft": "87.666666666666",
            "percentageFromTop": "17.777777777778"
          }
        }
      ]
    }
  ],
  "types": [
    {
      "id": "cksq3o1qn00j20hs0ayi7qagu",
      "name": "Flat Entrance Doors",
      "nameSingular": "Flat Entrance Door",
      "fields": [
        {
          "id": "cksq3ocb600mu0hs0qhachlip",
          "identifier": "flatNumber",
          "name": "Flat Number",
          "type": "text",
          "config": {}
        },
        {
          "id": "eowcg4w4w84sk4o4w440k8k0",
          "identifier": null,
          "name": "File Attachments",
          "type": "string",
          "config": {
            "multi": true
          },
          "contentMediaType": "application/octet-stream"
        },
        {
          "id": "i0sg4o4c0sgkkogsg4wsgwco",
          "identifier": null,
          "name": "Main Image",
          "type": "image",
          "config": {
            "multi": false
          }
        },
        {
          "id": "cksq3oc5y004i0hs0ff0cbyk3",
          "identifier": "occupancyType",
          "name": "Type of Occupant",
          "type": "option",
          "config": {
            "multi": true,
            "options": [
              {
                "id": "cloirzzkg00058usq5r0kbhbw",
                "value": "Residential"
              },
              {
                "id": "cloirzzkp00068usqc2as5d93",
                "value": "Business"
              },
              {
                "id": "cloirzzky00078usqha9i4o2u",
                "value": "Educational"
              }
            ]
          }
        },
        {
          "id": "cksq3ocb800n00hs0249bbds3",
          "identifier": "pin",
          "name": "Pin",
          "type": "pin",
          "config": {}
        }
      ]
    }
  ]
}

Deprecated

Get Element Types

get

Authorizations

Bearer Authentication

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Responses

200Success

application/json

objectOptionalExample: {"types":[{"id":"cksq3o1qn00j20hs0ayi7qagu","name":"Flat Entrance Doors","nameSingular":"Flat Entrance Door","fields":[{"id":"cksq3ocb600mu0hs0qhachlip","identifier":"flatNumber","name":"Flat Number","type":"text","config":{}},{"id":"eowcg4w4w84sk4o4w440k8k0","identifier":null,"name":"File Attachments","type":"string","config":{"multi":true},"contentMediaType":"application/octet-stream"},{"id":"i0sg4o4c0sgkkogsg4wsgwco","identifier":null,"name":"Main Image","type":"image","config":{"multi":false}},{"id":"cksq3oc5y004i0hs0ff0cbyk3","identifier":"occupancyType","name":"Type of Occupant","type":"option","config":{"multi":true,"options":[{"id":"cloirzzkg00058usq5r0kbhbw","value":"Residential"},{"id":"cloirzzkp00068usqc2as5d93","value":"Business"},{"id":"cloirzzky00078usqha9i4o2u","value":"Educational"}]}},{"id":"cksq3ocb800n00hs0249bbds3","identifier":"pin","name":"Pin","type":"pin","config":{}}]}]}

get/elements/types

HTTPcURLJavaScriptPython

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

200Success

{
  "types": [
    {
      "id": "cksq3o1qn00j20hs0ayi7qagu",
      "name": "Flat Entrance Doors",
      "nameSingular": "Flat Entrance Door",
      "fields": [
        {
          "id": "cksq3ocb600mu0hs0qhachlip",
          "identifier": "flatNumber",
          "name": "Flat Number",
          "type": "text",
          "config": {}
        },
        {
          "id": "eowcg4w4w84sk4o4w440k8k0",
          "identifier": null,
          "name": "File Attachments",
          "type": "string",
          "config": {
            "multi": true
          },
          "contentMediaType": "application/octet-stream"
        },
        {
          "id": "i0sg4o4c0sgkkogsg4wsgwco",
          "identifier": null,
          "name": "Main Image",
          "type": "image",
          "config": {
            "multi": false
          }
        },
        {
          "id": "cksq3oc5y004i0hs0ff0cbyk3",
          "identifier": "occupancyType",
          "name": "Type of Occupant",
          "type": "option",
          "config": {
            "multi": true,
            "options": [
              {
                "id": "cloirzzkg00058usq5r0kbhbw",
                "value": "Residential"
              },
              {
                "id": "cloirzzkp00068usqc2as5d93",
                "value": "Business"
              },
              {
                "id": "cloirzzky00078usqha9i4o2u",
                "value": "Educational"
              }
            ]
          }
        },
        {
          "id": "cksq3ocb800n00hs0249bbds3",
          "identifier": "pin",
          "name": "Pin",
          "type": "pin",
          "config": {}
        }
      ]
    }
  ]
}