Get Entity

GET 
/entities/:entityTypeId/:entityId

Returns a entity

Request

Path Parameters

entityTypeId stringrequired

EntityType Identifier

entityId stringrequired

Entity Identifier

Query Parameters

siteId string

Site Identifier

namespace string

Possible values: [PRESET, CUSTOM]

Namespace Identifier

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

entity

object

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

dateValue string

Attribute with date value

dateValues string[]

Attribute with date values

valueType AttributeValueType (string)

Attribute Value Type

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

]

Example (from schema)

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

Loading...