Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

...

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:

Code Block
languagejson
query{
  nodeList {
    name
    external_id
  }
}

...

Response:

Code Block
languagejson
{
  "data": {
    "nodeList": [
      {
        "name": "Folder",
        "external_id": "001"
      },
      {
        "name": "ACCC8EE8A9CA",
        "external_id": "camera1"
      }
    ]
  }
}

Filter by label (Content by label)
showLabelsfalse
max5
spacescom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@121e9
sortmodified
showSpacefalse
reversetrue
typepage
cqllabel = "kb-how-to-article" and type = "page" and space = "KCA"
labelskb-how-to-article