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 software component tracked in Compass, Atlassian's developer experience platform. Components define microservices, libraries, or other software artifacts with associated metadata, ownership, and health metrics.
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 Compass component.
| Field | Type | Description |
|---|---|---|
description | String | The description of the component. |
id | ID! | The unique identifier (ID) of the component. |
name | String! | The name of the component. |
ownerId | ID | The unique identifier (ID) of the team that owns the component. |
state | String | The state of the component. |
typeId | ID! | The type of component. |
url | URL | The URL to the component in Compass. |
The following relationships are currently supported for Compass component:
Relationships where Compass component is the source object.
| Relationship name | From object type | To object type |
|---|---|---|
| JSM incident impacts Compass component | Compass component | Jira work item |
| Compass component has Compass component link | Compass component | Compass component link |
Rate this page: