Jira work item links external design

The Teamwork Graph API is coming soon. The object and relationship types documented here are indicative of what will be available in the Graph via the Teamwork Graph API. Please note that relationships, objects, their properties, and functionality may change before and during the Early Access Program.

Interested in early access? Express your interest in joining the EAP

The JiraWorkItemLinksExternalDesign relationship represents the link between a Jira issue and an external design within the Teamwork Graph. It allows you to:

Retrieve external designs associated with a specific Jira issue
Find which Jira issues are associated with an external design
Traverse and analyze issue-design relationships

Relationship type: Canonical

From object types	To object types
Jira Issue - `ati:cloud:jira:issue`	External 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.

Forward query

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 DevOpsDesign {
                  id
                }
                ... on ExternalDesign {
                  id
                }
              }
            }
          }
        }
      }
    }
  }
}

Params

1
2
{
  "cypherQuery": "MATCH (issue:JiraIssue {ari: $id})-[:jira_work_item_links_external_design]->(design:GraphDesign) RETURN design",
  "params": {
    "id": "$id"
  }
}

Inverse query

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 JiraIssue {
                  id
                }
              }
            }
          }
        }
      }
    }
  }
}

Params

1
2
{
  "cypherQuery": "MATCH (issue:JiraIssue)-[:jira_work_item_links_external_design]->(design:GraphDesign {ari: $id}) RETURN issue",
  "params": {
    "id": "$id"
  }
}

Metadata

To Metadata

Name	Type	Properties
`status`	DesignStatus (`Enum`)
`type`	DesignType (`Enum`)

Nested Types

DesignStatus

Name	Internal Name	Index
`not-set`	`STATUS_NOT_SET`	`0`
`none`	`STATUS_NONE`	`100`
`ready_for_development`	`STATUS_READY_FOR_DEVELOPMENT`	`110`
`unknown`	`STATUS_UNKNOWN`	`120`

DesignType

Name	Internal Name	Index
`not-set`	`TYPE_NOT_SET`	`0`
`canvas`	`TYPE_CANVAS`	`100`
`file`	`TYPE_FILE`	`110`
`group`	`TYPE_GROUP`	`120`
`node`	`TYPE_NODE`	`130`
`other`	`TYPE_OTHER`	`140`
`prototype`	`TYPE_PROTOTYPE`	`150`