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 change proposal, capturing proposed changes to focus areas including funding, impact, and position details.
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 Focus change proposal.
| Field | Type | Description |
|---|---|---|
createdAt | DateTime! | The date the Change Proposal was created. |
description | String | The description of the Change Proposal. |
focusArea | FocusFocusArea | The Focus Area that the proposal is associated with. |
funding | FocusChangeProposalFunding | Funding details for the Change Proposal. |
id | ID! | The ARI of the Change Proposal. |
impact | FocusChangeProposalImpact | The expected impact of the Change Proposal. Defaults to 0 if not set. |
name | String! | The name of the Change Proposal. |
owner | User | Owner of the Change Proposal. |
positionDetails | FocusChangeProposalPositionDetails | Positions Requested as part of a Change Proposal |
strategicEventId | ID | The Strategic Event that the proposal is associated with. |
updatedAt | DateTime! | The date any field on the Change Proposal was last updated. |
| Field | Type | Description |
|---|---|---|
aggregatedFocusAreaStatusCount | FocusFocusAreaStatusCountAggregate | Get aggregated Focus Area status counts |
archived | Boolean | Indicates if Focus Area is Archived |
createdAt | DateTime | The date the Focus Area was created. |
draft | Boolean | Indicates if the focus area is a draft |
focusAreaType | String | The Focus Area type indicating the Focus Area level in the hierarchy. |
health | String | The health of the Focus Area, e.g. on_track, off_track, at_risk. |
id | ID! | The ID of the Focus Area. |
name | String | The name of the Focus Area. |
owner | User | The owner responsible for the Focus Area. |
parentFocusAreaId | ID | The ARI of the Focus Area this Focus Area is a child of, or null for a top-level Focus Area. |
status | String | The status of the Focus Area, e.g. pending, in_progress, completed. |
targetDate | FocusFocusAreaTargetDate | The target delivery date of the Focus Area. |
updatedAt | DateTime | The date the any field on the Focus Area was last updated. |
url | URL | URL to the Focus Area |
watching | Boolean | Indicates if the current user is watching the Focus Area. |
| Field | Type | Description |
|---|---|---|
children | FocusFocusAreaStatusCount | Status count aggregations for children |
current | FocusFocusAreaStatusCount | Status count aggregations for current node |
subtree | FocusFocusAreaStatusCount | Status count aggregations for current node and children |
| Field | Type | Description |
|---|---|---|
atRisk | Int | Count of at-risk status |
completed | Int | Count with completed status |
inProgress | Int | Count of in-progress status |
offTrack | Int | Count of off-track status |
onTrack | Int | Count of on-track status |
paused | Int | Count with paused status |
pending | Int | Count with pending status |
total | Int | Total count of nodes |
| Field | Type | Description |
|---|---|---|
atRisk | Int | Count of at-risk status |
completed | Int | Count with completed status |
inProgress | Int | Count of in-progress status |
offTrack | Int | Count of off-track status |
onTrack | Int | Count of on-track status |
paused | Int | Count with paused status |
pending | Int | Count with pending status |
total | Int | Total count of nodes |
| Field | Type | Description |
|---|---|---|
atRisk | Int | Count of at-risk status |
completed | Int | Count with completed status |
inProgress | Int | Count of in-progress status |
offTrack | Int | Count of off-track status |
onTrack | Int | Count of on-track status |
paused | Int | Count with paused status |
pending | Int | Count with pending status |
total | Int | Total count of nodes |
| Field | Type | Description |
|---|---|---|
targetDate | DateTime | The target delivery date of the Focus Area. |
targetDateType | String | The target delivery date type. |
| Field | Type | Description |
|---|---|---|
fundsRequested | String | The total funds requested for the Change Proposal. |
targetBenefit | String | The target benefit of the Change Proposal. |
targetRoi | String | The target ROI of the Change Proposal. |
| Field | Type | Description |
|---|---|---|
key | String! | |
value | Int! |
| Field | Type | Description |
|---|---|---|
positionsImpacted | Int | The total number of positions moved plus the total number of new positions requested. |
positionsMoved | Int | The total number of positions moved for the Change Proposal. |
positionsRequested | Int | The total number of positions requested for the Change Proposal. |
The following relationships are currently supported for Focus change proposal:
Relationships where Focus change proposal is the target object.
Rate this page: