Asana: Update a goal relationship
Asana goalRelationships.updateGoalRelationship: arguments, response, policy and SDK examples.
← Goal relationships operations · Get started
Operation asana.updategoalrelationship
Provider route: PUT /goal_relationships/{goal_relationship_gid}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/asana with npm, or alter-sdk-asana with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { AsanaIntegration } from "@alter-ai/asana";
async function execute(input: Parameters<AsanaIntegration["goalRelationships"]["updateGoalRelationship"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new AsanaIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.goalRelationships.updateGoalRelationship(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_asana import AsanaIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = AsanaIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.goal_relationships.update_goal_relationship(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.goal_relationship_gid | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.opt_pretty | boolean | Optional | |
query.opt_fields | array | Optional | |
query.opt_fields[] | string | Each item | One of: contribution_weight, resource_subtype, supported_goal, supported_goal.name, supported_goal.owner, supported_goal.owner.name, supporting_resource, supporting_resource.name, supporting_resource.resource_subtype |
body | object | Required within parent | |
body.data | Model | Optional | Expand Update a goal relationship — request body — body data |
Referenced models: Update a goal relationship — request body — body data
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | object | All variants apply | |
$ (allOf 1).data | Model | Optional | Expand Get a goal relationship — response body — data data — Goal Relationship Response |
$ (allOf 2) | Model | All variants apply | Expand Get a goal relationship — response body — data |
Referenced models: Get a goal relationship — response body — data data — Goal Relationship Response, Get a goal relationship — response body — data
Schemas
Section titled “Schemas”5 more schemas are linked from the tables above, on the schema pages.
Update a goal relationship — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Update a goal relationship — request body — body / data / resource_subtype: subgoal, supporting work |
$ (allOf 2) | object | All variants apply |
Referenced models: Update a goal relationship — request body — body / data / resource_subtype: subgoal, supporting work
Get a goal relationship — response body — data data — Goal Relationship Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get a goal relationship — response body — data / data / resource_subtype: subgoal, supporting work |
$ (allOf 2) | object | All variants apply |
Referenced models: Get a goal relationship — response body — data / data / resource_subtype: subgoal, supporting work
Get a goal relationship — response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Get a goal relationship — response body — data data — sdk__Goal Relationship Response |
Referenced models: Get a goal relationship — response body — data data — sdk__Goal Relationship Response
Update a goal relationship — request body — body / data / resource_subtype: subgoal, supporting work
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Update a goal relationship — request body — body / data / resource_subtype: subgoal, supporting work resource subtype: subgoal, supporting work |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).supported_goal | JSON | Optional | |
$ (allOf 2).supported_goal (allOf 1) | Model | All variants apply | Expand Get parent goals from a goal — response body — data data item |
$ (allOf 2).supported_goal (allOf 2) | object | All variants apply | The goal that the supporting resource supports. Read only: true |
Referenced models: Get parent goals from a goal — response body — data data item, Update a goal relationship — request body — body / data / resource_subtype: subgoal, supporting work resource subtype: subgoal, supporting work
Get a goal relationship — response body — data / data / resource_subtype: subgoal, supporting work
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get goal relationships — response body — data, next page data item |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).supported_goal | JSON | Optional | |
$ (allOf 2).supported_goal (allOf 1) | Model | All variants apply | Expand Get parent goals from a goal — response body — data data item |
$ (allOf 2).supported_goal (allOf 2) | object | All variants apply | The goal that the supporting resource supports. Read only: true |
Referenced models: Get parent goals from a goal — response body — data data item, Get goal relationships — response body — data, next page data item
Get a goal relationship — response body — data data — sdk__Goal Relationship Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. A *goal relationship* is an object representing the relationship between a goal and another goal, a project, a task, or a portfolio. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
resource_subtype | string | Optional | The subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning. Known values: subgoal, supporting_work Read only: true |
supporting_resource | object | Optional | A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. A *project* represents a prioritized list of tasks in Asana or a board with columns of tasks represented as cards. It exists in a single workspace or organization and is accessible to a subset of users in that workspace or organization, depending on its permissions.A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. A *project* represents a prioritized list of tasks in Asana or a board with columns of tasks represented as cards. It exists in a single workspace or organization and is accessible to a subset of users in that workspace or organization, depending on its permissions. The supporting resource that supports the goal. This can be either a project, task, portfolio, or goal. Read only: true |
supporting_resource.gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
supporting_resource.resource_type | string | Optional | The base type of this resource. Read only: true |
supporting_resource.name | string | Optional | Name of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer. |
supporting_resource.resource_subtype | string | Optional | The subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning. Known values: default_project, custom |
contribution_weight | JSON | Optional | |
contribution_weight (anyOf 1) | number | Alternative | The weight that the supporting resource's progress contributes to the supported goal's progress. This can be 0, 1, or any value in between. |
contribution_weight (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
supported_goal | Model | Optional | Expand Get a goal relationship — response body — data data supported goal |
Referenced models: Get a goal relationship — response body — data data supported goal
Get parent goals from a goal — response body — data data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A generic Asana Resource, containing a globally unique identifier. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The name of the goal. |
owner | JSON | Optional | |
owner (anyOf 1) | JSON | Alternative | |
owner (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get users in a team — response body — data data item |
owner (anyOf 1) (allOf 2) | object | All variants apply | |
owner (anyOf 2) | null | Alternative |
Referenced models: Get users in a team — response body — data data item
Update a goal relationship — request body — body / data / resource_subtype: subgoal, supporting work resource subtype: subgoal, supporting work
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *goal relationship* is an object representing the relationship between a goal and another goal, a project, a task, or a portfolio. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
resource_subtype | string | Optional | The subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning. Read only: true One of: subgoal, supporting_work |
supporting_resource | JSON | Optional | |
supporting_resource (allOf 1) | Model | All variants apply | Expand Update a goal relationship — request body — body / data / resource_subtype: subgoal, supporting work resource subtype: subgoal, supporting work supporting resource resource subtype: default project, custom |
supporting_resource (allOf 2) | object | All variants apply | The supporting resource that supports the goal. This can be either a project, task, portfolio, or goal. Read only: true |
contribution_weight | number | Optional | The weight that the supporting resource's progress contributes to the supported goal's progress. This can be 0, 1, or any value in between. |
Get users in a team — response body — data data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | *Read-only except when same user as requester*. The user's name. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: asana.updategoalrelationship. Catalog operation: asana:updateGoalRelationship. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.