Asana: Goal relationships schemas
13 Asana schemas with complete fields and constraints.
← Goal relationships operations · All schemas
Add a supporting goal relationship — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
supporting_resource | string | Required within parent | The gid of the supporting resource to add to the parent goal. Must be the gid of a goal, project, task, or portfolio. |
insert_before | string | Optional | An id of a subgoal of this parent goal. The new subgoal will be added before the one specified here. `insert_before` and `insert_after` parameters cannot both be specified. Currently only supported when adding a subgoal. |
insert_after | string | Optional | An id of a subgoal of this parent goal. The new subgoal will be added after the one specified here. `insert_before` and `insert_after` parameters cannot both be specified. Currently only supported when adding a subgoal. |
contribution_weight | number | Optional | Defines how much the supporting goal’s progress contributes to the parent goal’s overall progress. When used with automatically calculated [Goal Metrics](/reference/creategoalmetric) (such as `progress_source = subgoal_progress`), this value must be greater than 0 for the subgoal to count toward the parent goal’s progress. Accepts a number between 0 and 1 (inclusive). Defaults to `0`. |
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
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 supported goal
| 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. The goal that the supporting resource supports. Read only: true |
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) | Model | Alternative | Expand Get an OOO entry — response body — data data user |
owner (anyOf 2) | null | Alternative |
Referenced models: Get an OOO entry — response body — data data user
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 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 goal relationships — response body — data, next page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Get a goal relationship — response body — data data — sdk__Goal Relationship Response |
next_page | Model | Optional | Expand Get goals — response body — data, next page next page |
Referenced models: Get goals — response body — data, next page next page, Get a goal relationship — response body — data data — sdk__Goal Relationship Response
Get goal relationships — response body — data, next page data item
| 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. Known values: subgoal, supporting_work Read only: true |
supporting_resource | JSON | Optional | |
supporting_resource (allOf 1) | Model | All variants apply | Expand Search projects in a workspace — response body — data data item |
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 | 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]+)?$ |
Referenced models: Search projects in a workspace — response body — data data item
Removes a supporting goal relationship — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
supporting_resource | string | Required within parent | The gid of the supporting resource to remove from the parent goal. Must be the gid of a goal, project, task, or portfolio. |
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
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. |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. |
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 | 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. |
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. One of: default_project, custom |
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