Back to AsanaAdd A Supporting Goal Relationship
Creates a goal relationship by adding a supporting resource to a given goal.
Returns the newly created goal relationship record.
Input
type: object
properties:
parameters:
type: object
properties:
goal_gid:
type: string
description: Globally unique identifier for the goal.
opt_pretty:
type: boolean
description: >-
Provides “pretty” output.
Provides the response in a “pretty” format. In the case of JSON this
means doing proper line breaking and indentation to make it readable.
This will take extra time and increase the response size so it is
advisable only to use this during debugging.
opt_fields:
type: array
items:
type: string
description: >-
Defines fields to return.
Some requests return *compact* representations of objects in order to
conserve resources and complete the request more efficiently. Other
times requests return more information than you may need. This option
allows you to list the exact set of fields that the API should be sure
to return for the objects. The field names should be provided as
paths, described below.
The id of included objects will always be returned, regardless of the
field options.
required:
- goal_gid
title: Parameters
data:
type: object
properties:
data:
type: object
properties:
supporting_resource:
description: >-
The gid of the supporting resource to add to the parent goal. Must
be the gid of a goal, project, or portfolio.
type: string
example: '12345'
insert_before:
description: >-
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.
type: string
example: '1331'
insert_after:
description: >-
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.
type: string
example: '1331'
contribution_weight:
description: >-
The weight that the supporting resource's progress will contribute
to the supported goal's progress. This can only be 0 or 1.
type: number
example: 1
title: Data
Output
type: object
properties:
data:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
resource_subtype:
description: >-
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.
type: string
readOnly: true
example: subgoal
enum:
- subgoal
- supporting_work
supporting_resource:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
description: >-
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.
type: string
example: Stuff to buy
contribution_weight:
description: >-
The weight that the supporting resource's progress contributes to the
supported goal's progress. This can only be 0 or 1.
type: number
example: 1
supported_goal:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
type: string
description: The name of the goal.
example: Grow web traffic by 30%
owner:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
type: string
description: >-
*Read-only except when same user as requester*. The user’s
name.
example: Greg Sanchez