Skip to content

Commit 1adbbbe

Browse files
asana-push-openapi-spec[bot]asana-push-openapi-spec[bot]
committed
Automated build docs: 2025-11-25 22:22:40
1 parent ca027fb commit 1adbbbe

3 files changed

Lines changed: 7066 additions & 2355 deletions

File tree

‎defs/asana_oas.yaml‎

Lines changed: 289 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3897,6 +3897,26 @@ components:
38973897
*Note* you can only write to this property if `metric` is set.
38983898
example: green
38993899
nullable: true
3900+
custom_fields:
3901+
description: >-
3902+
An object where each key is the GID of a custom field and its corresponding
3903+
value is
3904+
either an enum GID, string, number, or object (depending on the custom
3905+
field type).
3906+
See the [custom fields guide](/docs/custom-fields-guide) for details
3907+
on creating and
3908+
updating custom field values.
3909+
type: object
3910+
additionalProperties:
3911+
type: string
3912+
description: >-
3913+
"{custom_field_gid}" => Value (can be text, enum GID, a number,
3914+
etc.).
3915+
For date, use format "YYYY-MM-DD" (e.g., 2019-09-15).
3916+
For date-time, use ISO 8601 date string in UTC (e.g., 2019-09-15T02:06:58.147Z).
3917+
example:
3918+
'5678904321': On Hold
3919+
'4578152156': Not Started
39003920
GoalResponse:
39013921
allOf:
39023922
- $ref: '#/components/schemas/GoalBase'
@@ -3977,6 +3997,18 @@ components:
39773997
*Note* you can only write to this property if `metric` is set.
39783998
example: green
39793999
nullable: true
4000+
custom_fields:
4001+
description: Array of Custom Fields.
4002+
type: array
4003+
items:
4004+
$ref: '#/components/schemas/CustomFieldCompact'
4005+
custom_field_settings:
4006+
description: "<p><strong style={{ color: \"#4573D2\" }}>Full object
4007+
requires scope: </strong><code>custom_fields:read</code></p>\n\nArray
4008+
of Custom Field Settings applied to the goal."
4009+
type: array
4010+
items:
4011+
$ref: '#/components/schemas/CustomFieldSettingResponse'
39804012
GoalRelationshipBase:
39814013
allOf:
39824014
- $ref: '#/components/schemas/GoalRelationshipCompact'
@@ -12575,6 +12607,171 @@ paths:
1257512607

1257612608
result = client.custom_field_settings.get_custom_field_settings_for_portfolio(portfolio_gid:
1257712609
'portfolio_gid', param: "value", param: "value", options: {pretty: true})
12610+
/goals/{goal_gid}/custom_field_settings:
12611+
parameters:
12612+
- $ref: '#/components/parameters/goal_path_gid'
12613+
- $ref: '#/components/parameters/pretty'
12614+
- $ref: '#/components/parameters/limit'
12615+
- $ref: '#/components/parameters/offset'
12616+
get:
12617+
summary: Get a goal's custom fields
12618+
description: >-
12619+
Returns a list of all of the custom fields settings on a goal, in
12620+
compact form. Note that, as in all queries to collections which return
12621+
compact representation, `opt_fields` can be used to
12622+
include more data than is returned in the compact representation. See the
12623+
[documentation for input/output
12624+
options](https://developers.asana.com/docs/inputoutput-options)
12625+
for more information.
12626+
tags:
12627+
- Custom field settings
12628+
operationId: getCustomFieldSettingsForGoal
12629+
parameters:
12630+
- name: opt_fields
12631+
in: query
12632+
description: This endpoint returns a resource which excludes some properties
12633+
by default. To include those optional properties, set this query parameter
12634+
to a comma-separated list of the properties you wish to include.
12635+
required: false
12636+
example:
12637+
- custom_field
12638+
- custom_field.asana_created_field
12639+
- custom_field.created_by
12640+
- custom_field.created_by.name
12641+
- custom_field.currency_code
12642+
- custom_field.custom_label
12643+
- custom_field.custom_label_position
12644+
- custom_field.date_value
12645+
- custom_field.date_value.date
12646+
- custom_field.date_value.date_time
12647+
- custom_field.default_access_level
12648+
- custom_field.description
12649+
- custom_field.display_value
12650+
- custom_field.enabled
12651+
- custom_field.enum_options
12652+
- custom_field.enum_options.color
12653+
- custom_field.enum_options.enabled
12654+
- custom_field.enum_options.name
12655+
- custom_field.enum_value
12656+
- custom_field.enum_value.color
12657+
- custom_field.enum_value.enabled
12658+
- custom_field.enum_value.name
12659+
- custom_field.format
12660+
- custom_field.has_notifications_enabled
12661+
- custom_field.id_prefix
12662+
- custom_field.input_restrictions
12663+
- custom_field.is_formula_field
12664+
- custom_field.is_global_to_workspace
12665+
- custom_field.is_value_read_only
12666+
- custom_field.multi_enum_values
12667+
- custom_field.multi_enum_values.color
12668+
- custom_field.multi_enum_values.enabled
12669+
- custom_field.multi_enum_values.name
12670+
- custom_field.name
12671+
- custom_field.number_value
12672+
- custom_field.people_value
12673+
- custom_field.people_value.name
12674+
- custom_field.precision
12675+
- custom_field.privacy_setting
12676+
- custom_field.reference_value
12677+
- custom_field.reference_value.name
12678+
- custom_field.representation_type
12679+
- custom_field.resource_subtype
12680+
- custom_field.text_value
12681+
- custom_field.type
12682+
- is_important
12683+
- offset
12684+
- parent
12685+
- parent.name
12686+
- path
12687+
- project
12688+
- project.name
12689+
- uri
12690+
schema:
12691+
type: array
12692+
items:
12693+
type: string
12694+
enum:
12695+
- custom_field
12696+
- custom_field.asana_created_field
12697+
- custom_field.created_by
12698+
- custom_field.created_by.name
12699+
- custom_field.currency_code
12700+
- custom_field.custom_label
12701+
- custom_field.custom_label_position
12702+
- custom_field.date_value
12703+
- custom_field.date_value.date
12704+
- custom_field.date_value.date_time
12705+
- custom_field.default_access_level
12706+
- custom_field.description
12707+
- custom_field.display_value
12708+
- custom_field.enabled
12709+
- custom_field.enum_options
12710+
- custom_field.enum_options.color
12711+
- custom_field.enum_options.enabled
12712+
- custom_field.enum_options.name
12713+
- custom_field.enum_value
12714+
- custom_field.enum_value.color
12715+
- custom_field.enum_value.enabled
12716+
- custom_field.enum_value.name
12717+
- custom_field.format
12718+
- custom_field.has_notifications_enabled
12719+
- custom_field.id_prefix
12720+
- custom_field.input_restrictions
12721+
- custom_field.is_formula_field
12722+
- custom_field.is_global_to_workspace
12723+
- custom_field.is_value_read_only
12724+
- custom_field.multi_enum_values
12725+
- custom_field.multi_enum_values.color
12726+
- custom_field.multi_enum_values.enabled
12727+
- custom_field.multi_enum_values.name
12728+
- custom_field.name
12729+
- custom_field.number_value
12730+
- custom_field.people_value
12731+
- custom_field.people_value.name
12732+
- custom_field.precision
12733+
- custom_field.privacy_setting
12734+
- custom_field.reference_value
12735+
- custom_field.reference_value.name
12736+
- custom_field.representation_type
12737+
- custom_field.resource_subtype
12738+
- custom_field.text_value
12739+
- custom_field.type
12740+
- is_important
12741+
- offset
12742+
- parent
12743+
- parent.name
12744+
- path
12745+
- project
12746+
- project.name
12747+
- uri
12748+
style: form
12749+
explode: false
12750+
responses:
12751+
200:
12752+
description: >-
12753+
Successfully retrieved custom field settings objects for a goal.
12754+
content:
12755+
application/json:
12756+
schema:
12757+
type: object
12758+
properties:
12759+
data:
12760+
type: array
12761+
items:
12762+
$ref: '#/components/schemas/CustomFieldSettingResponse'
12763+
next_page:
12764+
$ref: '#/components/schemas/NextPage'
12765+
400:
12766+
$ref: '#/components/responses/BadRequest'
12767+
401:
12768+
$ref: '#/components/responses/Unauthorized'
12769+
403:
12770+
$ref: '#/components/responses/Forbidden'
12771+
404:
12772+
$ref: '#/components/responses/NotFound'
12773+
500:
12774+
$ref: '#/components/responses/InternalServerError'
1257812775
/teams/{team_gid}/custom_field_settings:
1257912776
parameters:
1258012777
- $ref: '#/components/parameters/team_path_gid'
@@ -20091,6 +20288,98 @@ paths:
2009120288

2009220289
result = client.goals.get_parent_goals_for_goal(goal_gid: 'goal_gid',
2009320290
param: "value", param: "value", options: {pretty: true})
20291+
/goals/{goal_gid}/addCustomFieldSetting:
20292+
parameters:
20293+
- $ref: '#/components/parameters/goal_path_gid'
20294+
- $ref: '#/components/parameters/pretty'
20295+
post:
20296+
summary: Add a custom field to a goal
20297+
description: |-
20298+
<b>Required scope: </b><code>goals:write</code>
20299+
20300+
Custom fields are associated with goals by way of custom field settings. This method creates a setting for the goal.
20301+
tags:
20302+
- Goals
20303+
operationId: addCustomFieldSettingForGoal
20304+
security:
20305+
- oauth2:
20306+
- goals:write
20307+
requestBody:
20308+
description: Information about the custom field setting.
20309+
required: true
20310+
content:
20311+
application/json:
20312+
schema:
20313+
type: object
20314+
properties:
20315+
data:
20316+
$ref: '#/components/schemas/AddCustomFieldSettingRequest'
20317+
responses:
20318+
200:
20319+
description: Successfully added the custom field to the goal.
20320+
content:
20321+
application/json:
20322+
schema:
20323+
type: object
20324+
properties:
20325+
data:
20326+
$ref: '#/components/schemas/CustomFieldSettingResponse'
20327+
400:
20328+
$ref: '#/components/responses/BadRequest'
20329+
401:
20330+
$ref: '#/components/responses/Unauthorized'
20331+
403:
20332+
$ref: '#/components/responses/Forbidden'
20333+
404:
20334+
$ref: '#/components/responses/NotFound'
20335+
500:
20336+
$ref: '#/components/responses/InternalServerError'
20337+
/goals/{goal_gid}/removeCustomFieldSetting:
20338+
parameters:
20339+
- $ref: '#/components/parameters/goal_path_gid'
20340+
- $ref: '#/components/parameters/pretty'
20341+
post:
20342+
summary: Remove a custom field from a goal
20343+
description: |-
20344+
<b>Required scope: </b><code>goals:write</code>
20345+
20346+
Removes a custom field setting from a goal.
20347+
tags:
20348+
- Goals
20349+
operationId: removeCustomFieldSettingForGoal
20350+
security:
20351+
- oauth2:
20352+
- goals:write
20353+
requestBody:
20354+
description: Information about the custom field setting being removed.
20355+
required: true
20356+
content:
20357+
application/json:
20358+
schema:
20359+
type: object
20360+
properties:
20361+
data:
20362+
$ref: '#/components/schemas/RemoveCustomFieldSettingRequest'
20363+
responses:
20364+
200:
20365+
description: Successfully removed the custom field from the goal.
20366+
content:
20367+
application/json:
20368+
schema:
20369+
type: object
20370+
properties:
20371+
data:
20372+
$ref: '#/components/schemas/EmptyResponse'
20373+
400:
20374+
$ref: '#/components/responses/BadRequest'
20375+
401:
20376+
$ref: '#/components/responses/Unauthorized'
20377+
403:
20378+
$ref: '#/components/responses/Forbidden'
20379+
404:
20380+
$ref: '#/components/responses/NotFound'
20381+
500:
20382+
$ref: '#/components/responses/InternalServerError'
2009420383
/jobs/{job_gid}:
2009520384
parameters:
2009620385
- $ref: '#/components/parameters/job_path_gid'

0 commit comments

Comments
 (0)