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 has to be created in API section -
...
Example of using External ID
The following query returns a list of nodes, including the corresponding External IDs.
Query:
Code Block | ||
---|---|---|
| ||
query{ nodeList { name external_id } } |
...
Response:
Code Block | ||
---|---|---|
| ||
{ "data": { "nodeList": [ { "name": "Folder", "external_id": "001" }, { "name": "ACCC8EE8A9CA", "external_id": "camera1" } ] } } |
...