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.

A relationship type representing a user being tagged in the description of a Jira Work Item as a mention. This does not include mentions if the user mentions themselves as there won't be streamhub events for that. Note that there is no reliable way to determine if a user was removed from mentions hence once a relationship is created it will not be deleted unless the issue or user is deleted. **Relationship type**: Canonical

From object types	To object types
Atlassian User - `ati:cloud:identity:user`	Jira Work Item - `ati:cloud:jira:issue`

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

Inverse query

GraphQL

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

Params

1
2
{
  "cypherQuery": "MATCH (user:AtlassianUser {ari: $id})-[:atlassian_user_mentioned_in_jira_work_item]->(item:JiraWorkItem) RETURN item",
  "params": {
    "id": "$id"
  }
}

Metadata

Relationship Metadata

Name	Type	Properties
`statusCategory`	StatusCategory (`Enum`)
`projectType`	ProjectType (`Enum`)
`actorAri`	Ari (`Message`)

Nested Types

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`

StatusCategory

Name	Internal Name	Index
`not-set`	`STATUS_NOT_SET`	`0`
`undefined`	`STATUS_UNDEFINED`	`1`
`new`	`STATUS_NEW`	`2`
`done`	`STATUS_DONE`	`3`
`indeterminate`	`STATUS_INDETERMINATE`	`4`

ProjectType

Name	Internal Name	Index
`not-set`	`TYPE_PROJECT_TYPE_NOT_SET`	`0`
`service_desk`	`TYPE_PROJECT_TYPE_SERVICE_DESK`	`1`
`business`	`TYPE_PROJECT_TYPE_BUSINESS`	`2`
`software`	`TYPE_PROJECT_TYPE_SOFTWARE`	`3`
`product_discovery`	`TYPE_PROJECT_TYPE_PRODUCT_DISCOVERY`	`4`
`customer_service`	`TYPE_PROJECT_TYPE_CUSTOMER_SERVICE`	`5`
`ops`	`TYPE_PROJECT_TYPE_OPS`	`6`