Entities

Troubleshooting

PreviousDashboards & Views NextScorecards

Last updated 9 months ago

Was this helpful?

Get Entities

get

/api/v1/entities

Authorizations

Query parameters

blueprintIdsBlueprintids

excludeReferencePropertiesExcludereferenceproperties

includeCalculationPropertiesIncludecalculationproperties

searchQuerySearchquery

showHiddenShowhidden

filtersFilters

sortsSorts

cursorCursor

sizeSize

includeTotalIncludetotal

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v1/entities' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

422

{
  "total": 1,
  "current_page": "text",
  "current_page_backwards": "text",
  "previous_page": "text",
  "next_page": "text",
  "items": [
    {
      "id": "text",
      "blueprintId": "text",
      "title": "text",
      "description": "text",
      "isActive": true,
      "isHidden": false,
      "properties": {},
      "createdAt": "2025-02-21T18:15:24.153Z",
      "createdBy": 1,
      "updatedAt": "2025-02-21T18:15:24.153Z",
      "updatedBy": 1,
      "relations": {
        "ANY_ADDITIONAL_PROPERTY": {
          "value": "text"
        }
      },
      "calculationProperties": {
        "ANY_ADDITIONAL_PROPERTY": {
          "unit": "text",
          "1h": {
            "timeseries": [
              [
                "2025-02-21T18:15:24.153Z"
              ]
            ]
          },
          "1d": {
            "timeseries": [
              [
                "2025-02-21T18:15:24.153Z"
              ]
            ]
          },
          "1w": {
            "timeseries": [
              [
                "2025-02-21T18:15:24.153Z"
              ]
            ]
          },
          "1m": {
            "timeseries": [
              [
                "2025-02-21T18:15:24.153Z"
              ]
            ]
          }
        }
      },
      "sources": {
        "^([a-z0-9_.-]+)$": {
          "type": "automation",
          "config": null,
          "activeMappings": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        },
        "ANY_ADDITIONAL_PROPERTY": {
          "type": "automation",
          "config": null,
          "activeMappings": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      },
      "referenceProperties": {
        "ANY_ADDITIONAL_PROPERTY": [
          {
            "entityId": "text",
            "value": null
          }
        ]
      }
    }
  ]
}

Successful Response

Create Entity

post

/api/v1/entities

Authorizations

Body

idIdrequired

Pattern: ^([a-z0-9_.-]+)$

blueprintIdBlueprintidrequired

Pattern: ^([a-z0-9_.-]+)$

titleTitlerequired

descriptionDescription

isActiveIsactive

isHiddenIshidden

propertiesProperties

relationsRelations

sourcesSources

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v1/entities' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"id":"text","blueprintId":"text","title":"text","isActive":true,"isHidden":false,"properties":{},"relations":{"ANY_ADDITIONAL_PROPERTY":{}},"sources":{"^([a-z0-9_.-]+)$":{"type":"automation","activeMappings":{"ANY_ADDITIONAL_PROPERTY":"text"}},"ANY_ADDITIONAL_PROPERTY":{"type":"automation","activeMappings":{"ANY_ADDITIONAL_PROPERTY":"text"}}}}'

200

422

{
  "id": "text",
  "blueprintId": "text",
  "title": "text",
  "description": "text",
  "isActive": true,
  "isHidden": false,
  "properties": {},
  "createdAt": "2025-02-21T18:15:24.153Z",
  "createdBy": 1,
  "updatedAt": "2025-02-21T18:15:24.153Z",
  "updatedBy": 1,
  "relations": {
    "ANY_ADDITIONAL_PROPERTY": {
      "value": "text"
    }
  },
  "sources": {
    "^([a-z0-9_.-]+)$": {
      "type": "automation",
      "config": null,
      "activeMappings": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "ANY_ADDITIONAL_PROPERTY": {
      "type": "automation",
      "config": null,
      "activeMappings": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  }
}

Successful Response

Get Entity

get

/api/v1/entities/{id_}

Authorizations

Path parameters

id_Id required

Pattern: ^([a-z0-9_.-]+)$

Query parameters

excludeReferencePropertiesExcludereferenceproperties

includeCalculationPropertiesIncludecalculationproperties

fetchLivePropertiesFetchliveproperties

Fetch live properties data synchronously.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v1/entities/{id_}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

422

{
  "id": "text",
  "blueprintId": "text",
  "title": "text",
  "description": "text",
  "isActive": true,
  "isHidden": false,
  "properties": {},
  "createdAt": "2025-02-21T18:15:24.153Z",
  "createdBy": 1,
  "updatedAt": "2025-02-21T18:15:24.153Z",
  "updatedBy": 1,
  "relations": {
    "ANY_ADDITIONAL_PROPERTY": {
      "value": "text"
    }
  },
  "calculationProperties": {
    "ANY_ADDITIONAL_PROPERTY": {
      "unit": "text",
      "1h": {
        "timeseries": [
          [
            "2025-02-21T18:15:24.153Z"
          ]
        ]
      },
      "1d": {
        "timeseries": [
          [
            "2025-02-21T18:15:24.153Z"
          ]
        ]
      },
      "1w": {
        "timeseries": [
          [
            "2025-02-21T18:15:24.153Z"
          ]
        ]
      },
      "1m": {
        "timeseries": [
          [
            "2025-02-21T18:15:24.153Z"
          ]
        ]
      }
    }
  },
  "sources": {
    "^([a-z0-9_.-]+)$": {
      "type": "automation",
      "config": null,
      "activeMappings": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "ANY_ADDITIONAL_PROPERTY": {
      "type": "automation",
      "config": null,
      "activeMappings": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  },
  "referenceProperties": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "entityId": "text",
        "value": null
      }
    ]
  }
}

Successful Response

Upsert Entity

put

/api/v1/entities/{id_}

Authorizations

Path parameters

id_Id required

Pattern: ^([a-z0-9_.-]+)$

Query parameters

patchPatch

Patch entity instead of full update

unmappedPropertiesall of · default: forbid

updatePropertiesAndRelationsOnlyUpdatepropertiesandrelationsonly

Update only properties and relations

overrideSourcesOverridesources

Allow updating entity data that have an active source

Body

idIdrequired

Pattern: ^([a-z0-9_.-]+)$

blueprintIdBlueprintidrequired

Pattern: ^([a-z0-9_.-]+)$

titleTitle

descriptionDescription

isActiveIsactive

isHiddenIshidden

propertiesProperties

relationsRelations

sourcesSources

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v1/entities/{id_}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"id":"text","blueprintId":"text","properties":{},"relations":{"ANY_ADDITIONAL_PROPERTY":{}},"sources":{"^([a-z0-9_.-]+)$":{"type":"automation","activeMappings":{"ANY_ADDITIONAL_PROPERTY":"text"}},"ANY_ADDITIONAL_PROPERTY":{"type":"automation","activeMappings":{"ANY_ADDITIONAL_PROPERTY":"text"}}}}'

200

422

{
  "id": "text",
  "blueprintId": "text",
  "title": "text",
  "description": "text",
  "isActive": true,
  "isHidden": false,
  "properties": {},
  "createdAt": "2025-02-21T18:15:24.153Z",
  "createdBy": 1,
  "updatedAt": "2025-02-21T18:15:24.153Z",
  "updatedBy": 1,
  "relations": {
    "ANY_ADDITIONAL_PROPERTY": {
      "value": "text"
    }
  },
  "sources": {
    "^([a-z0-9_.-]+)$": {
      "type": "automation",
      "config": null,
      "activeMappings": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "ANY_ADDITIONAL_PROPERTY": {
      "type": "automation",
      "config": null,
      "activeMappings": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  }
}

Successful Response

Delete Entity

delete

/api/v1/entities/{id_}

Authorizations

Path parameters

id_Id required

Pattern: ^([a-z0-9_.-]+)$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/v1/entities/{id_}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

422

No body

Successful Response

Create Or Update Entities Bulk

put

/api/v1/entities/bulk

Authorizations

Query parameters

patchPatch

Patch entity instead of full update

unmappedPropertiesall of · default: forbid

updatePropertiesAndRelationsOnlyUpdatepropertiesandrelationsonly

Update only properties and relations

createRelationsCreaterelations

Create entity relations if they dont exist

overrideSourcesOverridesources

Allow updating entity data that have an active source

Body

idIdrequired

Pattern: ^([a-z0-9_.-]+)$

blueprintIdBlueprintidrequired

Pattern: ^([a-z0-9_.-]+)$

titleTitle

descriptionDescription

isActiveIsactive

isHiddenIshidden

propertiesProperties

relationsRelations

sourcesSources

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v1/entities/bulk' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[{"id":"text","blueprintId":"text","properties":{},"relations":{"ANY_ADDITIONAL_PROPERTY":{}},"sources":{"^([a-z0-9_.-]+)$":{"type":"automation","activeMappings":{"ANY_ADDITIONAL_PROPERTY":"text"}},"ANY_ADDITIONAL_PROPERTY":{"type":"automation","activeMappings":{"ANY_ADDITIONAL_PROPERTY":"text"}}}}]'

201

422

[
  {
    "id": "text",
    "blueprintId": "text",
    "title": "text",
    "description": "text",
    "isActive": true,
    "isHidden": false,
    "properties": {},
    "createdAt": "2025-02-21T18:15:24.153Z",
    "createdBy": 1,
    "updatedAt": "2025-02-21T18:15:24.153Z",
    "updatedBy": 1,
    "relations": {
      "ANY_ADDITIONAL_PROPERTY": {
        "value": "text"
      }
    },
    "sources": {
      "^([a-z0-9_.-]+)$": {
        "type": "automation",
        "config": null,
        "activeMappings": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "ANY_ADDITIONAL_PROPERTY": {
        "type": "automation",
        "config": null,
        "activeMappings": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    }
  }
]

Successful Response

Validate Entity

post

/api/v1/entities/validate

Authorizations

Body

idIdrequired

Pattern: ^([a-z0-9_.-]+)$

blueprintIdBlueprintidrequired

Pattern: ^([a-z0-9_.-]+)$

titleTitlerequired

descriptionDescription

isActiveIsactive

isHiddenIshidden

propertiesProperties

relationsRelations

sourcesSources

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v1/entities/validate' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"id":"text","blueprintId":"text","title":"text","isActive":true,"isHidden":false,"properties":{},"relations":{"ANY_ADDITIONAL_PROPERTY":{}},"sources":{"^([a-z0-9_.-]+)$":{"type":"automation","activeMappings":{"ANY_ADDITIONAL_PROPERTY":"text"}},"ANY_ADDITIONAL_PROPERTY":{"type":"automation","activeMappings":{"ANY_ADDITIONAL_PROPERTY":"text"}}}}'

200

422

{
  "valid": true,
  "errors": [
    {}
  ]
}

Successful Response