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 an update or progress report for an Atlassian goal. Goal updates track progress, changes in status, or milestone achievements for specific goals.
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 goal update.
| Field | Type | Description |
|---|---|---|
createdAt | DateTime | The date and time when the goal update was originally created. |
creator | User | The user object representing the person who created this goal update. |
editedAt | DateTime | The date and time when the goal update 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. |
lastEditor | User | The user object representing the person who last edited this goal update. |
missedUpdate | Boolean! | Indicates whether this update represents a missed scheduled update that was not provided on time. |
newDueDateEndedAt | DateTime | The new end of the range for the due date, if the goal's due date was updated. |
newDueDateStartedAt | DateTime | The new start of the range for the due date, if the goal's due date was updated. |
newScore | Int! | The new score or progress value assigned to the goal in this update. |
newState | GoalState | The new state that the goal was moved to, if the state was changed. |
summary | String | A text summary or description of the changes made in this goal update. |
targetDateAt | DateTime | The target date for when the goal should be completed or achieved. |
updateType | UpdateType | Indicates whether this update was created by a user or automatically by the system. |
url | URL | The URL link to view the goal update in the Atlassian web interface. |
| Value | Description |
|---|---|
ARCHIVED | The goal is archived |
AT_RISK | The goal is at risk |
CANCELLED | The goal is cancelled |
DONE | The goal is done |
OFF_TRACK | The goal is off track |
ON_TRACK | The goal is on track |
PAUSED | The goal is paused |
PENDING | The goal is pending |
| Value | Description |
|---|---|
SYSTEM | The update was created by the system |
USER | The update was created by a user |
The following relationships are currently supported for Atlassian goal update:
Relationships where Atlassian goal update is the target object.
| Relationship name | From object type | To object type |
|---|---|---|
| Atlassian user viewed Atlassian goal update | Atlassian user | Atlassian goal update |
| Atlassian goal has Atlassian goal update | Atlassian goal | Atlassian goal update |
Rate this page: