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.
An External Service is a managed solution or component within the DevOps ecosystem that automates and streamlines software development, deployment, and operational processes
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 External Service.
| Field | Type | Description |
|---|---|---|
description | String | The description of the External Service |
id | ID! | The External Service ARI |
name | String | The name of the External Service |
revisionId | ID | The revision that must be provided when updating an External Service to prevent simultaneous updates from overwriting each other |
The following relationships are currently supported for External Service:
Relationships where External Service is the source object.
| Relationship name | From object type | To object type |
|---|---|---|
| External service links opsgenie team | External Service | Opsgenie team |
| External service links external deployment | External Service | External deployment |
| External service links external commit | External Service | External commit |
| External service links external repository | External Service | External repository |
| External service links external build | External Service | External build |
| External service links external branch | External Service | External branch |
| JSM incident links external service | External Service | Jira work item |
| External service links external pull request | External Service | External pull request |
| External service links external feature flag | External Service | External feature flag |
Rate this page: