POST /goals/{goal_gid}/addSupportingRelationship

Creates a goal relationship by adding a supporting resource to a given goal.

Returns the newly created goal relationship record.

Servers

Path parameters

Name Type Required Description
goal_gid String Yes

Globally unique identifier for the goal.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Query parameters

Name Type Required Description
opt_pretty Boolean No

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[] Array No

This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

Request body fields

Name Type Required Description
data Object No
data.insert_after String No

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.

data.supporting_resource String Yes

The gid of the supporting resource to add to the parent goal. Must be the gid of a goal, project, task, or portfolio.

data.contribution_weight Number No

Defines how much the supporting goal’s progress contributes to the parent goal’s overall progress. When used with automatically calculated Goal Metrics (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.

data.insert_before String No

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.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.