diff --git a/defs/asana_oas.yaml b/defs/asana_oas.yaml index 05746a0..27a98d4 100644 --- a/defs/asana_oas.yaml +++ b/defs/asana_oas.yaml @@ -3508,7 +3508,6 @@ components: - $ref: '#/components/schemas/GoalMembershipCompact' - $ref: '#/components/schemas/ProjectMembershipCompactResponse' - $ref: '#/components/schemas/PortfolioMembershipCompactResponse' - - $ref: '#/components/schemas/CustomFieldMembershipCompact' ModifyDependenciesRequest: type: object properties: @@ -7764,8 +7763,7 @@ components: description: >- Sets the access level for the member. Goals can have access levels `editor` or `commenter`. Projects can have access levels `admin`, `editor` or `commenter`. - Portfolios can have access levels `admin`, `editor` or `viewer`. Custom - Fields can have access levels `admin`, `editor` or `user`. + Portfolios can have access levels `admin`, `editor` or `viewer`. type: string example: editor CreateMembershipRequest: @@ -7797,7 +7795,6 @@ components: - $ref: '#/components/schemas/GoalMembershipResponse' - $ref: '#/components/schemas/ProjectMembershipCompactResponse' - $ref: '#/components/schemas/PortfolioMembershipResponse' - - $ref: '#/components/schemas/CustomFieldMembershipResponse' UpdateTimeTrackingEntryRequest: type: object properties: @@ -16049,12 +16046,12 @@ paths: get: summary: Get multiple memberships description: >- - Returns compact `goal_membership`, `project_membership`, `portfolio_membership` - or `custom_field_membership` records. The possible types - for `parent` in this request are `goal`, `project`, `portfolio` or `custom - field`. An additional member (user GID or + Returns compact `goal_membership`, `project_membership`, or `portfolio_membership` + records. The possible types + for `parent` in this request are `goal`, `project`, or `portfolio`. An additional + member (user GID or team GID) can be passed in to filter to a specific membership. Teams are not - supported for portfolios or custom fields yet. + supported for portfolios yet. tags: - Memberships operationId: getMemberships @@ -16062,8 +16059,7 @@ paths: - name: parent in: query description: >- - Globally unique identifier for `goal`, `project`, `portfolio` or `custom - field`. + Globally unique identifier for `goal`, `project`, or `portfolio`. schema: type: string example: '159874' diff --git a/defs/asana_sdk_oas.yaml b/defs/asana_sdk_oas.yaml index c544c63..ca2f17f 100644 --- a/defs/asana_sdk_oas.yaml +++ b/defs/asana_sdk_oas.yaml @@ -9182,471 +9182,6 @@ components: example: portfolio_membership x-docs-overrides: &id018 properties.resource_type.example: portfolio_membership - - description: >- - A generic Asana Resource, containing a globally unique identifier.A generic - Asana Resource, containing a globally unique identifier. - - This object describes a user's membership to a custom field including - their level of access (Admin, Editor, or User). - 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 - parent: - description: >- - A generic Asana Resource, containing a globally unique identifier.A - generic Asana Resource, containing a globally unique identifier. - - Custom Fields store the metadata that is used in order to add user-specified - information to tasks in Asana. Be sure to reference the [custom fields](/reference/custom-fields) - developer documentation for more information about how custom fields - relate to various resources in Asana. - - - Users in Asana can [lock custom fields](https://asana.com/guide/help/premium/custom-fields#gl-lock-fields), - which will make them read-only when accessed by other users. Attempting - to edit a locked custom field will return HTTP error code `403 Forbidden`. - 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: The name of the custom field. - type: string - example: Status - resource_subtype: - description: > - The type of the custom field. Must be one of the given values. - type: string - readOnly: true - example: text - enum: - - text - - enum - - multi_enum - - number - - date - - people - type: - description: > - *Deprecated: new integrations should prefer the resource_subtype - field.* The type of the custom field. Must be one of the given - values. - type: string - readOnly: true - enum: - - text - - enum - - multi_enum - - number - - date - - people - enum_options: - description: >- - *Conditional*. Only relevant for custom fields of type `enum`. - This array specifies the possible values which an `enum` custom - field can adopt. To modify the enum options, refer to [working - with enum - options](/reference/createenumoptionforcustomfield). - type: array - items: - description: >- - A generic Asana Resource, containing a globally unique identifier.A - generic Asana Resource, containing a globally unique identifier. - - Enum options are the possible values which an enum custom field - can adopt. An enum custom field must contain at least 1 enum - option but no more than 500. - - - You can add enum options to a custom field by using the `POST - /custom_fields/custom_field_gid/enum_options` endpoint. - - - **It is not possible to remove or delete an enum option**. Instead, - enum options can be disabled by updating the `enabled` field - to false with the `PUT /enum_options/enum_option_gid` endpoint. - Other attributes can be updated similarly. - - - On creation of an enum option, `enabled` is always set to `true`, - meaning the enum option is a selectable value for the custom - field. Setting `enabled=false` is equivalent to “trashing” the - enum option in the Asana web app within the “Edit Fields” dialog. - The enum option will no longer be selectable but, if the enum - option value was previously set within a task, the task will - retain the value. - - - Enum options are an ordered list and by default new enum options - are inserted at the end. Ordering in relation to existing enum - options can be specified on creation by using `insert_before` - or `insert_after` to reference an existing enum option. Only - one of `insert_before` and `insert_after` can be provided when - creating a new enum option. - - - An enum options list can be reordered with the `POST /custom_fields/custom_field_gid/enum_options/insert` - endpoint. - 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: The name of the enum option. - type: string - example: Low - enabled: - description: >- - Whether or not the enum option is a selectable value for - the - custom field. - type: boolean - example: true - color: - description: >- - The color of the enum option. Defaults to ‘none’. - type: string - example: blue - x-docs-overrides: *id004 - enabled: - description: >- - *Conditional*. Determines if the custom field is enabled or not. - type: boolean - readOnly: true - example: true - representation_type: - description: >- - This field tells the type of the custom field. - type: string - example: number - readOnly: true - enum: - - text - - enum - - multi_enum - - number - - date - - people - - formula - - custom_id - id_prefix: - description: >- - This field is the unique custom ID string for the custom field. - type: string - nullable: true - example: ID - is_formula_field: - description: >- - *Conditional*. This flag describes whether a custom field is a - formula custom field. - type: boolean - example: false - date_value: - description: >- - *Conditional*. Only relevant for custom fields of type `date`. - This object reflects the chosen date (and optionally, time) value - of a `date` custom field. If no date is selected, the value of - `date_value` will be `null`. - type: object - nullable: true - properties: - date: - type: string - description: >- - A string representing the date in YYYY-MM-DD format. - example: '2024-08-23' - date_time: - type: string - description: >- - A string representing the date in ISO 8601 format. If no time - value - is selected, the value of `date-time` will be `null`. - example: '2024-08-23T22:00:00.000Z' - enum_value: - description: >- - A generic Asana Resource, containing a globally unique identifier.A - generic Asana Resource, containing a globally unique identifier. - - Enum options are the possible values which an enum custom field - can adopt. An enum custom field must contain at least 1 enum option - but no more than 500. - - - You can add enum options to a custom field by using the `POST - /custom_fields/custom_field_gid/enum_options` endpoint. - - - **It is not possible to remove or delete an enum option**. Instead, - enum options can be disabled by updating the `enabled` field to - false with the `PUT /enum_options/enum_option_gid` endpoint. Other - attributes can be updated similarly. - - - On creation of an enum option, `enabled` is always set to `true`, - meaning the enum option is a selectable value for the custom field. - Setting `enabled=false` is equivalent to “trashing” the enum option - in the Asana web app within the “Edit Fields” dialog. The enum - option will no longer be selectable but, if the enum option value - was previously set within a task, the task will retain the value. - - - Enum options are an ordered list and by default new enum options - are inserted at the end. Ordering in relation to existing enum - options can be specified on creation by using `insert_before` - or `insert_after` to reference an existing enum option. Only one - of `insert_before` and `insert_after` can be provided when creating - a new enum option. - - - An enum options list can be reordered with the `POST /custom_fields/custom_field_gid/enum_options/insert` - endpoint.A generic Asana Resource, containing a globally unique - identifier.A generic Asana Resource, containing a globally unique - identifier. - - Enum options are the possible values which an enum custom field - can adopt. An enum custom field must contain at least 1 enum option - but no more than 500. - - - You can add enum options to a custom field by using the `POST - /custom_fields/custom_field_gid/enum_options` endpoint. - - - **It is not possible to remove or delete an enum option**. Instead, - enum options can be disabled by updating the `enabled` field to - false with the `PUT /enum_options/enum_option_gid` endpoint. Other - attributes can be updated similarly. - - - On creation of an enum option, `enabled` is always set to `true`, - meaning the enum option is a selectable value for the custom field. - Setting `enabled=false` is equivalent to “trashing” the enum option - in the Asana web app within the “Edit Fields” dialog. The enum - option will no longer be selectable but, if the enum option value - was previously set within a task, the task will retain the value. - - - Enum options are an ordered list and by default new enum options - are inserted at the end. Ordering in relation to existing enum - options can be specified on creation by using `insert_before` - or `insert_after` to reference an existing enum option. Only one - of `insert_before` and `insert_after` can be provided when creating - a new enum option. - - - An enum options list can be reordered with the `POST /custom_fields/custom_field_gid/enum_options/insert` - endpoint. - - *Conditional*. Only relevant for custom fields of type `enum`. - This object is the chosen value of an `enum` custom field. - 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: The name of the enum option. - type: string - example: Low - enabled: - description: >- - Whether or not the enum option is a selectable value for the - custom field. - type: boolean - example: true - color: - description: >- - The color of the enum option. Defaults to ‘none’. - type: string - example: blue - x-docs-overrides: *id004 - nullable: true - multi_enum_values: - description: >- - *Conditional*. Only relevant for custom fields of type - `multi_enum`. This object is the chosen values of a `multi_enum` - custom - field. - type: array - items: - description: >- - A generic Asana Resource, containing a globally unique identifier.A - generic Asana Resource, containing a globally unique identifier. - - Enum options are the possible values which an enum custom field - can adopt. An enum custom field must contain at least 1 enum - option but no more than 500. - - - You can add enum options to a custom field by using the `POST - /custom_fields/custom_field_gid/enum_options` endpoint. - - - **It is not possible to remove or delete an enum option**. Instead, - enum options can be disabled by updating the `enabled` field - to false with the `PUT /enum_options/enum_option_gid` endpoint. - Other attributes can be updated similarly. - - - On creation of an enum option, `enabled` is always set to `true`, - meaning the enum option is a selectable value for the custom - field. Setting `enabled=false` is equivalent to “trashing” the - enum option in the Asana web app within the “Edit Fields” dialog. - The enum option will no longer be selectable but, if the enum - option value was previously set within a task, the task will - retain the value. - - - Enum options are an ordered list and by default new enum options - are inserted at the end. Ordering in relation to existing enum - options can be specified on creation by using `insert_before` - or `insert_after` to reference an existing enum option. Only - one of `insert_before` and `insert_after` can be provided when - creating a new enum option. - - - An enum options list can be reordered with the `POST /custom_fields/custom_field_gid/enum_options/insert` - endpoint. - 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: The name of the enum option. - type: string - example: Low - enabled: - description: >- - Whether or not the enum option is a selectable value for - the - custom field. - type: boolean - example: true - color: - description: >- - The color of the enum option. Defaults to ‘none’. - type: string - example: blue - x-docs-overrides: *id004 - number_value: - description: >- - *Conditional*. This number is the value of a `number` custom field. - type: number - nullable: true - example: 5.2 - text_value: - description: >- - *Conditional*. This string is the value of a `text` custom field. - type: string - nullable: true - example: Some Value - display_value: - description: >- - A string representation for the value of the custom field. - Integrations that don't require the underlying type should - use this field to read values. Using this field will future-proof - an app against new custom field types. - type: string - readOnly: true - example: blue - nullable: true - x-docs-overrides: *id005 - member: - description: >- - A generic Asana Resource, containing a globally unique identifier.A - generic Asana Resource, containing a globally unique identifier. - - A *user* object represents an account in Asana that can be given access - to various workspaces, projects, and tasks. - 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 - x-docs-overrides: *id001 - access_level: - description: >- - Whether the member has admin, editor, or user - access to the custom field. - type: string - enum: - - admin - - editor - - user - readOnly: true - example: admin - x-docs-overrides: &id022 - properties.resource_type.example: custom_field_membership ModifyDependenciesRequest: type: object properties: @@ -14464,7 +13999,8 @@ components: - user readOnly: true example: admin - x-docs-overrides: *id022 + x-docs-overrides: &id022 + properties.resource_type.example: custom_field_membership CustomFieldMembershipCompact: description: >- A generic Asana Resource, containing a globally unique identifier.A generic @@ -30841,46 +30377,19 @@ components: example: - due_at - due_on - - dependencies - WorkspaceAddUserRequest: - type: object - description: A user identification object for specification with the addUser/removeUser - endpoints. - properties: - user: - description: >- - A string identifying a user. This can either be the string "me", an email, - or the gid of a user. - type: string - example: '12345' - WorkspaceBase: - description: >- - A generic Asana Resource, containing a globally unique identifier.A generic - Asana Resource, containing a globally unique identifier. - - A *workspace* is the highest-level organizational unit in Asana. All projects - and tasks have an associated workspace. + - dependencies + WorkspaceAddUserRequest: type: object + description: A user identification object for specification with the addUser/removeUser + endpoints. properties: - gid: + user: description: >- - Globally unique identifier of the resource, as a string. + A string identifying a user. This can either be the string "me", an email, + or the gid of a user. 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: The name of the workspace. - type: string - example: My Company Workspace - x-docs-overrides: *id015 - WorkspaceCompact: + WorkspaceBase: description: >- A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. @@ -30907,239 +30416,34 @@ components: type: string example: My Company Workspace x-docs-overrides: *id015 - WorkspaceMembershipBase: - description: >- - A generic Asana Resource, containing a globally unique identifier.A generic - Asana Resource, containing a globally unique identifier. - - This object determines if a user is a member of a workspace. - 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 - user: - description: >- - A generic Asana Resource, containing a globally unique identifier.A generic - Asana Resource, containing a globally unique identifier. - - A *user* object represents an account in Asana that can be given access - to various workspaces, projects, and tasks. - 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 - x-docs-overrides: *id001 - workspace: - description: >- - A generic Asana Resource, containing a globally unique identifier.A generic - Asana Resource, containing a globally unique identifier. - - A *workspace* is the highest-level organizational unit in Asana. All projects - and tasks have an associated workspace. - 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: The name of the workspace. - type: string - example: My Company Workspace - x-docs-overrides: *id015 - x-docs-overrides: &id035 - properties.resource_type.example: workspace_membership - WorkspaceMembershipCompact: - description: >- - A generic Asana Resource, containing a globally unique identifier.A generic - Asana Resource, containing a globally unique identifier. - - This object determines if a user is a member of a workspace. - 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 - user: - description: >- - A generic Asana Resource, containing a globally unique identifier.A generic - Asana Resource, containing a globally unique identifier. - - A *user* object represents an account in Asana that can be given access - to various workspaces, projects, and tasks. - 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 - x-docs-overrides: *id001 - workspace: - description: >- - A generic Asana Resource, containing a globally unique identifier.A generic - Asana Resource, containing a globally unique identifier. - - A *workspace* is the highest-level organizational unit in Asana. All projects - and tasks have an associated workspace. - 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: The name of the workspace. - type: string - example: My Company Workspace - x-docs-overrides: *id015 - x-docs-overrides: *id035 - WorkspaceMembershipRequest: + WorkspaceCompact: description: >- A generic Asana Resource, containing a globally unique identifier.A generic - Asana Resource, containing a globally unique identifier. - - This object determines if a user is a member of a workspace. - 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 - user: - description: >- - A generic Asana Resource, containing a globally unique identifier.A generic - Asana Resource, containing a globally unique identifier. - - A *user* object represents an account in Asana that can be given access - to various workspaces, projects, and tasks. - 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 - x-docs-overrides: *id001 - workspace: - description: >- - A generic Asana Resource, containing a globally unique identifier.A generic - Asana Resource, containing a globally unique identifier. - - A *workspace* is the highest-level organizational unit in Asana. All projects - and tasks have an associated workspace. - 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: The name of the workspace. - type: string - example: My Company Workspace - x-docs-overrides: *id015 - x-docs-overrides: *id035 - WorkspaceMembershipResponse: + Asana Resource, containing a globally unique identifier. + + A *workspace* is the highest-level organizational unit in Asana. All projects + and tasks have an associated workspace. + 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: The name of the workspace. + type: string + example: My Company Workspace + x-docs-overrides: *id015 + WorkspaceMembershipBase: description: >- A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. @@ -31215,232 +30519,14 @@ components: type: string example: My Company Workspace x-docs-overrides: *id015 - user_task_list: - description: >- - A generic Asana Resource, containing a globally unique identifier.A generic - Asana Resource, containing a globally unique identifier. - - A user task list represents the tasks assigned to a particular user. It - provides API access to a user’s [My Tasks](https://asana.com/guide/help/fundamentals/my-tasks) - view in Asana. - 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: The name of the user task list. - type: string - example: My Tasks in My Workspace - owner: - description: >- - The owner of the user task list, i.e. the person whose My - Tasks is represented by this resource. - readOnly: true - allOf: - - description: >- - A generic Asana Resource, containing a globally unique identifier.A - generic Asana Resource, containing a globally unique identifier. - - A *user* object represents an account in Asana that can be given - access to various workspaces, projects, and tasks. - 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 - x-docs-overrides: *id001 - workspace: - description: The workspace in which the user task list is located. - readOnly: true - allOf: - - description: >- - A generic Asana Resource, containing a globally unique identifier.A - generic Asana Resource, containing a globally unique identifier. - - A *workspace* is the highest-level organizational unit in Asana. - All projects and tasks have an associated workspace. - 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: The name of the workspace. - type: string - example: My Company Workspace - x-docs-overrides: *id015 - x-docs-overrides: *id033 - readOnly: true - is_active: - type: boolean - readOnly: true - description: >- - Reflects if this user still a member of the workspace. - is_admin: - type: boolean - readOnly: true - description: >- - Reflects if this user is an admin of the workspace. - is_guest: - type: boolean - readOnly: true - description: >- - Reflects if this user is a guest of the workspace. - is_view_only: - type: boolean - readOnly: true - description: >- - Reflects if this user has view only license in the workspace. - vacation_dates: - type: object - readOnly: true - nullable: true - description: >- - Contains keys `start_on` and `end_on` for the vacation dates for the user - in this workspace. - If `start_on` is null, the entire `vacation_dates` object will be null. - If `end_on` is before today, the entire `vacation_dates` object will be - null. - properties: - start_on: - description: The day on which the user's vacation in this workspace - starts. This is a date with `YYYY-MM-DD` format. - type: string - example: '2022-11-05' - end_on: - description: The day on which the user's vacation in this workspace - ends, or null if there is no end date. This is a date with `YYYY-MM-DD` - format. - nullable: true - type: string - example: '2022-11-07' - created_at: - description: The time at which this resource was created. - type: string - format: date-time - readOnly: true - example: '2012-02-22T02:06:58.147Z' - x-docs-overrides: *id035 - WorkspaceRemoveUserRequest: - type: object - description: A user identification object for specification with the addUser/removeUser - endpoints. - properties: - user: - description: >- - A string identifying a user. This can either be the string "me", an email, - or the gid of a user. - type: string - example: '12345' - WorkspaceRequest: - description: >- - A generic Asana Resource, containing a globally unique identifier.A generic - Asana Resource, containing a globally unique identifier. - - A *workspace* is the highest-level organizational unit in Asana. All projects - and tasks have an associated workspace. - 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: The name of the workspace. - type: string - example: My Company Workspace - x-docs-overrides: *id015 - WorkspaceResponse: - description: >- - A generic Asana Resource, containing a globally unique identifier.A generic - Asana Resource, containing a globally unique identifier. - - A *workspace* is the highest-level organizational unit in Asana. All projects - and tasks have an associated workspace. - 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: The name of the workspace. - type: string - example: My Company Workspace - email_domains: - description: The email domains that are associated with this workspace. - type: array - items: - type: string - format: uri - example: - - asana.com - is_organization: - description: Whether the workspace is an *organization*. - type: boolean - example: false - x-docs-overrides: *id015 - GoalMembershipBase: + x-docs-overrides: &id035 + properties.resource_type.example: workspace_membership + WorkspaceMembershipCompact: description: >- A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. - This object represents a user's connection to a goal. + This object determines if a user is a member of a workspace. type: object properties: gid: @@ -31450,42 +30536,19 @@ components: readOnly: true example: '12345' x-insert-after: false - resource_type: - description: The base type of this resource. - type: string - example: membership - resource_subtype: + resource_type: + description: The base type of this resource. type: string readOnly: true - description: The type of membership. - example: goal_membership - member: + example: task + x-insert-after: gid + user: description: >- A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. - A *member* object represents either a team or user. - 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: - type: string - description: The type of the member (team or user) - example: user - name: - type: string - description: The name of the member - example: Greg Sanchez - x-docs-overrides: *id014 - parent: - description: >- - A generic Asana Resource, containing a globally unique identifier. + A *user* object represents an account in Asana that can be given access + to various workspaces, projects, and tasks. type: object properties: gid: @@ -31503,64 +30566,17 @@ components: x-insert-after: gid name: type: string - description: The name of the goal. - example: Grow web traffic by 30% - owner: description: >- - A generic Asana Resource, containing a globally unique identifier.A - generic Asana Resource, containing a globally unique identifier. - - A *user* object represents an account in Asana that can be given access - to various workspaces, projects, and tasks. - 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 - x-docs-overrides: *id001 - nullable: true - x-docs-overrides: *id009 - readOnly: true - role: - type: string - description: >- - *Deprecated: Describes if the member is a commenter or editor in goal.* - enum: - - commenter - - editor - deprecated: true - example: editor - access_level: - type: string - description: Describes if member is commenter or editor in goal. This is - preferred over role - enum: - - commenter - - editor - example: editor - goal: + *Read-only except when same user as requester*. The user’s name. + example: Greg Sanchez + x-docs-overrides: *id001 + workspace: description: >- A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. - *Deprecated: new integrations should prefer the `parent` field.* A *Goal* - is an object in the goal-tracking system that helps your organization - drive measurable results. + A *workspace* is the highest-level organizational unit in Asana. All projects + and tasks have an associated workspace. type: object properties: gid: @@ -31577,48 +30593,17 @@ components: example: task x-insert-after: gid name: + description: The name of the workspace. type: string - description: The name of the goal. - example: Grow web traffic by 30% - owner: - description: >- - A generic Asana Resource, containing a globally unique identifier.A - generic Asana Resource, containing a globally unique identifier. - - A *user* object represents an account in Asana that can be given access - to various workspaces, projects, and tasks. - 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 - x-docs-overrides: *id001 - nullable: true - x-docs-overrides: *id009 - readOnly: true - deprecated: true - x-docs-overrides: *id036 - GoalMembershipCompact: + example: My Company Workspace + x-docs-overrides: *id015 + x-docs-overrides: *id035 + WorkspaceMembershipRequest: description: >- A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. - This object represents a user's connection to a goal. + This object determines if a user is a member of a workspace. type: object properties: gid: @@ -31630,19 +30615,17 @@ components: x-insert-after: false resource_type: description: The base type of this resource. - type: string - example: membership - resource_subtype: type: string readOnly: true - description: The type of membership. - example: goal_membership - member: + example: task + x-insert-after: gid + user: description: >- A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. - A *member* object represents either a team or user. + A *user* object represents an account in Asana that can be given access + to various workspaces, projects, and tasks. type: object properties: gid: @@ -31653,17 +30636,24 @@ components: example: '12345' x-insert-after: false resource_type: + description: The base type of this resource. type: string - description: The type of the member (team or user) - example: user + readOnly: true + example: task + x-insert-after: gid name: type: string - description: The name of the member + description: >- + *Read-only except when same user as requester*. The user’s name. example: Greg Sanchez - x-docs-overrides: *id014 - parent: + x-docs-overrides: *id001 + workspace: description: >- - A generic Asana Resource, containing a globally unique identifier. + A generic Asana Resource, containing a globally unique identifier.A generic + Asana Resource, containing a globally unique identifier. + + A *workspace* is the highest-level organizational unit in Asana. All projects + and tasks have an associated workspace. type: object properties: gid: @@ -31680,65 +30670,67 @@ components: example: task x-insert-after: gid name: + description: The name of the workspace. type: string - description: The name of the goal. - example: Grow web traffic by 30% - owner: - description: >- - A generic Asana Resource, containing a globally unique identifier.A - generic Asana Resource, containing a globally unique identifier. + example: My Company Workspace + x-docs-overrides: *id015 + x-docs-overrides: *id035 + WorkspaceMembershipResponse: + description: >- + A generic Asana Resource, containing a globally unique identifier.A generic + Asana Resource, containing a globally unique identifier. - A *user* object represents an account in Asana that can be given access - to various workspaces, projects, and tasks. - 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 - x-docs-overrides: *id001 - nullable: true - x-docs-overrides: *id009 + This object determines if a user is a member of a workspace. + type: object + properties: + gid: + description: >- + Globally unique identifier of the resource, as a string. + type: string readOnly: true - role: + 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 + user: description: >- - *Deprecated: Describes if the member is a commenter or editor in goal.* - enum: - - commenter - - editor - deprecated: true - example: editor - access_level: - type: string - description: Describes if member is commenter or editor in goal. This is - preferred over role - enum: - - commenter - - editor - example: editor - goal: + A generic Asana Resource, containing a globally unique identifier.A generic + Asana Resource, containing a globally unique identifier. + + A *user* object represents an account in Asana that can be given access + to various workspaces, projects, and tasks. + 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 + x-docs-overrides: *id001 + workspace: description: >- A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. - *Deprecated: new integrations should prefer the `parent` field.* A *Goal* - is an object in the goal-tracking system that helps your organization - drive measurable results. + A *workspace* is the highest-level organizational unit in Asana. All projects + and tasks have an associated workspace. type: object properties: gid: @@ -31755,59 +30747,231 @@ components: example: task x-insert-after: gid name: + description: The name of the workspace. type: string - description: The name of the goal. - example: Grow web traffic by 30% + example: My Company Workspace + x-docs-overrides: *id015 + user_task_list: + description: >- + A generic Asana Resource, containing a globally unique identifier.A generic + Asana Resource, containing a globally unique identifier. + + A user task list represents the tasks assigned to a particular user. It + provides API access to a user’s [My Tasks](https://asana.com/guide/help/fundamentals/my-tasks) + view in Asana. + 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: The name of the user task list. + type: string + example: My Tasks in My Workspace owner: description: >- - A generic Asana Resource, containing a globally unique identifier.A - generic Asana Resource, containing a globally unique identifier. + The owner of the user task list, i.e. the person whose My + Tasks is represented by this resource. + readOnly: true + allOf: + - description: >- + A generic Asana Resource, containing a globally unique identifier.A + generic Asana Resource, containing a globally unique identifier. - A *user* object represents an account in Asana that can be given access - to various workspaces, projects, and tasks. - 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 - x-docs-overrides: *id001 - nullable: true - x-docs-overrides: *id009 + A *user* object represents an account in Asana that can be given + access to various workspaces, projects, and tasks. + 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 + x-docs-overrides: *id001 + workspace: + description: The workspace in which the user task list is located. + readOnly: true + allOf: + - description: >- + A generic Asana Resource, containing a globally unique identifier.A + generic Asana Resource, containing a globally unique identifier. + + A *workspace* is the highest-level organizational unit in Asana. + All projects and tasks have an associated workspace. + 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: The name of the workspace. + type: string + example: My Company Workspace + x-docs-overrides: *id015 + x-docs-overrides: *id033 readOnly: true - deprecated: true - is_commenter: + is_active: type: boolean - deprecated: true readOnly: true description: >- - *Deprecated: new integrations should prefer the `role` field.* - Describes if the member is comment only in goal. - example: false - is_editor: + Reflects if this user still a member of the workspace. + is_admin: + type: boolean + readOnly: true + description: >- + Reflects if this user is an admin of the workspace. + is_guest: + type: boolean + readOnly: true + description: >- + Reflects if this user is a guest of the workspace. + is_view_only: + type: boolean + readOnly: true + description: >- + Reflects if this user has view only license in the workspace. + vacation_dates: + type: object + readOnly: true + nullable: true + description: >- + Contains keys `start_on` and `end_on` for the vacation dates for the user + in this workspace. + If `start_on` is null, the entire `vacation_dates` object will be null. + If `end_on` is before today, the entire `vacation_dates` object will be + null. + properties: + start_on: + description: The day on which the user's vacation in this workspace + starts. This is a date with `YYYY-MM-DD` format. + type: string + example: '2022-11-05' + end_on: + description: The day on which the user's vacation in this workspace + ends, or null if there is no end date. This is a date with `YYYY-MM-DD` + format. + nullable: true + type: string + example: '2022-11-07' + created_at: + description: The time at which this resource was created. + type: string + format: date-time + readOnly: true + example: '2012-02-22T02:06:58.147Z' + x-docs-overrides: *id035 + WorkspaceRemoveUserRequest: + type: object + description: A user identification object for specification with the addUser/removeUser + endpoints. + properties: + user: + description: >- + A string identifying a user. This can either be the string "me", an email, + or the gid of a user. + type: string + example: '12345' + WorkspaceRequest: + description: >- + A generic Asana Resource, containing a globally unique identifier.A generic + Asana Resource, containing a globally unique identifier. + + A *workspace* is the highest-level organizational unit in Asana. All projects + and tasks have an associated workspace. + 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: The name of the workspace. + type: string + example: My Company Workspace + x-docs-overrides: *id015 + WorkspaceResponse: + description: >- + A generic Asana Resource, containing a globally unique identifier.A generic + Asana Resource, containing a globally unique identifier. + + A *workspace* is the highest-level organizational unit in Asana. All projects + and tasks have an associated workspace. + 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: The name of the workspace. + type: string + example: My Company Workspace + email_domains: + description: The email domains that are associated with this workspace. + type: array + items: + type: string + format: uri + example: + - asana.com + is_organization: + description: Whether the workspace is an *organization*. type: boolean - deprecated: true - readOnly: true - description: >- - *Deprecated: new integrations should prefer the `role` field.* - Describes if the member is editor in goal. example: false - x-docs-overrides: *id036 - GoalMembershipResponse: + x-docs-overrides: *id015 + GoalMembershipBase: description: >- A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. @@ -31984,22 +31148,37 @@ components: x-docs-overrides: *id009 readOnly: true deprecated: true - user: + x-docs-overrides: *id036 + GoalMembershipCompact: + description: >- + A generic Asana Resource, containing a globally unique identifier.A generic + Asana Resource, containing a globally unique identifier. + + This object represents a user's connection to a 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 + example: membership + resource_subtype: + type: string + readOnly: true + description: The type of membership. + example: goal_membership + member: description: >- A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. - A *user* object represents an account in Asana that can be given access - to various workspaces, projects, and tasks.A generic Asana Resource, containing - a globally unique identifier.A generic Asana Resource, containing a globally - unique identifier. - - A *user* object represents an account in Asana that can be given access - to various workspaces, projects, and tasks. - - *Deprecated: new integrations should prefer the `member` field.* A *user* - object represents an account in Asana that can be given access to various - workspaces, projects, and tasks. + A *member* object represents either a team or user. type: object properties: gid: @@ -32010,34 +31189,17 @@ components: 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 + description: The type of the member (team or user) + example: user name: type: string - description: >- - *Read-only except when same user as requester*. The user’s name. + description: The name of the member example: Greg Sanchez - x-docs-overrides: *id001 - deprecated: true - readOnly: true - workspace: + x-docs-overrides: *id014 + parent: description: >- - A generic Asana Resource, containing a globally unique identifier.A generic - Asana Resource, containing a globally unique identifier. - - A *workspace* is the highest-level organizational unit in Asana. All projects - and tasks have an associated workspace.A generic Asana Resource, containing - a globally unique identifier.A generic Asana Resource, containing a globally - unique identifier. - - A *workspace* is the highest-level organizational unit in Asana. All projects - and tasks have an associated workspace. - - *Deprecated:* A *workspace* is the highest-level organizational unit in - Asana. All projects and tasks have an associated workspace. + A generic Asana Resource, containing a globally unique identifier. type: object properties: gid: @@ -32054,192 +31216,16 @@ components: example: task x-insert-after: gid name: - description: The name of the workspace. - type: string - example: My Company Workspace - x-docs-overrides: *id015 - deprecated: true - readOnly: true - x-docs-overrides: *id036 - MembershipUpdateRequest: - type: object - properties: - access_level: - description: The role given to the member. Goals can have access levels - `editor` or `commenter`. Projects can have access levels `admin`, `editor` - or `commenter`. Portfolios can have access levels `admin`, `editor` or - `viewer`. - type: string - example: editor - MembershipRequest: - type: object - properties: - access_level: - description: >- - Sets the access level for the member. Goals can have access levels `editor` - or `commenter`. Projects can have access levels `admin`, `editor` or `commenter`. - Portfolios can have access levels `admin`, `editor` or `viewer`. Custom - Fields can have access levels `admin`, `editor` or `user`. - type: string - example: editor - CreateMembershipRequest: - type: object - properties: - access_level: - description: >- - Sets the access level for the member. Goals can have access levels `editor` - or `commenter`. Projects can have access levels `admin`, `editor` or `commenter`. - Portfolios can have access levels `admin`, `editor` or `viewer`. Custom - Fields can have access levels `admin`, `editor` or `user`. - type: string - example: editor - member: - description: The gid of the user or team. - type: string - example: 12345 - parent: - description: The gid of the `goal`, `project`, or `portfolio` to add the - member to. - type: string - example: '987654' - role: - description: >- - *Deprecated: new integrations should use access_level* The role given - to the member. Optional argument, will default to `commenter` for goals - and the default project role for projects. - Can be `editor` or `commenter` for goals. Can be `admin`,`editor` or `commenter` - for projects. - type: string - deprecated: true - example: editor - MembershipResponse: - anyOf: - - description: >- - A generic Asana Resource, containing a globally unique identifier.A generic - Asana Resource, containing a globally unique identifier. - - This object represents a user's connection to a 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 - example: membership - resource_subtype: - type: string - readOnly: true - description: The type of membership. - example: goal_membership - member: - description: >- - A generic Asana Resource, containing a globally unique identifier.A - generic Asana Resource, containing a globally unique identifier. - - A *member* object represents either a team or user. - 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: - type: string - description: The type of the member (team or user) - example: user - name: - type: string - description: The name of the member - example: Greg Sanchez - x-docs-overrides: *id014 - parent: - description: >- - A generic Asana Resource, containing a globally unique identifier. - 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: - description: >- - A generic Asana Resource, containing a globally unique identifier.A - generic Asana Resource, containing a globally unique identifier. - - A *user* object represents an account in Asana that can be given - access to various workspaces, projects, and tasks. - 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 - x-docs-overrides: *id001 - nullable: true - x-docs-overrides: *id009 - readOnly: true - role: - type: string - description: >- - *Deprecated: Describes if the member is a commenter or editor in goal.* - enum: - - commenter - - editor - deprecated: true - example: editor - access_level: type: string - description: Describes if member is commenter or editor in goal. This - is preferred over role - enum: - - commenter - - editor - example: editor - goal: + description: The name of the goal. + example: Grow web traffic by 30% + owner: description: >- A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. - *Deprecated: new integrations should prefer the `parent` field.* A - *Goal* is an object in the goal-tracking system that helps your organization - drive measurable results. + A *user* object represents an account in Asana that can be given access + to various workspaces, projects, and tasks. type: object properties: gid: @@ -32257,56 +31243,63 @@ components: x-insert-after: gid name: type: string - description: The name of the goal. - example: Grow web traffic by 30% - owner: description: >- - A generic Asana Resource, containing a globally unique identifier.A - generic Asana Resource, containing a globally unique identifier. + *Read-only except when same user as requester*. The user’s name. + example: Greg Sanchez + x-docs-overrides: *id001 + nullable: true + x-docs-overrides: *id009 + readOnly: true + role: + type: string + description: >- + *Deprecated: Describes if the member is a commenter or editor in goal.* + enum: + - commenter + - editor + deprecated: true + example: editor + access_level: + type: string + description: Describes if member is commenter or editor in goal. This is + preferred over role + enum: + - commenter + - editor + example: editor + goal: + description: >- + A generic Asana Resource, containing a globally unique identifier.A generic + Asana Resource, containing a globally unique identifier. - A *user* object represents an account in Asana that can be given - access to various workspaces, projects, and tasks. - 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 - x-docs-overrides: *id001 - nullable: true - x-docs-overrides: *id009 + *Deprecated: new integrations should prefer the `parent` field.* A *Goal* + is an object in the goal-tracking system that helps your organization + drive measurable results. + type: object + properties: + gid: + description: >- + Globally unique identifier of the resource, as a string. + type: string readOnly: true - deprecated: true - user: + 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: description: >- A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. A *user* object represents an account in Asana that can be given access - to various workspaces, projects, and tasks.A generic Asana Resource, - containing a globally unique identifier.A generic Asana Resource, - containing a globally unique identifier. - - A *user* object represents an account in Asana that can be given access - to various workspaces, projects, and tasks. - - *Deprecated: new integrations should prefer the `member` field.* A - *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks. type: object properties: @@ -32329,23 +31322,104 @@ components: *Read-only except when same user as requester*. The user’s name. example: Greg Sanchez x-docs-overrides: *id001 - deprecated: true + nullable: true + x-docs-overrides: *id009 + readOnly: true + deprecated: true + is_commenter: + type: boolean + deprecated: true + readOnly: true + description: >- + *Deprecated: new integrations should prefer the `role` field.* + Describes if the member is comment only in goal. + example: false + is_editor: + type: boolean + deprecated: true + readOnly: true + description: >- + *Deprecated: new integrations should prefer the `role` field.* + Describes if the member is editor in goal. + example: false + x-docs-overrides: *id036 + GoalMembershipResponse: + description: >- + A generic Asana Resource, containing a globally unique identifier.A generic + Asana Resource, containing a globally unique identifier. + + This object represents a user's connection to a 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 + example: membership + resource_subtype: + type: string + readOnly: true + description: The type of membership. + example: goal_membership + member: + description: >- + A generic Asana Resource, containing a globally unique identifier.A generic + Asana Resource, containing a globally unique identifier. + + A *member* object represents either a team or user. + type: object + properties: + gid: + description: >- + Globally unique identifier of the resource, as a string. + type: string readOnly: true - workspace: + example: '12345' + x-insert-after: false + resource_type: + type: string + description: The type of the member (team or user) + example: user + name: + type: string + description: The name of the member + example: Greg Sanchez + x-docs-overrides: *id014 + parent: + description: >- + A generic Asana Resource, containing a globally unique identifier. + 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: description: >- A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. - A *workspace* is the highest-level organizational unit in Asana. All - projects and tasks have an associated workspace.A generic Asana Resource, - containing a globally unique identifier.A generic Asana Resource, - containing a globally unique identifier. - - A *workspace* is the highest-level organizational unit in Asana. All - projects and tasks have an associated workspace. - - *Deprecated:* A *workspace* is the highest-level organizational unit - in Asana. All projects and tasks have an associated workspace. + A *user* object represents an account in Asana that can be given access + to various workspaces, projects, and tasks. type: object properties: gid: @@ -32362,19 +31436,39 @@ components: example: task x-insert-after: gid name: - description: The name of the workspace. type: string - example: My Company Workspace - x-docs-overrides: *id015 - deprecated: true - readOnly: true - x-docs-overrides: *id036 - - description: >- + description: >- + *Read-only except when same user as requester*. The user’s name. + example: Greg Sanchez + x-docs-overrides: *id001 + nullable: true + x-docs-overrides: *id009 + readOnly: true + role: + type: string + description: >- + *Deprecated: Describes if the member is a commenter or editor in goal.* + enum: + - commenter + - editor + deprecated: true + example: editor + access_level: + type: string + description: Describes if member is commenter or editor in goal. This is + preferred over role + enum: + - commenter + - editor + example: editor + goal: + description: >- A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. - This object describes a team or a user's membership to a project including - their level of access (Admin, Editor, Commenter, or Viewer). + *Deprecated: new integrations should prefer the `parent` field.* A *Goal* + is an object in the goal-tracking system that helps your organization + drive measurable results. type: object properties: gid: @@ -32387,16 +31481,20 @@ components: resource_type: description: The base type of this resource. type: string - example: membership - parent: + readOnly: true + example: task + x-insert-after: gid + name: + type: string + description: The name of the goal. + example: Grow web traffic by 30% + owner: description: >- 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 *user* object represents an account in Asana that can be given access + to various workspaces, projects, and tasks. type: object properties: gid: @@ -32413,60 +31511,69 @@ components: 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 - x-docs-overrides: *id007 - member: - description: >- - A generic Asana Resource, containing a globally unique identifier.A - generic Asana Resource, containing a globally unique identifier. - - A *member* object represents either a team or user. - 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: - type: string - description: The type of the member (team or user) - example: user - name: - type: string - description: The name of the member + *Read-only except when same user as requester*. The user’s name. example: Greg Sanchez - x-docs-overrides: *id014 - access_level: + x-docs-overrides: *id001 + nullable: true + x-docs-overrides: *id009 + readOnly: true + deprecated: true + user: + description: >- + A generic Asana Resource, containing a globally unique identifier.A generic + Asana Resource, containing a globally unique identifier. + + A *user* object represents an account in Asana that can be given access + to various workspaces, projects, and tasks.A generic Asana Resource, containing + a globally unique identifier.A generic Asana Resource, containing a globally + unique identifier. + + A *user* object represents an account in Asana that can be given access + to various workspaces, projects, and tasks. + + *Deprecated: new integrations should prefer the `member` field.* A *user* + object represents an account in Asana that can be given access to various + workspaces, projects, and tasks. + type: object + properties: + gid: description: >- - Whether the member has admin, editor, commenter, or viewer - access to the project. + Globally unique identifier of the resource, as a string. type: string - enum: - - admin - - editor - - commenter - - viewer readOnly: true - example: admin - resource_subtype: - description: Type of the membership. + example: '12345' + x-insert-after: false + resource_type: + description: The base type of this resource. type: string - example: project_membership - x-docs-overrides: *id023 - - description: >- + 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 + x-docs-overrides: *id001 + deprecated: true + readOnly: true + workspace: + description: >- A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. - This object determines if a user is a member of a portfolio. + A *workspace* is the highest-level organizational unit in Asana. All projects + and tasks have an associated workspace.A generic Asana Resource, containing + a globally unique identifier.A generic Asana Resource, containing a globally + unique identifier. + + A *workspace* is the highest-level organizational unit in Asana. All projects + and tasks have an associated workspace. + + *Deprecated:* A *workspace* is the highest-level organizational unit in + Asana. All projects and tasks have an associated workspace. type: object properties: gid: @@ -32482,18 +31589,94 @@ components: readOnly: true example: task x-insert-after: gid - parent: + name: + description: The name of the workspace. + type: string + example: My Company Workspace + x-docs-overrides: *id015 + deprecated: true + readOnly: true + x-docs-overrides: *id036 + MembershipUpdateRequest: + type: object + properties: + access_level: + description: The role given to the member. Goals can have access levels + `editor` or `commenter`. Projects can have access levels `admin`, `editor` + or `commenter`. Portfolios can have access levels `admin`, `editor` or + `viewer`. + type: string + example: editor + MembershipRequest: + type: object + properties: + access_level: + description: >- + Sets the access level for the member. Goals can have access levels `editor` + or `commenter`. Projects can have access levels `admin`, `editor` or `commenter`. + Portfolios can have access levels `admin`, `editor` or `viewer`. + type: string + example: editor + CreateMembershipRequest: + type: object + properties: + access_level: + description: >- + Sets the access level for the member. Goals can have access levels `editor` + or `commenter`. Projects can have access levels `admin`, `editor` or `commenter`. + Portfolios can have access levels `admin`, `editor` or `viewer`. + type: string + example: editor + member: + description: The gid of the user or team. + type: string + example: 12345 + parent: + description: The gid of the `goal`, `project`, or `portfolio` to add the + member to. + type: string + example: '987654' + role: + description: >- + *Deprecated: new integrations should use access_level* The role given + to the member. Optional argument, will default to `commenter` for goals + and the default project role for projects. + Can be `editor` or `commenter` for goals. Can be `admin`,`editor` or `commenter` + for projects. + type: string + deprecated: true + example: editor + MembershipResponse: + anyOf: + - description: >- + A generic Asana Resource, containing a globally unique identifier.A generic + Asana Resource, containing a globally unique identifier. + + This object represents a user's connection to a 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 + example: membership + resource_subtype: + type: string + readOnly: true + description: The type of membership. + example: goal_membership + member: description: >- A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. - A *portfolio* gives a high-level overview of the status of multiple - initiatives in Asana. Portfolios provide a dashboard overview of the - state of multiple projects, including a progress report and the most - recent [project status](/reference/project-statuses) update. - - Portfolios have some restrictions on size. Each portfolio has a max - of 1500 items and, like projects, a max of 20 custom fields. + A *member* object represents either a team or user. type: object properties: gid: @@ -32504,23 +31687,17 @@ components: 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 + description: The type of the member (team or user) + example: user name: - description: The name of the portfolio. type: string - example: Bug Portfolio - x-docs-overrides: *id017 - member: + description: The name of the member + example: Greg Sanchez + x-docs-overrides: *id014 + parent: description: >- - A generic Asana Resource, containing a globally unique identifier.A - generic Asana Resource, containing a globally unique identifier. - - A *user* object represents an account in Asana that can be given access - to various workspaces, projects, and tasks. + A generic Asana Resource, containing a globally unique identifier. type: object properties: gid: @@ -32538,58 +31715,65 @@ components: x-insert-after: gid name: type: string + description: The name of the goal. + example: Grow web traffic by 30% + owner: description: >- - *Read-only except when same user as requester*. The user’s name. - example: Greg Sanchez - x-docs-overrides: *id001 - access_level: + A generic Asana Resource, containing a globally unique identifier.A + generic Asana Resource, containing a globally unique identifier. + + A *user* object represents an account in Asana that can be given + access to various workspaces, projects, and tasks. + 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 + x-docs-overrides: *id001 + nullable: true + x-docs-overrides: *id009 + readOnly: true + role: + type: string description: >- - Whether the member has admin, editor, or viewer - access to the portfolio. Portfolios do not support commenter access - yet. + *Deprecated: Describes if the member is a commenter or editor in goal.* + enum: + - commenter + - editor + deprecated: true + example: editor + access_level: type: string + description: Describes if member is commenter or editor in goal. This + is preferred over role enum: - - admin + - commenter - editor - - viewer - readOnly: true - example: admin - x-docs-overrides: *id018 - - description: >- - A generic Asana Resource, containing a globally unique identifier.A generic - Asana Resource, containing a globally unique identifier. - - This object describes a user's membership to a custom field including - their level of access (Admin, Editor, or User). - 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 - parent: + example: editor + goal: description: >- A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. - Custom Fields store the metadata that is used in order to add user-specified - information to tasks in Asana. Be sure to reference the [custom fields](/reference/custom-fields) - developer documentation for more information about how custom fields - relate to various resources in Asana. - - - Users in Asana can [lock custom fields](https://asana.com/guide/help/premium/custom-fields#gl-lock-fields), - which will make them read-only when accessed by other users. Attempting - to edit a locked custom field will return HTTP error code `403 Forbidden`. + *Deprecated: new integrations should prefer the `parent` field.* A + *Goal* is an object in the goal-tracking system that helps your organization + drive measurable results. type: object properties: gid: @@ -32606,246 +31790,16 @@ components: example: task x-insert-after: gid name: - description: The name of the custom field. - type: string - example: Status - resource_subtype: - description: > - The type of the custom field. Must be one of the given values. - type: string - readOnly: true - example: text - enum: - - text - - enum - - multi_enum - - number - - date - - people - type: - description: > - *Deprecated: new integrations should prefer the resource_subtype - field.* The type of the custom field. Must be one of the given - values. - type: string - readOnly: true - enum: - - text - - enum - - multi_enum - - number - - date - - people - enum_options: - description: >- - *Conditional*. Only relevant for custom fields of type `enum`. - This array specifies the possible values which an `enum` custom - field can adopt. To modify the enum options, refer to [working - with enum - options](/reference/createenumoptionforcustomfield). - type: array - items: - description: >- - A generic Asana Resource, containing a globally unique identifier.A - generic Asana Resource, containing a globally unique identifier. - - Enum options are the possible values which an enum custom field - can adopt. An enum custom field must contain at least 1 enum - option but no more than 500. - - - You can add enum options to a custom field by using the `POST - /custom_fields/custom_field_gid/enum_options` endpoint. - - - **It is not possible to remove or delete an enum option**. Instead, - enum options can be disabled by updating the `enabled` field - to false with the `PUT /enum_options/enum_option_gid` endpoint. - Other attributes can be updated similarly. - - - On creation of an enum option, `enabled` is always set to `true`, - meaning the enum option is a selectable value for the custom - field. Setting `enabled=false` is equivalent to “trashing” the - enum option in the Asana web app within the “Edit Fields” dialog. - The enum option will no longer be selectable but, if the enum - option value was previously set within a task, the task will - retain the value. - - - Enum options are an ordered list and by default new enum options - are inserted at the end. Ordering in relation to existing enum - options can be specified on creation by using `insert_before` - or `insert_after` to reference an existing enum option. Only - one of `insert_before` and `insert_after` can be provided when - creating a new enum option. - - - An enum options list can be reordered with the `POST /custom_fields/custom_field_gid/enum_options/insert` - endpoint. - 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: The name of the enum option. - type: string - example: Low - enabled: - description: >- - Whether or not the enum option is a selectable value for - the - custom field. - type: boolean - example: true - color: - description: >- - The color of the enum option. Defaults to ‘none’. - type: string - example: blue - x-docs-overrides: *id004 - enabled: - description: >- - *Conditional*. Determines if the custom field is enabled or not. - type: boolean - readOnly: true - example: true - representation_type: - description: >- - This field tells the type of the custom field. - type: string - example: number - readOnly: true - enum: - - text - - enum - - multi_enum - - number - - date - - people - - formula - - custom_id - id_prefix: - description: >- - This field is the unique custom ID string for the custom field. type: string - nullable: true - example: ID - is_formula_field: - description: >- - *Conditional*. This flag describes whether a custom field is a - formula custom field. - type: boolean - example: false - date_value: - description: >- - *Conditional*. Only relevant for custom fields of type `date`. - This object reflects the chosen date (and optionally, time) value - of a `date` custom field. If no date is selected, the value of - `date_value` will be `null`. - type: object - nullable: true - properties: - date: - type: string - description: >- - A string representing the date in YYYY-MM-DD format. - example: '2024-08-23' - date_time: - type: string - description: >- - A string representing the date in ISO 8601 format. If no time - value - is selected, the value of `date-time` will be `null`. - example: '2024-08-23T22:00:00.000Z' - enum_value: + description: The name of the goal. + example: Grow web traffic by 30% + owner: description: >- A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. - Enum options are the possible values which an enum custom field - can adopt. An enum custom field must contain at least 1 enum option - but no more than 500. - - - You can add enum options to a custom field by using the `POST - /custom_fields/custom_field_gid/enum_options` endpoint. - - - **It is not possible to remove or delete an enum option**. Instead, - enum options can be disabled by updating the `enabled` field to - false with the `PUT /enum_options/enum_option_gid` endpoint. Other - attributes can be updated similarly. - - - On creation of an enum option, `enabled` is always set to `true`, - meaning the enum option is a selectable value for the custom field. - Setting `enabled=false` is equivalent to “trashing” the enum option - in the Asana web app within the “Edit Fields” dialog. The enum - option will no longer be selectable but, if the enum option value - was previously set within a task, the task will retain the value. - - - Enum options are an ordered list and by default new enum options - are inserted at the end. Ordering in relation to existing enum - options can be specified on creation by using `insert_before` - or `insert_after` to reference an existing enum option. Only one - of `insert_before` and `insert_after` can be provided when creating - a new enum option. - - - An enum options list can be reordered with the `POST /custom_fields/custom_field_gid/enum_options/insert` - endpoint.A generic Asana Resource, containing a globally unique - identifier.A generic Asana Resource, containing a globally unique - identifier. - - Enum options are the possible values which an enum custom field - can adopt. An enum custom field must contain at least 1 enum option - but no more than 500. - - - You can add enum options to a custom field by using the `POST - /custom_fields/custom_field_gid/enum_options` endpoint. - - - **It is not possible to remove or delete an enum option**. Instead, - enum options can be disabled by updating the `enabled` field to - false with the `PUT /enum_options/enum_option_gid` endpoint. Other - attributes can be updated similarly. - - - On creation of an enum option, `enabled` is always set to `true`, - meaning the enum option is a selectable value for the custom field. - Setting `enabled=false` is equivalent to “trashing” the enum option - in the Asana web app within the “Edit Fields” dialog. The enum - option will no longer be selectable but, if the enum option value - was previously set within a task, the task will retain the value. - - - Enum options are an ordered list and by default new enum options - are inserted at the end. Ordering in relation to existing enum - options can be specified on creation by using `insert_before` - or `insert_after` to reference an existing enum option. Only one - of `insert_before` and `insert_after` can be provided when creating - a new enum option. - - - An enum options list can be reordered with the `POST /custom_fields/custom_field_gid/enum_options/insert` - endpoint. - - *Conditional*. Only relevant for custom fields of type `enum`. - This object is the chosen value of an `enum` custom field. + A *user* object represents an account in Asana that can be given + access to various workspaces, projects, and tasks. type: object properties: gid: @@ -32862,123 +31816,238 @@ components: example: task x-insert-after: gid name: - description: The name of the enum option. type: string - example: Low - enabled: - description: >- - Whether or not the enum option is a selectable value for the - custom field. - type: boolean - example: true - color: description: >- - The color of the enum option. Defaults to ‘none’. - type: string - example: blue - x-docs-overrides: *id004 + *Read-only except when same user as requester*. The user’s + name. + example: Greg Sanchez + x-docs-overrides: *id001 nullable: true - multi_enum_values: + x-docs-overrides: *id009 + readOnly: true + deprecated: true + user: + description: >- + A generic Asana Resource, containing a globally unique identifier.A + generic Asana Resource, containing a globally unique identifier. + + A *user* object represents an account in Asana that can be given access + to various workspaces, projects, and tasks.A generic Asana Resource, + containing a globally unique identifier.A generic Asana Resource, + containing a globally unique identifier. + + A *user* object represents an account in Asana that can be given access + to various workspaces, projects, and tasks. + + *Deprecated: new integrations should prefer the `member` field.* A + *user* object represents an account in Asana that can be given access + to various workspaces, projects, and tasks. + 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: >- - *Conditional*. Only relevant for custom fields of type - `multi_enum`. This object is the chosen values of a `multi_enum` - custom - field. - type: array - items: - description: >- - A generic Asana Resource, containing a globally unique identifier.A - generic Asana Resource, containing a globally unique identifier. - - Enum options are the possible values which an enum custom field - can adopt. An enum custom field must contain at least 1 enum - option but no more than 500. - + *Read-only except when same user as requester*. The user’s name. + example: Greg Sanchez + x-docs-overrides: *id001 + deprecated: true + readOnly: true + workspace: + description: >- + A generic Asana Resource, containing a globally unique identifier.A + generic Asana Resource, containing a globally unique identifier. - You can add enum options to a custom field by using the `POST - /custom_fields/custom_field_gid/enum_options` endpoint. + A *workspace* is the highest-level organizational unit in Asana. All + projects and tasks have an associated workspace.A generic Asana Resource, + containing a globally unique identifier.A generic Asana Resource, + containing a globally unique identifier. + A *workspace* is the highest-level organizational unit in Asana. All + projects and tasks have an associated workspace. - **It is not possible to remove or delete an enum option**. Instead, - enum options can be disabled by updating the `enabled` field - to false with the `PUT /enum_options/enum_option_gid` endpoint. - Other attributes can be updated similarly. + *Deprecated:* A *workspace* is the highest-level organizational unit + in Asana. All projects and tasks have an associated workspace. + 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: The name of the workspace. + type: string + example: My Company Workspace + x-docs-overrides: *id015 + deprecated: true + readOnly: true + x-docs-overrides: *id036 + - description: >- + A generic Asana Resource, containing a globally unique identifier.A generic + Asana Resource, containing a globally unique identifier. + This object describes a team or a user's membership to a project including + their level of access (Admin, Editor, Commenter, or Viewer). + 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 + example: membership + parent: + description: >- + A generic Asana Resource, containing a globally unique identifier.A + generic Asana Resource, containing a globally unique identifier. - On creation of an enum option, `enabled` is always set to `true`, - meaning the enum option is a selectable value for the custom - field. Setting `enabled=false` is equivalent to “trashing” the - enum option in the Asana web app within the “Edit Fields” dialog. - The enum option will no longer be selectable but, if the enum - option value was previously set within a task, the task will - retain the value. + 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. + 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 + x-docs-overrides: *id007 + member: + description: >- + A generic Asana Resource, containing a globally unique identifier.A + generic Asana Resource, containing a globally unique identifier. + A *member* object represents either a team or user. + 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: + type: string + description: The type of the member (team or user) + example: user + name: + type: string + description: The name of the member + example: Greg Sanchez + x-docs-overrides: *id014 + access_level: + description: >- + Whether the member has admin, editor, commenter, or viewer + access to the project. + type: string + enum: + - admin + - editor + - commenter + - viewer + readOnly: true + example: admin + resource_subtype: + description: Type of the membership. + type: string + example: project_membership + x-docs-overrides: *id023 + - description: >- + A generic Asana Resource, containing a globally unique identifier.A generic + Asana Resource, containing a globally unique identifier. - Enum options are an ordered list and by default new enum options - are inserted at the end. Ordering in relation to existing enum - options can be specified on creation by using `insert_before` - or `insert_after` to reference an existing enum option. Only - one of `insert_before` and `insert_after` can be provided when - creating a new enum option. + This object determines if a user is a member of a portfolio. + 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 + parent: + description: >- + A generic Asana Resource, containing a globally unique identifier.A + generic Asana Resource, containing a globally unique identifier. + A *portfolio* gives a high-level overview of the status of multiple + initiatives in Asana. Portfolios provide a dashboard overview of the + state of multiple projects, including a progress report and the most + recent [project status](/reference/project-statuses) update. - An enum options list can be reordered with the `POST /custom_fields/custom_field_gid/enum_options/insert` - endpoint. - 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: The name of the enum option. - type: string - example: Low - enabled: - description: >- - Whether or not the enum option is a selectable value for - the - custom field. - type: boolean - example: true - color: - description: >- - The color of the enum option. Defaults to ‘none’. - type: string - example: blue - x-docs-overrides: *id004 - number_value: - description: >- - *Conditional*. This number is the value of a `number` custom field. - type: number - nullable: true - example: 5.2 - text_value: + Portfolios have some restrictions on size. Each portfolio has a max + of 1500 items and, like projects, a max of 20 custom fields. + type: object + properties: + gid: description: >- - *Conditional*. This string is the value of a `text` custom field. + Globally unique identifier of the resource, as a string. type: string - nullable: true - example: Some Value - display_value: - description: >- - A string representation for the value of the custom field. - Integrations that don't require the underlying type should - use this field to read values. Using this field will future-proof - an app against new custom field types. + readOnly: true + example: '12345' + x-insert-after: false + resource_type: + description: The base type of this resource. type: string readOnly: true - example: blue - nullable: true - x-docs-overrides: *id005 + example: task + x-insert-after: gid + name: + description: The name of the portfolio. + type: string + example: Bug Portfolio + x-docs-overrides: *id017 member: description: >- A generic Asana Resource, containing a globally unique identifier.A @@ -33009,16 +32078,17 @@ components: x-docs-overrides: *id001 access_level: description: >- - Whether the member has admin, editor, or user - access to the custom field. + Whether the member has admin, editor, or viewer + access to the portfolio. Portfolios do not support commenter access + yet. type: string enum: - admin - editor - - user + - viewer readOnly: true example: admin - x-docs-overrides: *id022 + x-docs-overrides: *id018 UpdateTimeTrackingEntryRequest: type: object properties: @@ -37369,12 +36439,12 @@ paths: get: summary: Get multiple memberships description: >- - Returns compact `goal_membership`, `project_membership`, `portfolio_membership` - or `custom_field_membership` records. The possible types - for `parent` in this request are `goal`, `project`, `portfolio` or `custom - field`. An additional member (user GID or + Returns compact `goal_membership`, `project_membership`, or `portfolio_membership` + records. The possible types + for `parent` in this request are `goal`, `project`, or `portfolio`. An additional + member (user GID or team GID) can be passed in to filter to a specific membership. Teams are not - supported for portfolios or custom fields yet. + supported for portfolios yet. tags: - Memberships operationId: getMemberships @@ -37382,8 +36452,7 @@ paths: - name: parent in: query description: >- - Globally unique identifier for `goal`, `project`, `portfolio` or `custom - field`. + Globally unique identifier for `goal`, `project`, or `portfolio`. schema: type: string example: '159874'