How to pairing elements using an External ID

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 has to be created in API section

Section External ID

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"
      }
    ]
  }
}

Knowledbase Cloud API

How to pairing elements using an External ID

Analytics

Example of using External ID

Related articles

Related content