GET NLU/GetEntityList

GetEntityList end point will be used to get a list of user entities that are defined by the operator in Jetlink dashboard.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

EntityResponse
NameDescriptionTypeAdditional information
Id

Returned process unique id

string

None.

Timestamp

Returned process time. (in unix timestamp format)

integer

None.

EntityResult

Jetlink platform entity result data

Collection of EntityResult

None.

Status

Returned status of process

Status

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "Timestamp": 2,
  "EntityResult": [
    {
      "EntityId": "sample string 1",
      "EntityName": "sample string 2",
      "EntityResultReference": [
        {
          "ReferenceValue": "sample string 1",
          "Synonyms": [
            "sample string 1",
            "sample string 2"
          ]
        },
        {
          "ReferenceValue": "sample string 1",
          "Synonyms": [
            "sample string 1",
            "sample string 2"
          ]
        }
      ],
      "CreateDate": 3
    },
    {
      "EntityId": "sample string 1",
      "EntityName": "sample string 2",
      "EntityResultReference": [
        {
          "ReferenceValue": "sample string 1",
          "Synonyms": [
            "sample string 1",
            "sample string 2"
          ]
        },
        {
          "ReferenceValue": "sample string 1",
          "Synonyms": [
            "sample string 1",
            "sample string 2"
          ]
        }
      ],
      "CreateDate": 3
    }
  ],
  "Status": {
    "Code": 1,
    "ErrorType": "sample string 2",
    "ErrorId": "sample string 3",
    "ErrorDescription": "sample string 4"
  }
}