The External ID is used to uniquely identify the element for integration into third-party services.
When querying the NodeList type, the External ID that was entered in the user interface can be displayed for all elements in the tree structure.
An External ID can be created in API section.
Adding new External ID:
Select parent item and add name of External Identifier. When you click on Save so External ID is created.
Example of using External ID
The following query returns a list of nodes, including the corresponding External IDs.
Query:
query{
nodeList {
name
external_id
}
}
Response:
{
"data": {
"nodeList": [
{
"name": "Folder",
"external_id": "001"
},
{
"name": "ACCC8EE8A9CA",
"external_id": "camera1"
}
]
}
}