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 made within Atlassian on goals, projects, or updates. Atlassian Home comments enable team collaboration and discussion around shared objectives and project activities.
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 Atlassian Home comment.
| Field | Type | Description |
|---|---|---|
commentText | String | The text content of the comment, containing the user's message or feedback. |
createdAt | DateTime | The date and time when the comment was originally created. |
creator | User | The user object representing the person who created this comment. |
editedAt | DateTime | The date and time when the comment was last edited or modified. |
id | ID! | ID in an ARI format. An Atlassian Resource Identifier (ARI) is a globally unique identifier used across Atlassian apps and services for the unique identification of content. |
url | URL | The URL link to view the comment in the Atlassian web interface. |
The following relationships are currently supported for Atlassian Home comment:
Relationships where Atlassian Home comment is the target object.
| Relationship name | From object type | To object type |
|---|---|---|
| Atlassian user created Atlassian home comment | Atlassian user | Atlassian Home comment |
Rate this page: