The Teamwork Graph API is available through Forge's Preview release phase.
Preview features are available to all users and receive the same level of support as generally available features. Schemas, fields, and behavior may still change before general availability (GA), and breaking changes are subject to a minimum 1-month deprecation notice, announced in the Teamwork Graph changelog.
To review the current limitations, see Limitations and considerations.
To share feedback or report an issue, visit the Atlassian developer community.
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 source object.
Rate this page: