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 status update or progress report for an Atlassian project. Project updates communicate progress, blockers, or changes in project status to team members and stakeholders.
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 project update.
| Field | Type | Description |
|---|---|---|
createdAt | DateTime | The date and time when the project update was originally created. |
creator | User | The user object representing the person who created this project update. |
editedAt | DateTime | The date and time when the project 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 project 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 project's due date was updated. |
newDueDateStartedAt | DateTime | The new start of the range for the due date, if the project's due date was updated. |
newPhase | ProjectPhase | The new project phase that the project was moved to, if the phase was changed. |
newState | ProjectState | The new project state that the project was moved to, if the state was changed. |
newTargetDateAt | DateTime | The new target date for project completion, if the target date was updated. |
newTargetDateConfidence | Int! | The confidence level (as a percentage) in achieving the new target date. |
oldDueDateEndedAt | DateTime | The previous end of the range for the due date, before any updates were made. |
oldDueDateStartedAt | DateTime | The previous start of the range for the due date, before any updates were made. |
oldPhase | ProjectPhase | The previous project phase, before the project phase was changed. |
oldState | ProjectState | The previous project state, before the project state was changed. |
oldTargetDateAt | DateTime | The previous target date for project completion, before any updates were made. |
oldTargetDateConfidence | Int | The previous confidence level (as a percentage) in achieving the target date. |
summary | String | A text summary or description of the changes made in this project update. |
updateType | UpdateType | Indicates whether this update was created by a user or automatically by the system. |
url | URL | The URL link to view the project update in the Atlassian web interface. |
| Value | Description |
|---|---|
DONE | The project is done |
IN_PROGRESS | The project is in progress |
PAUSED | The project is paused |
PENDING | The project is pending |
| Value | Description |
|---|---|
ARCHIVED | The project is archived |
AT_RISK | The project is at risk |
CANCELLED | The project is cancelled |
DONE | The project is done |
OFF_TRACK | The project is off track |
ON_TRACK | The project is on track |
PAUSED | The project is paused |
PENDING | The project is pending |
| Value | Description |
|---|---|
DONE | The project is done |
IN_PROGRESS | The project is in progress |
PAUSED | The project is paused |
PENDING | The project is pending |
| Value | Description |
|---|---|
ARCHIVED | The project is archived |
AT_RISK | The project is at risk |
CANCELLED | The project is cancelled |
DONE | The project is done |
OFF_TRACK | The project is off track |
ON_TRACK | The project is on track |
PAUSED | The project is paused |
PENDING | The project 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 project update:
Relationships where Atlassian project update is the target object.
| Relationship name | From object type | To object type |
|---|---|---|
| Atlassian user viewed Atlassian project update | Atlassian user | Atlassian project update |
| Atlassian project has Atlassian project update | Atlassian project | Atlassian project update |
Rate this page: