The Teamwork Graph API is available through Forge's Early Access Program (EAP).
EAPs are offered to selected users for testing and feedback purposes. These features are unsupported and are subject to change without notice.
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.
Represents a version or release in Jira used for tracking deliverables and milestones.
The Teamwork Graph API has the following fields and properties that you can use in your queries:
You can access these fields in the GraphiQL playground using the book icon in the top left, and then searching for Jira version.
| Field | Type | Description |
|---|---|---|
description | String | Version description. |
iconUrl | URL | Version icon URL. |
id | ID! | Unique identifier for the version. This ID is globally unique across the entire Teamwork Graph. |
name | String | Version name. |
overdue | Boolean | Indicates that the version is overdue. |
releasedAt | DateTime | The date at which the version was released to customers. Must occur after startDate. |
startedAt | DateTime | The date at which work on the version began. |
status | JiraVersionStatus | Status to which version belongs to (RELEASED, UNRELEASED, or ARCHIVED). |
versionId | ID | Version id in the digital format. |
| Value | Description |
|---|---|
ARCHIVED | The version has been archived. |
RELEASED | The version has been released. |
UNRELEASED | The version has not been released yet. |
The following relationships are currently supported for Jira version:
Relationships where Jira version is the source object.
| Relationship name | From object type | To object type |
|---|---|---|
| Jira version links Jira work item | Jira version | Jira work item |
| Jira version links external feature flag | Jira version | External feature flag |
Rate this page: