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 on a Jira work item for collaboration and communication.
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 work item comment.
| Field | Type | Description |
|---|---|---|
author | User | User profile of the original comment author. |
content | String | The content of the comment in plain text format. |
createdAt | DateTime | Time of comment creation. |
deleted | Boolean | Property to denote if the comment is a deleted root comment. Default value is False. |
id | ID! | Unique identifier for the comment. This ID is globally unique across the entire Teamwork Graph. |
lastEditor | User | User profile of the author performing the comment update. |
threadParentId | ID | Parent ID of the child for which data is requested. This should be non-null if a child comment is requested and null if a root comment is requested. |
updatedAt | DateTime | Time of last comment update. |
webUrl | URL | The browser clickable link of this comment. |
The following relationships are currently supported for Jira work item comment:
Relationships where Jira work item comment is the target object.
| Relationship name | From object type | To object type |
|---|---|---|
| Atlassian user created Jira work item comment | Atlassian user | Jira work item comment |
| Jira work item has Jira work item comment | Jira work item | Jira work item comment |
| Atlassian user reacted to Jira work item comment | Atlassian user | Jira work item comment |
| Atlassian user mentioned in Jira work item comment | Atlassian user | Jira work item comment |
| Atlassian user dismissed Jira for you recommendation entity | Atlassian user | Jira work item comment |
Rate this page: