Last updated Oct 12, 2026

External document has child external document

The Teamwork Graph API is available through Forge's Preview release phase.

Preview features are available to all users and receive the same level of support as generally available features. Schemas, fields, and behavior may still change before general availability (GA), and breaking changes are subject to a minimum 1-month deprecation notice, announced in the Teamwork Graph changelog.

To review the current limitations, see Limitations and considerations.

To share feedback or report an issue, visit the Atlassian developer community.

The ExternalDocumentHasChildExternalDocument relationship represents the hierarchical link between documents, where a parent document contains child documents. It allows you to:

Retrieve child documents within a specific parent document
Find the parent document of a specific child document
Build and traverse document hierarchies in the Teamwork Graph

Relationship type: Canonical

From object types	To object types
External document - `ati:cloud:jira:document, ati:cloud:graph:document`	External document - `ati:cloud:jira:document, ati:cloud:graph:document`

Cypher

We recommend sending parameterized Cypher queries as below instead of embedding the parameters directly in the query string. This approach will help ensure better performance.

Forward query

Inverse query

GraphQL

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
query ExternalDocumentHasChildExternalDocument_CypherQuery($cypherQuery: String!, $params: CypherRequestParams) {
  cypherQuery(query: $cypherQuery, params: $params) {
    edges {
      node {
        columns {
          value {
            ... on CypherQueryResultNode {
              id
              data {
                __typename
                ... on ExternalDocument {
                  id
                }
              }
            }
          }
        }
      }
    }
  }
}

Params

1
2
3
4
5
6
7
{
  "cypherQuery": "MATCH (document:ExternalDocument {ari: $id})-[:external_document_has_child_external_document]->(document_1:ExternalDocument) RETURN document_1",
  "params": {
    "id": "$id"
  }
}