Get Entities

GET 
/entities/:entityTypeId

Returns a list of entities

Request

Path Parameters

entityTypeId stringrequired

EntityType Identifier

Query Parameters

siteId string

Site Identifier

namespace string

Possible values: [PRESET, CUSTOM]

Namespace Identifier

next string

Next page of results token

limit string
Limit Results
Default value: 10

Responses

200

200 OK

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

next string

Next page of results token

entities

object[]

List of Entities

Array [

entityId string

Entity identifier

entityTypeId string

Entity Type identifier

name string

Entity Name

insertedDate string

Inserted Timestamp

attributes

object[]

List of Entity Attributes

Array [

key string

Attribute key

stringValue string

Attribute with string value

stringValues string[]

Attribute with string values

numberValue number

Attribute with number value

numberValues number[]

Attribute with number values

booleanValue boolean

Attribute with boolean value

valueType AttributeValueType (string)

Attribute Value Type

Possible values: [BOOLEAN, KEY_ONLY, NUMBER, STRING, PUBLICATION, CLASSIFICATION, COMPOSITE_STRING, RELATIONSHIPS, WATERMARK, ENTITY]

]

]

Example (from schema)

{
  "next": "string",
  "entities": [
    {
      "entityId": "string",
      "entityTypeId": "string",
      "name": "string",
      "insertedDate": "string",
      "attributes": [
        {
          "key": "string",
          "stringValue": "string",
          "stringValues": [
            "string"
          ],
          "numberValue": 0,
          "numberValues": [
            0
          ],
          "booleanValue": true,
          "valueType": "BOOLEAN"
        }
      ]
    }
  ]
}

Loading...