Issue associated PR

The Teamwork Graph API is coming soon. The relationship types documented here are indicative of what will be available in the Graph via the Teamwork Graph API. Please note that relationships, 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 IssueAssociatedPr 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 type	To object type
Jira issue - `ati:cloud:jira:issue`	External pull request - `ati:cloud:jira:pull-request`

Cypher

We recommend using parameterized Cypher queries rather than placing parameters directly in the query string. This helps improve performance.

Forward query

GraphQL

1
2
query IssueAssociatedPr_CypherQuery($cypherQuery: String!, $params: JSON!) {
 graphStore @optIn(to: ["GraphStore", "GraphStoreCypherQueryV2"]) {
  cypherQueryV2(query: $cypherQuery, params: $params) {
   edges {
    node {
     columns {
      key
      value {. on GraphStoreCypherQueryV2NodeList {
        nodes {
         data {. on DevOpsPullRequestDetails {
           id
          }. on ExternalPullRequest {
           id
          }
         }
        }
       }. on GraphStoreCypherQueryV2AriNode {
        data {. on DevOpsPullRequestDetails {
          id
         }. on ExternalPullRequest {
          id
         }
        }
       }. on GraphStoreCypherQueryV2BooleanObject {
        bool_val: value
       }. on GraphStoreCypherQueryV2IntObject {
        int_val: value
       }. on GraphStoreCypherQueryV2FloatObject {
        float_val: value
       }. on GraphStoreCypherQueryV2StringObject {
        str_val: value
       }
      }
     }
    }
   }
  }
 }
}

Params

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

Inverse query

GraphQL

1
2
query IssueAssociatedPr_CypherQuery($cypherQuery: String!, $params: JSON!) {
 graphStore @optIn(to: ["GraphStore", "GraphStoreCypherQueryV2"]) {
  cypherQueryV2(query: $cypherQuery, params: $params) {
   edges {
    node {
     columns {
      key
      value {. on GraphStoreCypherQueryV2NodeList {
        nodes {
         data {. on JiraIssue {
           id
          }
         }
        }
       }. on GraphStoreCypherQueryV2AriNode {
        data {. on JiraIssue {
          id
         }
        }
       }. on GraphStoreCypherQueryV2BooleanObject {
        bool_val: value
       }. on GraphStoreCypherQueryV2IntObject {
        int_val: value
       }. on GraphStoreCypherQueryV2FloatObject {
        float_val: value
       }. on GraphStoreCypherQueryV2StringObject {
        str_val: value
       }
      }
     }
    }
   }
  }
 }
}

Params

1
2
{
 "cypherQuery": "MATCH (issue:JiraIssue)-[:issue_associated_pr]->(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 this relationship.

To metadata

Name	Type	Description
`status`	PullRequestStatus (`Enum`)	Current status of the pull request.
`reviewers`	Reviewer (`Message`)	List of users assigned as reviewers for this pull request.
`taskCount`	`Int`	Number of tasks or checklist items in the pull request.
`author`	Author (`Message`)	Author information for the pull request.

PullRequestStatus

Name	Internal Name	Index	Description
`not-set`	`PR_STATUS_NOT_SET`	`0`	No status has been set for this pull request.
`open`	`PR_STATUS_OPEN`	`1`	Pull request is open and awaiting review or merge.
`merged`	`PR_STATUS_MERGED`	`2`	Pull request has been successfully merged into the target branch.
`declined`	`PR_STATUS_DECLINED`	`3`	Pull request has been declined and will not be merged.
`unknown`	`PR_STATUS_UNKNOWN`	`4`	Pull request status cannot be determined.
`draft`	`PR_STATUS_DRAFT`	`5`	Pull request is in draft mode and not ready for review.

Reviewer

Name	Type	Description
`approvalStatus`	ReviewerStatus (`Enum`)	Current approval status of this reviewer for the pull request.
`reviewerAri`	Ari (`Message`)	ARI of the user assigned as a reviewer.

Author

Name	Type	Description
`authorAri`	Ari (`Message`)	ARI of the user who created this pull request.

ReviewerStatus

Name	Internal Name	Index	Description
`not-set`	`PR_REVIEWER_STATUS_NOT_SET`	`0`	No reviewer status has been set.
`approved`	`PR_REVIEWER_STATUS_APPROVED`	`1`	Reviewer has approved the pull request changes.
`unapproved`	`PR_REVIEWER_STATUS_UNAPPROVED`	`2`	Reviewer has not yet approved the pull request.
`needswork`	`PR_REVIEWER_STATUS_NEEDSWORK`	`3`	Reviewer has requested changes before approval.

Ari

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

Name	Type	Description
`value`	`String`	The ARI string value identifying the user or resource.