Developer
Get Support
Sign in
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Object types
Relationship types
Last updated Jan 8, 2026

Jira work item links external design

The Teamwork Graph API is available through Forge's Early Access Program (EAP).

EAPs are offered to selected users for testing and feedback purposes. These features are unsupported and are subject to change without notice.

You must only install apps that call the Teamwork Graph API in test organizations. Apps calling the Teamwork Graph API require the read:graph:jiraor read:graph:confluence scope, which provides access to Teamwork Graph data across your entire organization. While apps still respect end-user permissions, this scope may grant access to sensitive information. For safety, only install these apps in organizations with test data. Do not install apps using this API in organizations with production data while this feature is in EAP.

Additionally, this EAP has significant limitations. To review the full list of limitations, see Limitations and considerations.

You must be part of this EAP in order to use the Teamwork Graph API. Express interest in joining through this form.

The `JiraWorkItemLinksExternalDesign` relationship represents the link between a Jira Work Item and an External Design within the Teamwork Graph. It allows you to:
* Retrieve External Designs associated with a specific Jira Work Item
* Find which Jira Work Items are associated with an External Design
* Traverse and analyze issue-design relationships

Relationship type: Canonical

From object typesTo object types
Jira Work Item - ati:cloud:jira:issueExternal Design - ati:cloud:jira:design
External Design - ati:cloud:graph:design

Cypher

Note

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.

GraphQL

1
2
query JiraWorkItemLinksExternalDesign_CypherQuery($cypherQuery: String!, $params: CypherRequestParams) {
  cypherQuery(query: $cypherQuery, params: $params) {
    edges {
      node {
        columns {
          value {
            ... on CypherQueryResultNode {
              id
              data {
                __typename
                ... on ExternalDesign {
                  id
                }
              }
            }
          }
        }
      }
    }
  }
}

Params

1
2
{
  "cypherQuery": "MATCH (item:JiraWorkItem {ari: $id})-[:jira_work_item_links_external_design]->(design:ExternalDesign) RETURN design",
  "params": {
    "id": "$id"
  }
}

Rate this page: