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 comment from an external system integrated with the Teamwork Graph.
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 comment.
| Field | Type | Description |
|---|---|---|
containerId | ID | Identifier of the container (e.g., issue, pull request, document) that holds this comment. |
createdAt | DateTime | Timestamp when the comment was created. |
createdBy | User | User who created this comment. |
displayName | String | Display name or title of the comment. |
externalId | ID | Identifier of the comment in the external system. |
id | ID! | Unique identifier for the comment. This ID is globally unique across the entire Teamwork Graph. |
lastUpdatedAt | DateTime | Timestamp of the most recent update to the comment. |
lastUpdatedBy | User | User who last updated this comment. |
parentId | ID | Identifier of the parent comment if this is a reply. |
text | String | Text content of the comment. |
The following relationships are currently supported for External comment:
Relationships where External comment is the target object.
| Relationship name | From object type | To object type |
|---|---|---|
| External pull request has external comment | External pull request | External comment |
Rate this page: