Jira work item links external pull request

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 JiraWorkItemLinksExternalPullRequest relationship represents the link between a Jira issue and an external pull request within the Teamwork Graph. It allows you to:

Retrieve external pull requests associated with a specific Jira issue
Find which Jira issues are associated with an external pull request
Traverse and analyze issue-pull-request relationships

Relationship type: Canonical

From object types	To object types
Jira Issue - `ati:cloud:jira:issue`	External Pull Request - `ati:cloud:jira:pull-request`
	External Pull Request - `ati:cloud:graph:pull-request`

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 JiraWorkItemLinksExternalPullRequest_CypherQuery($cypherQuery: String!, $params: CypherRequestParams) {
  cypherQuery(query: $cypherQuery, params: $params) {
    edges {
      node {
        columns {
          value {
            ... on CypherQueryResultNode {
              id
              data {
                __typename
                ... on DevOpsPullRequestDetails {
                  id
                }
                ... on ExternalPullRequest {
                  id
                }
              }
            }
          }
        }
      }
    }
  }
}

Params

1
2
{
  "cypherQuery": "MATCH (issue:JiraIssue {ari: $id})-[:jira_work_item_links_external_pull_request]->(request:GraphPullRequest) RETURN request",
  "params": {
    "id": "$id"
  }
}

Inverse query

GraphQL

1
2
query JiraWorkItemLinksExternalPullRequest_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_pull_request]->(request:GraphPullRequest {ari: $id}) RETURN issue",
  "params": {
    "id": "$id"
  }
}

Metadata

This relationship is not indexed, you will not be able to filter by this metadata when querying the relationship.

To Metadata

Name	Type	Properties
`status`	PullRequestStatus (`Enum`)
`reviewers`	Reviewer (`Message`)	`repeated`
`taskCount`	`Int`
`author`	Author (`Message`)

Nested Types

Reviewer

Name	Type	Properties
`approvalStatus`	ReviewerStatus (`Enum`)
`reviewerAri`	Ari (`Message`)

Author

Name	Type	Properties
`authorAri`	Ari (`Message`)

Ari

When filtering by ARI in GraphQL, it will behave as a String rather than a message as shown below.

Name	Type	Properties
`value`	`String`

PullRequestStatus

Name	Internal Name	Index
`not-set`	`PR_STATUS_NOT_SET`	`0`
`open`	`PR_STATUS_OPEN`	`1`
`merged`	`PR_STATUS_MERGED`	`2`
`declined`	`PR_STATUS_DECLINED`	`3`
`unknown`	`PR_STATUS_UNKNOWN`	`4`
`draft`	`PR_STATUS_DRAFT`	`5`

ReviewerStatus

Name	Internal Name	Index
`not-set`	`PR_REVIEWER_STATUS_NOT_SET`	`0`
`approved`	`PR_REVIEWER_STATUS_APPROVED`	`1`
`unapproved`	`PR_REVIEWER_STATUS_UNAPPROVED`	`2`
`needswork`	`PR_REVIEWER_STATUS_NEEDSWORK`	`3`