Sprint contains issue

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 SprintContainsIssue relationship represents the link between a Jira sprint and a Jira issue within the Teamwork Graph. It allows you to:

Retrieve issues within a specific sprint
Find which sprint contains an issue
Traverse and analyze sprint-issue relationships

Relationship type: Canonical

From object type	To object type
Jira sprint - `ati:cloud:jira:sprint`	Jira issue - `ati:cloud:jira:issue`

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 SprintContainsIssue_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 (sprint:JiraSprint {ari: $id})-[:sprint_contains_issue]->(issue:JiraIssue) RETURN issue",
 "params": {
  "id": "$id"
 }
}

Inverse query

GraphQL

1
2
query SprintContainsIssue_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 JiraSprint {
           id
          }
         }
        }
       }. on GraphStoreCypherQueryV2AriNode {
        data {. on JiraSprint {
          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 (sprint:JiraSprint)-[:sprint_contains_issue]->(issue:JiraIssue {ari: $id}) RETURN sprint",
 "params": {
  "id": "$id"
 }
}

Metadata

To metadata

Name	Type	Description
`assigneeAri`	Ari (`Message`)	ARI of the user assigned to this issue.
`statusAri`	Ari (`Message`)	ARI of the current status of this issue.
`issueAri`	Ari (`Message`)	ARI of the issue itself.
`creatorAri`	Ari (`Message`)	ARI of the user who created this issue.
`reporterAri`	Ari (`Message`)	ARI of the user who reported this issue.
`statusCategory`	StatusCategory (`Enum`)	Status category of the issue (To Do, In Progress, Done).

Relationship metadata

Name	Type	Description
`issueLastUpdatedOn`	`Long`	Timestamp when the issue was last updated.

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.

StatusCategory

Name	Internal Name	Index	Description
`undefined`	`CATEGORY_UNDEFINED`	`0`	Status category has not been defined.
`new`	`CATEGORY_TO_DO`	`2`	Issue is in the To Do status category and has not been started.
`done`	`CATEGORY_DONE`	`3`	Issue has been completed and is in the Done status category.
`indeterminate`	`CATEGORY_IN_PROGRESS`	`4`	Issue is actively being worked on and is in the In Progress status category.