openapi: 3.0.0 info: description: >- This is the interface for interacting with the [Asana Platform](https://developers.asana.com). Our API reference is generated from our [OpenAPI spec] (https://raw.githubusercontent.com/Asana/openapi/master/defs/asana_oas.yaml). x-public-description: >- This is the interface for interacting with the [Asana Platform](https://developers.asana.com). Our API reference is generated from our [OpenAPI spec] (https://raw.githubusercontent.com/Asana/openapi/master/defs/asana_oas.yaml). title: Asana termsOfService: https://asana.com/terms contact: name: Asana Support url: https://asana.com/support license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 version: '1.0' x-docs-schema-whitelist: - AsanaResource - AsanaNamedResource - AuditLogEvent - AttachmentResponse - AttachmentCompact - BatchResponse - CustomFieldSettingResponse - CustomFieldSettingCompact - CustomFieldResponse - CustomFieldCompact - EnumOption - EventResponse - ErrorResponse - GoalResponse - GoalCompact - GoalMembershipCompact - GoalMembershipBase - GoalMembershipResponse - GoalRelationshipResponse - GoalRelationshipCompact - JobResponse - JobCompact - OrganizationExportResponse - OrganizationExportCompact - PortfolioMembershipResponse - PortfolioMembershipCompact - PortfolioResponse - PortfolioCompact - ProjectBriefResponse - ProjectBriefCompact - ProjectMembershipCompactResponse - ProjectMembershipNormalResponse - ProjectMembershipCompact - ProjectResponse - ProjectCompact - ProjectStatusResponse - ProjectStatusCompact - ProjectTemplateCompact - ProjectTemplateResponse - RuleTriggerResponse - SectionResponse - SectionCompact - StatusUpdateResponse - StatusUpdateCompact - StoryResponse - StoryCompact - TagResponse - TagCompact - TaskResponse - TaskCompact - TaskCountResponse - TeamMembershipResponse - TeamMembershipCompact - TeamResponse - TeamCompact - TimePeriodResponse - TimePeriodCompact - UserTaskListResponse - UserTaskListCompact - UserResponse - UserCompact - WebhookFilter - WebhookResponse - WebhookCompact - WorkspaceMembershipResponse - WorkspaceMembershipCompact - WorkspaceResponse - WorkspaceCompact servers: - url: https://app.asana.com/api/1.0 description: Main endpoint. security: - personalAccessToken: [] - oauth2: [] x-readme: proxy-enabled: false tags: - name: Attachments description: >- An *attachment* object represents any file attached to a task in Asana, whether it’s an uploaded file or one associated via a third-party service such as Dropbox or Google Drive. - name: Audit log API description: >- Asana's audit log is an immutable log of [important events](/docs/audit-log-events#supported-audit-log-events) in your organization's Asana instance. The audit log API allows you to monitor and act upon important security and compliance-related changes. Organizations might use this API endpoint to: * Set up proactive alerting with a Security Information and Event Management (SIEM) tool like [Splunk](https://asana.com/guide/help/api/splunk) * Conduct reactive investigations when a security incident takes place * Visualize key domain data in aggregate to identify security trends Note that since the API provides insight into what is happening in an Asana instance, the data is [read-only](/reference/getauditlogevents). That is, there are no "write" or "update" endpoints for audit log events. Only [Service Accounts](https://asana.com/guide/help/premium/service-accounts) in [Enterprise Domains](https://asana.com/enterprise) can access audit log API endpoints. Authentication with a Service Account's [personal access token](/docs/personal-access-token) is required. For a full list of supported events, see [supported AuditLogEvents](/docs/audit-log-events#supported-audit-log-events). - name: Batch API description: >- There are many cases where you want to accomplish a variety of work in the Asana API but want to minimize the number of HTTP requests you make. For example: * Modern browsers limit the number of requests that a single web page can make at once. * Mobile apps will use more battery life to keep the cellular radio on when making a series of requests. * There is an overhead cost to developing software that can make multiple requests in parallel. * Some cloud platforms handle parallelism poorly, or disallow it entirely. To make development easier in these use cases, Asana provides a **batch API** that enables developers to perform multiple “actions” by making only a single HTTP request. #### Making a batch request To make a batch request, send a `POST` request to `/batch`. Like other `POST` endpoints, the body should contain a `data` envelope. Inside this envelope should be a single `actions` field, containing a list of “action” objects. Each action represents a standard request to an existing endpoint in the Asana API. **The maximum number of actions allowed in a single batch request is 10**. Making a batch request with no actions in it will result in a `400 Bad Request`. When the batch API receives the list of actions to execute, it will dispatch those actions to the already-implemented endpoints specified by the `relative_path` and `method` for each action. This happens in parallel, so all actions in the request will be processed simultaneously. There is no guarantee of the execution order for these actions, nor is there a way to use the output of one action as the input of another action (such as creating a task and then commenting on it). The response to the batch request will contain (within the `data` envelope) a list of result objects, one for each action. The results are guaranteed to be in the same order as the actions in the request (e.g., the first result in the response corresponds to the first action in the request) The batch API will always attempt to return a `200 Success` response with individual result objects for each individual action in the request. Only in certain cases (such as missing authorization or malformed JSON in the body) will the entire request fail with another status code. Even if every individual action in the request fails, the batch API will still return a `200 Success` response, and each result object in the response will contain the errors encountered with each action. #### Rate limiting The batch API fully respects all of our rate limiting. This means that a batch request counts against *both* the standard rate limiter and the concurrent request limiter as though you had made a separate HTTP request for every individual action. For example, a batch request with five actions counts as five separate requests in the standard rate limiter, and counts as five concurrent requests in the concurrent request limiter. The batch request itself incurs no cost. If any of the actions in a batch request would exceed any of the enforced limits, the *entire* request will fail with a `429 Too Many Requests` error. This is to prevent the unpredictability of which actions might succeed if not all of them could succeed. #### Restrictions Not every endpoint can be accessed through the batch API. Specifically, the following actions cannot be taken and will result in a `400 Bad Request` for that action: * Uploading attachments * Creating, getting, or deleting organization exports * Any SCIM operations * Nested calls to the batch API - name: Custom fields description: >- _Note: Custom fields are a premium feature. Integrations which work with custom fields need to handle an assortment of use cases for free and premium users in context of free and premium organizations. For a detailed examination of which data users will have access in different circumstances, review the section below on access control._ In the Asana application, tasks, projects, and portfolios can hold user-specified [custom fields](https://asana.com/guide/help/premium/custom-fields) which provide extra information (e.g., a "priority" property with an associated value, or a number representing the time required to complete a task). This lets a user define the type of information that each item within a project or portfolio can contain in addition to the built-in fields that Asana provides. `display_value` is a read-only field that will always be a string. For apps that use custom fields, this is a great way to safely display/export the value of a custom field, regardless of its type. We suggest apps use this field in order to future-proof for changes to custom fields. #### Characteristics of custom fields * There is metadata that defines the custom field. This metadata can be shared across an entire workspace, or be specific to a project or portfolio. * Creating a custom field setting on a project or portfolio means each direct child will have the custom field. This is conceptually akin to adding columns in a database or a spreadsheet: every task (row) in the project (table) can contain information for that field, including "blank" values (i.e., `null` data). For portfolio custom fields, every project (row) in the portfolio (table) will contain information for the custom field. * Custom field settings only go one child deep. This means that a custom field setting on a portfolio will give each project the custom field, but not each task within those projects. * Tasks have custom field _values_ assigned to them. #### Types of custom fields Integrations using custom fields need to be aware of the six basic types that a custom field can adopt. These types are: * `text` - an arbitrary, relatively short string of text * `number` - a number with a defined level of precision * `enum` - a selection of a single option from a defined list of options (i.e., mutually exclusive selections) * `multi_enum` - a selection of one or more options from a defined list of options (i.e., mutually inclusive selections) * `date` - a reference date with an optional time value * `people` - a list of active contributors (i.e., where their relationship to the work is defined in the custom field title) #### Example use case Consider an organization that has defined a custom field for "Priority". This field is of `enum` type and can have user-defined values of `Low`, `Medium`, or `High`. This is the field metadata, and it is visible within, and shared across, the entire organization. A project is then created in the organization, called "Bugs", and the "Priority" custom field is associated with that project. This will allow all tasks within the "Bugs" project to have an associated "Priority". A new task is created within "Bugs". This task, then, has a field named "Priority" which can take on the custom field value of one of `[null]`, `Low`, `Medium`, and `High`. #### Custom fields in the API These custom fields are accessible via the API through a number of endpoints at the top level (e.g. `/custom_fields` and `/custom_field_settings`) and through requests on workspaces, portfolios, projects, and tasks resources. The API also provides a way to fetch both the metadata and data which define each particular custom field, so that a client application may render proper UI to display or edit the values. Text fields are currently limited to 1024 characters. On tasks, their custom field value will have a `text_value` property to represent this field. Number fields can have an arbitrary `precision` associated with them; for example, a precision of `2` would round its value to the second (hundredths) place (e.g., `1.2345` would round to `1.23`). On tasks, the custom field value will have a `number_value` property to represent this field. #### Enum fields Enum fields represent a selection from a list of options. On the metadata, they will contain all of the options in an array. Each option has 4 properties: * `gid` - the GID of this enum option. Note that this is the GID of the individual _option_. The custom field itself has a separate `gid`. * `name` - the name of the option (e.g., "Choice #1") * `enabled` - whether this field is enabled. Disabled fields are not available to choose from when disabled, and are visually hidden in the Asana application, but they remain in the metadata for custom field values which were set to the option before the option was disabled. * `color` - a color associated with this choice. On the task's custom field value, the enum will have an `enum_value` property which will be the same as one of the choices from the list defined in the custom field metadata. #### Querying an organization for its custom fields For custom fields shared across the workspace or organization, the workspace [can be queried](/reference/getcustomfieldsforworkspace) for its list of defined custom fields. Like other collection queries, the fields will be returned as a compact record; slightly different from most other compact records is the fact that the compact record for custom fields includes `type` as well as `gid` and `name`. #### Accessing custom field definitions The [custom fields](/reference/getcustomfield) reference describes how the metadata which defines a custom field is accessed. A GET request with a `gid` can be issued on the `/custom_fields` endpoint to fetch the full definition of a single custom field given its `gid` from (for instance) listing all custom fields on a workspace, or getting the `gid` from a custom field settings object or a task. #### Associating custom fields with a project or portfolio A mapping between a custom field and a project or portfolio is handled with a [custom field settings](/reference/custom-field-settings) object. This object contains a reference for each of the custom fields and the project or portfolio, as well as additional information about the status of that particular custom field (e.g., `is_important`, which defines whether or not the custom field will appear in the list/grid on the Asana application). #### Accessing custom field values on tasks or projects The [tasks](/reference/gettask) reference has information on how custom fields look on tasks. custom fields will return as an array on the property `custom_fields`, and each entry will contain, side-by-side, the compact representation of the custom field metadata and a `{typename}_value` property that stores the value set for the custom field. Of particular note is that the top-level `gid` of each entry in the `custom_fields` array is the `gid` of the custom field metadata, as it is the compact representation of this metadata. This can be used to refer to the full metadata by making a request to the `/custom_fields/{custom_fields_id}` endpoint as described above. Custom fields can be set just as in the Asana-defined fields on a task via `POST` or `PUT` requests. You can see an example in the [update a task](/reference/updatetask) endpoint. Custom fields on projects follow this same pattern. #### Warning: Program defensively with regards to custom field definitions Asana application users have the ability to change the definitions of custom field metadata. This means that as you write scripts or applications to work with them, it is possible for the definitions to change at any time, which may cause an application using them to break or malfunction if it makes assumptions about the metadata for a particular custom field. When using custom fields, it is a good idea to program *defensively*, meaning you your application should double-check that the custom field metadata are what it expects. Storing the state of the custom field metadata for too long if you dynamically create a model for it can cause your model to become out of sync with the model stored in Asana. For example, if you encounter an `enum` value on a task that does not match any option in your metadata model, your metadata model has become out of date with the custom field metadata. #### Enabled and disabled values When information that is contained in a custom field value loses a logical association with its metadata definition, the value becomes disabled. This can happen in a couple of simple ways, for example, if you remove the custom field metadata from a project, or move a task with a custom field to a different project which does not have the custom field metadata associated with it. The value remains on the task, and the custom field metadata can still be found and examined, but as the context in which the custom field makes sense is gone, the custom field cannot change its value; it can only be cleared. _Note: Tasks that are associated with multiple projects do not become disabled, so long as at least one of the projects is still associated with the custom field metadata. In other words, tasks with multiple projects will retain logically associated to the set of custom field metadata represented by all of their projects._ Moving the task back under a project with that custom field applied to it or applying the custom field metadata to the current project will return the custom field value to an enabled state. In this scenario, the custom field will be re-enabled and editable again. In the Asana application, disabled fields are grayed out and not allowed to change, other than to be discarded. In the API, we return a property `enabled: false` to inform the external application that the value has been disabled. Note that the API enforces the same operations on disabled custom field values as hold in the Asana application: they may not have their values changed, since the lack of context for the values of a custom field in general doesn't provide enough information to know what new values should be. Setting the custom field value to `null` will clear and remove the custom field value from the task. #### Custom field access control Custom fields are a complex feature of the Asana platform, and their access in the Asana application and in the API vary based on the status of the user and project. When building your application, it is best to be defensive and not assume the given user will have read or write access to a custom field, and fail gracefully when this occurs. - name: Custom field settings description: >- Custom fields are attached to a particular project with the custom field settings resource. This resource both represents the many-to-many join of the custom field and project as well as stores information that is relevant to that particular pairing. For instance, the `is_important` property determines some possible application-specific handling of that custom field. - name: Events description: >- An event is an object representing a change to a resource that was observed by an event subscription. Event streams rely on the same infrastructure as webhooks, which ensures events are delivered within a minute (on average). This system is designed for at most once delivery, meaning in exceptional circumstances a small number of events may be missing from the stream. For this reason, if your use case requires strong guarantees about processing all changes on a resource and cannot tolerate any missing events, regardless of how rare that might be, we recommend building a fallback polling system that fetches the resource periodically as well. Note that while webhooks cannot be replayed once delivered, events are retrievable from the event stream for 24 hours after being processed. In general, requesting events on a resource is faster and subject to higher rate limits than requesting the resource itself. Additionally, change events "bubble up" (e.g., listening to events on a project would include when stories are added to tasks in the project, and even to subtasks). Establish an initial sync token by making a request with no sync token. The response will be a `412 Precondition Failed` error - the same as if the sync token had expired. Subsequent requests should always provide the sync token from the immediately preceding call. Sync tokens may not be valid if you attempt to go "backward" in the history by requesting previous tokens, though re-requesting the current sync token is generally safe, and will always return the same results. When you receive a `412 Precondition Failed` error, it means that the sync token is either invalid or expired. If you are attempting to keep a set of data in sync, this signals you may need to re-crawl the data. Sync tokens always expire after 24 hours, but may expire sooner, depending on load on the service. - name: Goals description: >- A goal is an object in the goal-tracking system that helps your organization drive measurable results. - name: Goal relationships description: >- A goal relationship is an object representing the relationship between a goal and another goal, a project, or a portfolio. - name: Jobs description: >- Jobs represent processes that handle asynchronous work. A job created when an endpoint requests an action that will be handled asynchronously, such as project or task duplication. Only the creator of the duplication process can access the duplication status of the new object. *Note*: With any work that is handled asynchronously (e.g., [project instantation from a template](/reference/instantiateproject), duplicating a [task](/reference/duplicatetask) or [project](/reference/duplicateproject), etc.), the *intermittent states* of newly-created objects may not be consistent. That is, object properties may return different values each time when polled until the job `status` has returned a `succeeded` value. - name: Organization exports description: >- An `organization_export` object represents a request to export the complete data of an organization in JSON format. To export an organization using this API: * Create an `organization_export` [request](/reference/createorganizationexport) and store the ID that is returned. * Request the `organization_export` every few minutes, until the `state` field contains ‘finished’. * Download the file located at the URL in the `download_url` field. * Exports can take a long time, from several minutes to a few hours for large organizations. *Note: These endpoints are only available to [Service Accounts](https://asana.com/guide/help/premium/service-accounts) of an [Enterprise](https://asana.com/enterprise) organization.* - name: Portfolios description: >- 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 [status update](/reference/status-updates). Portfolios have some restrictions on size. Each portfolio has a max of 500 items and, like projects, a maximum of 20 custom fields. - name: Portfolio memberships description: >- This object determines if a user is a member of a portfolio. - name: Projects description: >- A project represents a prioritized list of tasks in Asana or a board with columns of tasks represented as cards. A project exists in a single workspace or organization and is accessible to a subset of users in that workspace or organization, depending on its permissions. Projects in organizations are shared with a single team. Currently, the team of a project cannot be changed via the API. Non-organization workspaces do not have teams and so you should not specify the team of project in a regular workspace. Followers of a project are a subset of the members of that project. Followers of a project will receive all updates including tasks created, added and removed from that project. Members of the project have access to and will receive status updates of the project. Adding followers to a project will add them as members if they are not already, removing followers from a project will not affect membership. **Note:** You can use certain project endpoints to operate on [user task lists](/reference/user-task-lists) ([My Tasks](https://asana.com/guide/help/fundamentals/my-tasks)) by substituting the `{project_gid}` with the `{user_task_list_gid}`. For example, you can perform operations on the custom fields of a user task list by using the following projects endpoints: [Add a custom field to a project](/reference/addcustomfieldsettingforproject), [Remove a custom field from a project](/reference/removecustomfieldsettingforproject) and [Get a project's custom fields](/reference/getcustomfieldsettingsforproject) - name: Project briefs description: >- A project brief object represents a rich text document that describes a project. Please note that this API is in *preview*, and is expected to change. This API is to be used for development and testing only as an advance view into the upcoming rich text format experience in the task description. For more information, see [this post](https://forum.asana.com/t/project-brief-api-now-available-as-a-preview/150885) in the developer forum. - name: Project memberships description: >- With the introduction of “comment-only” projects in Asana, a user’s membership in a project comes with associated permissions. These permissions (i.e., whether a user has full access to the project or comment-only access) are accessible through the project memberships endpoints described here. - name: Project statuses description: |- *Deprecated: new integrations should prefer using [status updates](/reference/status-updates)* A project status is an update on the progress of a particular project, and is sent out to all project followers when created. These updates include both text describing the update and a color code intended to represent the overall state of the project: "green" for projects that are on track, "yellow" for projects at risk, "red" for projects that are behind, and "blue" for projects on hold. Project statuses can be created and deleted, but not modified. - name: Project templates description: |- A project template is an object that allows new projects to be created with a predefined setup, which may include tasks, sections, rules, etc. It simplifies the process of running a workflow that involves a similar set of work every time. Project templates in organizations are shared with a single team. Currently, the team of a project template cannot be changed via the API. - name: Sections description: >- A section is a subdivision of a project that groups tasks together. It can either be a header above a list of tasks in a list view or a column in a board view of a project. Sections are largely a shared idiom in Asana’s API for both list and board views of a project regardless of the project’s layout. The ‘memberships’ property when [getting a task](/reference/gettask) will return the information for the section or the column under ‘section’ in the response. - name: Status updates description: |- A status update is an update on the progress of a particular object, and is sent out to all followers when created. These updates include both text describing the update and a `status_type` intended to represent the overall state of the project. These include: `on_track` for projects that are on track, `at_risk` for projects at risk, `off_track` for projects that are behind, and `on_hold` for projects on hold. Status updates can be created and deleted, but not modified. - name: Stories description: >- *See [our forum post](https://forum.asana.com/t/no-more-parsing-story-text-new-fields-on-stories/42924) for more info on when conditional fields are returned.* A story represents an activity associated with an object in the Asana system. Stories are generated by the system whenever users take actions such as creating or assigning tasks, or moving tasks between projects. "Comments" are also a form of user-generated story. - name: Tags description: >- A tag is a label that can be attached to any task in Asana. It exists in a single workspace or organization. Tags have some metadata associated with them, but it is possible that we will simplify them in the future so it is not encouraged to rely too heavily on it. Unlike projects, tags do not provide any ordering on the tasks they are associated with. - name: Tasks description: >- The task is the basic object around which many operations in Asana are centered. In the Asana application, multiple tasks populate the middle pane according to some view parameters, and the set of selected tasks determines the more detailed information presented in the details pane. Sections are unique in that they will be included in the `memberships` field of task objects returned in the API when the task is within a section. They can also be used to manipulate the ordering of a task within a project. [Queries](/reference/gettasks) return a [compact representation of each task object](/reference/tasks). To retrieve *all* fields or *specific set* of the fields, use [field selectors](/docs/inputoutput-options) to manipulate what data is included in a response. - name: Task templates description: >- A task template is an object that allows new tasks to be created with a predefined setup, which may include followers, dependencies, custom fields, etc. It simplifies the process of running a workflow that involves a similar set of work every time. Task templates are contained within a single project. - name: Teams description: >- A team is used to group related projects and people together within an organization. Each project in an organization is associated with a team. - name: Team memberships description: >- This object determines if a user is a member of a team. - name: Time periods description: >- A time period is an object that represents a domain-scoped date range that can be set on [goals](/reference/goals). - name: Typeahead description: >- The typeahead search API provides search for objects from a single workspace. - name: Users description: >- A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks. Like other objects in the system, users are referred to by numerical IDs. However, the special string identifier `me` can be used anywhere a user ID is accepted, to refer to the current authenticated user (e.g, `GET /users/me`). - name: User task lists description: >- A user task list represents the tasks assigned to a particular user. This list is the user's [My Tasks](https://asana.com/guide/help/fundamentals/my-tasks) list. - name: Webhooks description: >- Webhooks allow you to subscribe to notifications about events that occur on Asana resources (e.g., tasks, projects, stories, etc.). For a more detailed explanation of webhooks see the [overview of webhooks](/docs/webhooks-guide). - name: Workspaces description: >- A *workspace* is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace. An *organization* is a special kind of workspace that represents a company. In an organization, you can group your projects into teams. You can read more about how organizations work on the Asana Guide. To tell if your workspace is an organization or not, check its `is_organization` property. Over time, we intend to migrate most workspaces into organizations and to release more organization-specific functionality. We may eventually deprecate using workspace-based APIs for organizations. Currently, and until after some reasonable grace period following any further announcements, you can still reference organizations in any `workspace` parameter. - name: Workspace memberships description: >- This object determines if a user is a member of a workspace. components: parameters: fields: name: opt_fields in: query description: >- Defines fields to return. Some requests return *compact* representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options. example: - followers - assignee required: false schema: type: array items: type: string style: form explode: false pretty: name: opt_pretty in: query description: >- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true schema: type: boolean style: form example: true limit: name: limit in: query description: >- Results per page. The number of objects to return per page. The value must be between 1 and 100. example: 50 schema: type: integer minimum: 1 maximum: 100 offset: name: offset in: query description: >- Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' example: eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9 schema: type: string archived_query_param: name: archived in: query description: >- Only return projects whose `archived` field takes on the value of this parameter. schema: type: boolean example: false attachment_path_gid: name: attachment_gid in: path description: >- Globally unique identifier for the attachment. required: true schema: type: string example: '12345' x-env-variable: attachment custom_field_path_gid: name: custom_field_gid in: path description: >- Globally unique identifier for the custom field. required: true schema: type: string example: '12345' x-env-variable: custom_field goal_path_gid: name: goal_gid in: path description: >- Globally unique identifier for the goal. required: true schema: type: string example: '12345' x-env-variable: goal goal_relationship_path_gid: name: goal_relationship_gid in: path description: >- Globally unique identifier for the goal relationship. required: true schema: type: string example: '12345' x-env-variable: goal_relationship job_path_gid: name: job_gid in: path description: >- Globally unique identifier for the job. required: true schema: type: string example: '12345' x-env-variable: job membership_path_gid: name: membership_gid in: path description: >- Globally unique identifier for the membership. required: true schema: type: string example: '12345' x-env-variable: membership organization_export_path_gid: name: organization_export_gid in: path description: >- Globally unique identifier for the organization export. required: true schema: type: string example: '12345' x-env-variable: organization_export project_brief_path_gid: name: project_brief_gid in: path description: >- Globally unique identifier for the project brief. required: true schema: type: string example: '12345' x-env-variable: project_brief project_path_gid: name: project_gid in: path description: >- Globally unique identifier for the project. required: true schema: type: string example: '1331' x-env-variable: project project_template_path_gid: name: project_template_gid in: path description: >- Globally unique identifier for the project template. required: true schema: type: string example: '1331' x-env-variable: project_template project_membership_path_gid: name: project_membership_gid in: path required: true schema: type: string example: '1331' x-env-variable: project_membership project_status_path_gid: name: project_status_gid in: path required: true description: The project status update to get. schema: type: string example: '321654' x-env-variable: project_status status_update_path_gid: name: status_update_gid in: path required: true description: The status update to get. schema: type: string example: '321654' x-env-variable: status portfolio_path_gid: name: portfolio_gid in: path description: >- Globally unique identifier for the portfolio. required: true schema: type: string example: '12345' x-env-variable: portfolio portfolio_membership_path_gid: name: portfolio_membership_gid in: path required: true schema: type: string example: '1331' x-env-variable: portfolio_membership portfolio_query_param: name: portfolio in: query description: The portfolio to filter results on. schema: type: string example: '12345' x-env-variable: portfolio rule_trigger_path_gid: name: rule_trigger_gid in: path required: true description: The ID of the incoming web request trigger. This value is a path parameter that is automatically generated for the API endpoint. schema: type: string example: '12345' x-env-variable: rule section_path_gid: name: section_gid in: path required: true description: The globally unique identifier for the section. schema: type: string example: '321654' x-env-variable: section story_path_gid: name: story_gid in: path description: Globally unique identifier for the story. required: true schema: type: string example: '35678' x-env-variable: story tag_path_gid: name: tag_gid in: path description: Globally unique identifier for the tag. required: true schema: type: string example: '11235' x-env-variable: tag task_path_gid: name: task_gid in: path required: true description: The task to operate on. schema: type: string example: '321654' x-env-variable: task task_template_path_gid: name: task_template_gid in: path description: >- Globally unique identifier for the task template. required: true schema: type: string example: '1331' x-env-variable: task_template team_path_gid: name: team_gid in: path description: Globally unique identifier for the team. required: true schema: type: string example: '159874' x-env-variable: team team_query_param: name: team in: query description: The team to filter projects on. schema: type: string example: '14916' x-env-variable: team team_membership_path_gid: name: team_membership_gid in: path required: true schema: type: string example: '724362' x-env-variable: team_membership time_period_path_gid: name: time_period_gid in: path description: >- Globally unique identifier for the time period. required: true schema: type: string example: '917392' x-env-variable: time_period time_tracking_entry_path_gid: name: time_tracking_entry_gid in: path description: >- Globally unique identifier for the time tracking entry. required: true schema: type: string example: '917392' x-env-variable: time_tracking_entry user_query_param: name: user in: query description: >- A string identifying a user. This can either be the string "me", an email, or the gid of a user. schema: type: string x-env-variable: user example: me user_path_gid: name: user_gid in: path description: >- A string identifying a user. This can either be the string "me", an email, or the gid of a user. required: true schema: type: string x-env-variable: user example: me user_task_list_path_gid: name: user_task_list_gid in: path description: >- Globally unique identifier for the user task list. required: true schema: type: string example: '12345' x-env-variable: user_task_list webhook_path_gid: name: webhook_gid in: path description: >- Globally unique identifier for the webhook. required: true schema: type: string example: '12345' x-env-variable: webhook workspace_path_gid: name: workspace_gid in: path description: >- Globally unique identifier for the workspace or organization. required: true schema: type: string example: '12345' x-env-variable: workspace workspace_query_param: name: workspace in: query description: The workspace to filter results on. schema: type: string example: '12345' x-env-variable: workspace workspace_membership_path_gid: name: workspace_membership_gid in: path required: true schema: type: string example: '12345' x-env-variable: workspace_membership audit_log_start_at: name: start_at in: query description: Filter to events created after this time (inclusive). required: false schema: type: string format: date-time audit_log_end_at: name: end_at in: query description: Filter to events created before this time (exclusive). required: false schema: type: string format: date-time audit_log_event_type: name: event_type in: query description: >- Filter to events of this type. Refer to the [supported audit log events](/docs/audit-log-events#supported-audit-log-events) for a full list of values. required: false schema: type: string audit_log_actor_type: name: actor_type in: query description: >- Filter to events with an actor of this type. This only needs to be included if querying for actor types without an ID. If `actor_gid` is included, this should be excluded. required: false schema: type: string enum: - user - asana - asana_support - anonymous - external_administrator audit_log_actor_gid: name: actor_gid in: query description: >- Filter to events triggered by the actor with this ID. required: false schema: type: string audit_log_resource_gid: name: resource_gid in: query description: Filter to events with this resource ID. required: false schema: type: string completed_since: name: completed_since in: query required: false description: > Only return tasks that are either incomplete or that have been completed since this time. Accepts a date-time string or the keyword *now*. schema: type: string example: '2012-02-22T02:06:58.158Z' member: name: member in: query required: false description: > Member object gid can be user or team. schema: type: string example: '123' message_path_gid: name: message_gid in: path required: true description: The message to get. schema: type: string example: '321654' x-env-variable: message responses: GenericErrorResponse: description: >- Sadly, sometimes requests to the API are not successful. Failures can occur for a wide range of reasons. In all cases, the API should return an HTTP Status Code that indicates the nature of the failure, with a response body in JSON format containing additional information. In the event of a server error the response body will contain an error phrase. These phrases are automatically generated using the [node-asana-phrase library](https://github.com/Asana/node-asana-phrase) and can be used by Asana support to quickly look up the incident that caused the server error. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' BadRequest: description: >- This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Unauthorized: description: >- A valid authentication token was not provided with the request, so the API could not associate a user with the request. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' PaymentRequired: description: >- The request was valid, but the queried object or object mutation specified in the request is above your current premium level. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Forbidden: description: >- The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' NotFound: description: >- Either the request method and path supplied do not specify a known action in the API, or the object specified by the request does not exist. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' TooManyRequests: description: >- You have exceeded one of the enforced rate limits in the API. See the [documentation on rate limiting](https://developers.asana.com/docs/#rate-limits) for more information. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' InternalServerError: description: >- There was a problem on Asana’s end. In the event of a server error the response body should contain an error phrase. These phrases can be used by Asana support to quickly look up the incident that caused the server error. Some errors are due to server load, and will not supply an error phrase. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' BadGateway: description: >- There is an issue between the load balancers and Asana's API. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' ServiceUnavailable: description: >- Either the upstream service is unavailable to the API, or the API has been intentionally shut off. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' GatewayTimeout: description: >- This request took too long to complete. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' schemas: AddCustomFieldSettingRequest: type: object required: - custom_field properties: custom_field: description: The custom field to associate with this container. type: string example: '14916' is_important: description: >- Whether this field should be considered important to this container (for instance, to display in the list view of items in the container). type: boolean example: true insert_before: description: >- A gid of a Custom Field Setting on this container, before which the new Custom Field Setting will be added. `insert_before` and `insert_after` parameters cannot both be specified. type: string example: '1331' insert_after: description: >- A gid of a Custom Field Setting on this container, after which the new Custom Field Setting will be added. `insert_before` and `insert_after` parameters cannot both be specified. type: string example: '1331' AddFollowersRequest: type: object required: - followers properties: followers: description: >- An array of strings identifying users. These can either be the string "me", an email, or the gid of a user. type: string example: 521621,621373 AddMembersRequest: type: object required: - members properties: members: description: >- An array of strings identifying users. These can either be the string "me", an email, or the gid of a user. type: string example: 521621,621373 AsanaNamedResource: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object properties: name: description: The name of the object. type: string example: Bug Task AsanaResource: 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 AttachmentBase: $ref: '#/components/schemas/AttachmentCompact' AttachmentCompact: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object description: >- An *attachment* object represents any file attached to a task in Asana, whether it’s an uploaded file or one associated via a third-party service such as Dropbox or Google Drive. x-docs-overrides: properties.resource_type.example: attachment properties: name: description: The name of the file. type: string readOnly: true example: Screenshot.png resource_subtype: description: >- The service hosting the attachment. Valid values are `asana`, `dropbox`, `gdrive`, `onedrive`, `box`, `vimeo`, and `external`. type: string example: dropbox AttachmentRequest: type: object required: - parent properties: resource_subtype: description: > The type of the attachment. Must be one of the given values. If not specified, a file attachment of type `asana` will be assumed. Note that if the value of `resource_subtype` is `external`, a `parent`, `name`, and `url` must also be provided. type: string example: external enum: - asana - dropbox - gdrive - onedrive - box - vimeo - external file: description: > Required for `asana` attachments. type: string format: binary parent: description: > Required identifier of the parent task, project, or project_brief, as a string. type: string url: description: > The URL of the external resource being attached. Required for attachments of type `external`. type: string name: description: > The name of the external resource being attached. Required for attachments of type `external`. type: string connect_to_app: description: > *Optional*. Only relevant for external attachments with a parent task. A boolean indicating whether the current app should be connected with the attachment for the purposes of showing an app components widget. Requires the app to have been added to a project the parent task is in. type: boolean AttachmentResponse: allOf: - $ref: '#/components/schemas/AttachmentBase' - type: object properties: 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' download_url: description: >- The URL containing the content of the attachment. *Note:* May be null if the attachment is hosted by [Box](https://www.box.com/) and will be null if the attachment is a Video Message hosted by [Vimeo](https://vimeo.com/). If present, this URL may only be valid for two minutes from the time of retrieval. You should avoid persisting this URL somewhere and just refresh it on demand to ensure you do not keep stale URLs. type: string format: uri readOnly: true nullable: true example: https://s3.amazonaws.com/assets/123/Screenshot.png permanent_url: description: > type: string format: uri readOnly: true nullable: true example: https://s3.amazonaws.com/assets/123/Screenshot.png host: description: >- The service hosting the attachment. Valid values are `asana`, `dropbox`, `gdrive`, `box`, and `vimeo`. type: string readOnly: true example: dropbox parent: allOf: - $ref: '#/components/schemas/TaskCompact' - type: object nullable: true description: The task this attachment is attached to. readOnly: true properties: resource_subtype: description: >- The resource subtype of the parent resource that the filter applies to. type: string example: default_task nullable: true size: description: >- The size of the attachment in bytes. Only present when the `resource_subtype` is `asana`. type: integer readOnly: true example: 12345 view_url: description: >- The URL where the attachment can be viewed, which may be friendlier to users in a browser than just directing them to a raw file. May be null if no view URL exists for the service. type: string format: uri readOnly: true nullable: true example: https://www.dropbox.com/s/123/Screenshot.png connected_to_app: description: >- Whether the attachment is connected to the app making the request for the purposes of showing an app components widget. Only present when the `resource_subtype` is `external` or `gdrive`. type: boolean readOnly: true AuditLogEvent: description: >- An object representing a single event within an Asana domain. Every audit log event is comprised of an `event_type`, `actor`, `resource`, and `context`. Some events will include additional metadata about the event under `details`. See our [currently supported list of events](/docs/audit-log-events#supported-audit-log-events) for more details. type: object properties: gid: description: >- Globally unique identifier of the `AuditLogEvent`, as a string. type: string example: '12345' x-insert-after: false created_at: description: The time the event was created. type: string format: date-time example: '2021-01-01T00:00:00.000Z' event_type: description: The type of the event. type: string example: task_deleted event_category: description: The category that this `event_type` belongs to. type: string example: deletion actor: $ref: '#/components/schemas/AuditLogEventActor' resource: $ref: '#/components/schemas/AuditLogEventResource' details: $ref: '#/components/schemas/AuditLogEventDetails' context: $ref: '#/components/schemas/AuditLogEventContext' AuditLogEventActor: description: >- The entity that triggered the event. Will typically be a user. type: object properties: actor_type: description: >- The type of actor. Can be one of `user`, `asana`, `asana_support`, `anonymous`, or `external_administrator`. type: string enum: - user - asana - asana_support - anonymous - external_administrator example: user gid: description: >- Globally unique identifier of the actor, if it is a user. type: string example: '1111' name: description: The name of the actor, if it is a user. type: string example: Greg Sanchez email: description: The email of the actor, if it is a user. type: string example: gregsanchez@example.com AuditLogEventContext: description: The context from which this event originated. type: object properties: context_type: description: >- The type of context. Can be one of `web`, `desktop`, `mobile`, `asana_support`, `asana`, `email`, or `api`. type: string enum: - web - desktop - mobile - asana_support - asana - email - api example: web api_authentication_method: description: >- The authentication method used in the context of an API request. Only present if the `context_type` is `api`. Can be one of `cookie`, `oauth`, `personal_access_token`, or `service_account`. type: string enum: - cookie - oauth - personal_access_token - service_account client_ip_address: description: The IP address of the client that initiated the event, if applicable. type: string example: 1.1.1.1 user_agent: description: The user agent of the client that initiated the event, if applicable. type: string example: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36 oauth_app_name: description: >- The name of the OAuth App that initiated the event. Only present if the `api_authentication_method` is `oauth`. type: string AuditLogEventDetails: description: Event specific details. The schema will vary depending on the `event_type`. type: object AuditLogEventResource: description: The primary object that was affected by this event. type: object properties: resource_type: description: The type of resource. type: string example: task resource_subtype: description: The subtype of resource. Most resources will not have a subtype. type: string example: milestone gid: description: Globally unique identifier of the resource. type: string example: '1111' name: description: The name of the resource. type: string nullable: true example: Example Task email: description: The email of the resource, if applicable. type: string BatchRequest: description: A request object for use in a batch request. type: object properties: actions: type: array items: $ref: '#/components/schemas/BatchRequestAction' BatchRequestAction: description: An action object for use in a batch request. type: object properties: relative_path: description: >- The path of the desired endpoint relative to the API’s base URL. Query parameters are not accepted here; put them in `data` instead. type: string example: /tasks/123 method: description: The HTTP method you wish to emulate for the action. type: string enum: - get - post - put - delete - patch - head example: get data: description: >- For `GET` requests, this should be a map of query parameters you would have normally passed in the URL. Options and pagination are not accepted here; put them in `options` instead. For `POST`, `PATCH`, and `PUT` methods, this should be the content you would have normally put in the data field of the body. type: object example: assignee: me workspace: '1337' options: description: >- Pagination (`limit` and `offset`) and output options (`fields` or `expand`) for the action. “Pretty” JSON output is not an available option on individual actions; if you want pretty output, specify that option on the parent request. type: object properties: limit: description: Pagination limit for the request. type: integer example: 50 offset: description: Pagination offset for the request. type: integer example: eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9 fields: description: The fields to retrieve in the request. type: array items: type: string example: - name - gid - notes - completed example: limit: 3 fields: - name - notes - completed required: - relative_path - method BatchResponse: description: A response object returned from a batch request. type: object properties: status_code: description: The HTTP status code that the invoked endpoint returned. type: integer example: 200 headers: description: >- A map of HTTP headers specific to this result. This is primarily used for returning a `Location` header to accompany a `201 Created` result. The parent HTTP response will contain all common headers. type: object example: location: /tasks/1234 body: description: The JSON body that the invoked endpoint returned. type: object example: data: gid: '1967' completed: false name: Hello, world! notes: How are you today? CustomFieldBase: allOf: - $ref: '#/components/schemas/CustomFieldCompact' - type: object properties: description: description: >- [Opt In](/docs/inputoutput-options). The description of the custom field. type: string example: Development team priority 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: $ref: '#/components/schemas/EnumOption' precision: description: >- Only relevant for custom fields of type ‘Number’. This field dictates the number of places after the decimal to round to, i.e. 0 is integer values, 1 rounds to the nearest tenth, and so on. Must be between 0 and 6, inclusive. For percentage format, this may be unintuitive, as a value of 0.25 has a precision of 0, while a value of 0.251 has a precision of 1. This is due to 0.25 being displayed as 25%. The identifier format will always have a precision of 0. type: integer example: 2 format: description: >- The format of this custom field. type: string enum: - currency - identifier - percentage - custom - duration - none example: custom currency_code: description: >- ISO 4217 currency code to format this custom field. This will be null if the `format` is not `currency`. type: string nullable: true example: EUR custom_label: description: >- This is the string that appears next to the custom field value. This will be null if the `format` is not `custom`. type: string nullable: true example: gold pieces custom_label_position: description: >- Only relevant for custom fields with `custom` format. This depicts where to place the custom label. This will be null if the `format` is not `custom`. type: string nullable: true enum: - prefix - suffix - null example: suffix is_global_to_workspace: description: >- This flag describes whether this custom field is available to every container in the workspace. Before project-specific custom fields, this field was always true. type: boolean example: true readOnly: true has_notifications_enabled: description: >- *Conditional*. This flag describes whether a follower of a task with this field should receive inbox notifications from changes to this field. type: boolean example: true asana_created_field: description: >- *Conditional*. A unique identifier to associate this field with the template source of truth. type: string readOnly: true nullable: true enum: - a_v_requirements - account_name - actionable - align_shipping_link - align_status - allotted_time - appointment - approval_stage - approved - article_series - board_committee - browser - campaign_audience - campaign_project_status - campaign_regions - channel_primary - client_topic_type - complete_by - contact - contact_email_address - content_channels - content_channels_needed - content_stage - content_type - contract - contract_status - cost - creation_stage - creative_channel - creative_needed - creative_needs - data_sensitivity - deal_size - delivery_appt - delivery_appt_date - department - department_responsible - design_request_needed - design_request_type - discussion_category - do_this_task - editorial_content_status - editorial_content_tag - editorial_content_type - effort - effort_level - est_completion_date - estimated_time - estimated_value - expected_cost - external_steps_needed - favorite_idea - feedback_type - financial - funding_amount - grant_application_process - hiring_candidate_status - idea_status - ids_link - ids_patient_link - implementation_stage - insurance - interview_area - interview_question_score - itero_scan_link - job_s_applied_to - lab - launch_status - lead_status - localization_language - localization_market_team - localization_status - meeting_minutes - meeting_needed - minutes - mrr - must_localize - name_of_foundation - need_to_follow_up - next_appointment - next_steps_sales - num_people - number_of_user_reports - office_location - onboarding_activity - owner - participants_needed - patient_date_of_birth - patient_email - patient_phone - patient_status - phone_number - planning_category - point_of_contact - position - post_format - prescription - priority - priority_level - product - product_stage - progress - project_size - project_status - proposed_budget - publish_status - reason_for_scan - referral - request_type - research_status - responsible_department - responsible_team - risk_assessment_status - room_name - sales_counterpart - sentiment - shipping_link - social_channels - stage - status - status_design - status_of_initiative - system_setup - task_progress - team - team_marketing - team_responsible - time_it_takes_to_complete_tasks - timeframe - treatment_type - type_work_requests_it - use_agency - user_name - vendor_category - vendor_type - word_count - null example: priority CustomFieldCompact: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object description: >- 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`. x-docs-overrides: properties.resource_type.example: custom_field properties: 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: $ref: '#/components/schemas/EnumOption' enabled: description: >- *Conditional*. Determines if the custom field is enabled or not. type: boolean readOnly: true example: true 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: allOf: - $ref: '#/components/schemas/EnumOption' - type: object nullable: true description: >- *Conditional*. Only relevant for custom fields of type `enum`. This object is the chosen value of an `enum` custom field. 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: $ref: '#/components/schemas/EnumOption' 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 CustomFieldRequest: allOf: - $ref: '#/components/schemas/CustomFieldBase' - type: object required: - workspace properties: workspace: type: string description: >- *Create-Only* The workspace to create a custom field in. example: '1331' owned_by_app: type: boolean description: >- *Allow-listed*. Instructs the API that this Custom Field is app-owned. This parameter is allow-listed to specific apps at this point in time. For apps that are not allow-listed, providing this parameter will result in a `403 Forbidden`. people_value: description: >- *Conditional*. Only relevant for custom fields of type `people`. This array of user GIDs reflects the users to be written to a `people` custom field. Note that *write* operations will replace existing users (if any) in the custom field with the users specified in this array. type: array items: type: string description: >- The GID of a user. example: - '12345' CustomFieldResponse: allOf: - $ref: '#/components/schemas/CustomFieldBase' - type: object properties: is_formula_field: description: >- *Conditional*. This flag describes whether a custom field is a formula custom field. type: boolean example: false is_value_read_only: description: >- *Conditional*. This flag describes whether a custom field is read only. type: boolean example: false created_by: allOf: - $ref: '#/components/schemas/UserCompact' - nullable: true people_value: description: >- *Conditional*. Only relevant for custom fields of type `people`. This array of [compact user](/reference/users) objects reflects the values of a `people` custom field. type: array items: $ref: '#/components/schemas/UserCompact' CustomFieldSettingBase: $ref: '#/components/schemas/CustomFieldSettingCompact' CustomFieldSettingCompact: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object description: >- Custom Fields Settings objects represent the many-to-many join of the Custom Field and Project as well as stores information that is relevant to that particular pairing. x-docs-overrides: properties.resource_type.example: custom_field_setting CustomFieldSettingResponse: allOf: - $ref: '#/components/schemas/CustomFieldSettingBase' - type: object properties: project: allOf: - $ref: '#/components/schemas/ProjectCompact' - type: object description: >- *Deprecated: new integrations should prefer the `parent` field.* The id of the project that this custom field settings refers to. readOnly: true is_important: description: >- `is_important` is used in the Asana web application to determine if this custom field is displayed in the list/grid view of a project or portfolio. type: boolean readOnly: true example: false parent: allOf: - $ref: '#/components/schemas/ProjectCompact' - type: object description: >- The parent to which the custom field is applied. This can be a project or portfolio and indicates that the tasks or projects that the parent contains may be given custom field values for this custom field. readOnly: true custom_field: allOf: - $ref: '#/components/schemas/CustomFieldResponse' - type: object description: >- The custom field that is applied to the `parent`. readOnly: true EmptyResponse: type: object description: >- An empty object. Some endpoints do not return an object on success. The success is conveyed through a 2-- status code and returning an empty object. EnumOption: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object description: >- 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. x-docs-overrides: properties.resource_type.example: enum_option properties: 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 EnumOptionBase: $ref: '#/components/schemas/EnumOption' EnumOptionInsertRequest: type: object required: - enum_option properties: enum_option: type: string description: The gid of the enum option to relocate. example: '97285' before_enum_option: type: string description: >- An existing enum option within this custom field before which the new enum option should be inserted. Cannot be provided together with after_enum_option. example: '12345' after_enum_option: type: string description: >- An existing enum option within this custom field after which the new enum option should be inserted. Cannot be provided together with before_enum_option. example: '12345' EnumOptionRequest: allOf: - $ref: '#/components/schemas/EnumOptionBase' - type: object properties: insert_before: type: string description: >- An existing enum option within this custom field before which the new enum option should be inserted. Cannot be provided together with after_enum_option. example: '12345' insert_after: type: string description: >- An existing enum option within this custom field after which the new enum option should be inserted. Cannot be provided together with before_enum_option. example: '12345' Error: type: object properties: message: type: string readOnly: true description: >- Message providing more detail about the error that occurred, if available. example: 'project: Missing input' help: type: string readOnly: true description: >- Additional information directing developers to resources on how to address and fix the problem, if available. example: >- For more information on API status codes and how to handle them, read the docs on errors: https://asana.github.io/developer-docs/#errors' phrase: type: string readOnly: true description: >- *500 errors only*. A unique error phrase which can be used when contacting developer support to help identify the exact occurrence of the problem in Asana’s logs. example: 6 sad squid snuggle softly ErrorResponse: description: |- Sadly, sometimes requests to the API are not successful. Failures can occur for a wide range of reasons. In all cases, the API should return an HTTP Status Code that indicates the nature of the failure, with a response body in JSON format containing additional information. In the event of a server error the response body will contain an error phrase. These phrases are automatically generated using the [node-asana-phrase library](https://github.com/Asana/node-asana-phrase) and can be used by Asana support to quickly look up the incident that caused the server error. type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' EventResponse: description: |- An *event* is an object representing a change to a resource that was observed by an event subscription or delivered asynchronously to the target location of an active webhook. The event may be triggered by a different `user` than the subscriber. For example, if user A subscribes to a task and user B modified it, the event’s user will be user B. Note: Some events are generated by the system, and will have `null` as the user. API consumers should make sure to handle this case. The `resource` that triggered the event may be different from the one that the events were requested for or the webhook is subscribed to. For example, a subscription to a project will contain events for tasks contained within the project. **Note:** pay close attention to the relationship between the fields `Event.action` and `Event.change.action`. `Event.action` represents the action taken on the resource itself, and `Event.change.action` represents how the information within the resource's fields have been modified. For instance, consider these scenarios: * When at task is added to a project, `Event.action` will be `added`, `Event.parent` will be an object with the `id` and `type` of the project, and there will be no `change` field. * When an assignee is set on the task, `Event.parent` will be `null`, `Event.action` will be `changed`, `Event.change.action` will be `changed`, and `new_value` will be an object with the user's `id` and `type`. * When a collaborator is added to the task, `Event.parent` will be `null`, `Event.action` will be `changed`, `Event.change.action` will be `added`, and `added_value` will be an object with the user's `id` and `type`. type: object properties: user: allOf: - $ref: '#/components/schemas/UserCompact' - description: >- The user who triggered the event. resource: allOf: - $ref: '#/components/schemas/AsanaNamedResource' - description: >- The resource which has triggered the event by being modified in some way. type: description: >- *Deprecated: Refer to the resource_type of the resource.* The type of the resource that generated the event. type: string readOnly: true example: task action: description: >- The type of action taken on the **resource** that triggered the event. This can be one of `changed`, `added`, `removed`, `deleted`, or `undeleted` depending on the nature of the event. type: string readOnly: true example: changed parent: allOf: - $ref: '#/components/schemas/AsanaNamedResource' - description: >- For added/removed events, the parent object that resource was added to or removed from. The parent will be `null` for other event types. created_at: description: The timestamp when the event occurred. type: string format: date-time readOnly: true example: '2012-02-22T02:06:58.147Z' change: type: object description: >- Information about the type of change that has occurred. This field is only present when the value of the property `action`, describing the action taken on the **resource**, is `changed`. readOnly: true properties: field: description: The name of the field that has changed in the resource. type: string readOnly: true example: assignee action: description: >- The type of action taken on the **field** which has been changed. This can be one of `changed`, `added`, or `removed` depending on the nature of the change. type: string readOnly: true example: changed new_value: description: >- *Conditional.* This property is only present when the value of the event's `change.action` is `changed` _and_ the `new_value` is an Asana resource. This will be only the `gid` and `resource_type` of the resource when the events come from webhooks; this will be the compact representation (and can have fields expanded with [opt_fields](/docs/inputoutput-options)) when using the [get events](/reference/getevents) endpoint. example: gid: '12345' resource_type: user added_value: description: >- *Conditional.* This property is only present when the value of the event's `change.action` is `added` _and_ the `added_value` is an Asana resource. This will be only the `gid` and `resource_type` of the resource when the events come from webhooks; this will be the compact representation (and can have fields expanded with [opt_fields](/docs/inputoutput-options)) when using the [get events](/reference/getevents) endpoint. example: gid: '12345' resource_type: user removed_value: description: >- *Conditional.* This property is only present when the value of the event's `change.action` is `removed` _and_ the `removed_value` is an Asana resource. This will be only the `gid` and `resource_type` of the resource when the events come from webhooks; this will be the compact representation (and can have fields expanded with [opt_fields](/docs/inputoutput-options)) when using the [get events](/reference/getevents) endpoint. example: gid: '12345' resource_type: user GoalAddSubgoalRequest: type: object required: - subgoal properties: subgoal: description: >- The goal gid to add as subgoal to a parent goal type: string example: '1331' insert_before: description: >- An id of a subgoal of this parent goal. The new subgoal will be added before the one specified here. `insert_before` and `insert_after` parameters cannot both be specified. type: string example: '1331' insert_after: description: >- An id of a subgoal of this parent goal. The new subgoal will be added after the one specified here. `insert_before` and `insert_after` parameters cannot both be specified. type: string example: '1331' GoalAddSupportingWorkRequest: type: object required: - supporting_work properties: supporting_work: description: >- The project/portfolio gid to add as supporting work for a goal type: string example: '1331' GoalBase: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object x-docs-overrides: properties.resource_type.example: goal properties: name: type: string description: The name of the goal. example: Grow web traffic by 30% html_notes: type: string description: >- The notes of the goal with formatting as HTML. example: Start building brand awareness. notes: type: string description: >- Free-form textual information associated with the goal (i.e. its description). example: Start building brand awareness. due_on: type: string description: >- The localized day on which this goal is due. This takes a date with format `YYYY-MM-DD`. example: '2019-09-15' nullable: true start_on: type: string description: >- The day on which work for this goal begins, or null if the goal has no start date. This takes a date with `YYYY-MM-DD` format, and cannot be set unless there is an accompanying due date. example: '2019-09-14' nullable: true is_workspace_level: type: boolean description: >- *Conditional*. This property is only present when the `workspace` provided is an organization. Whether the goal belongs to the `workspace` (and is listed as part of the workspace’s goals) or not. If it isn’t a workspace-level goal, it is a team-level goal, and is associated with the goal’s team. example: true liked: type: boolean description: >- True if the goal is liked by the authorized user, false if not. example: false GoalCompact: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object x-docs-overrides: properties.resource_type.example: goal properties: name: type: string description: The name of the goal. example: Grow web traffic by 30% owner: allOf: - $ref: '#/components/schemas/UserCompact' - type: object nullable: true GoalMetricBase: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object properties: resource_subtype: description: >- The subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning. type: string readOnly: true example: number enum: - number precision: description: >- *Conditional*. Only relevant for goal metrics of type ‘Number’. This field dictates the number of places after the decimal to round to, i.e. 0 is integer values, 1 rounds to the nearest tenth, and so on. Must be between 0 and 6, inclusive. For percentage format, this may be unintuitive, as a value of 0.25 has a precision of 0, while a value of 0.251 has a precision of 1. This is due to 0.25 being displayed as 25%. type: integer example: 2 unit: description: >- A supported unit of measure for the goal metric, or none. type: string enum: - none - currency - percentage currency_code: description: >- ISO 4217 currency code to format this custom field. This will be null if the `unit` is not `currency`. type: string nullable: true example: EUR initial_number_value: description: >- This number is the start value of a goal metric of type number. type: number example: 5.2 target_number_value: description: >- This number is the end value of a goal metric of type number. This number cannot equal `initial_number_value`. type: number example: 10.2 current_number_value: description: >- This number is the current value of a goal metric of type number. type: number example: 8.12 current_display_value: description: >- This string is the current value of a goal metric of type string. type: string readOnly: true example: '8.12' progress_source: description: >- This field defines how the progress value of a goal metric is being calculated. A goal's progress can be provided manually by the user, calculated automatically from contributing subgoals or projects, or managed by an integration with an external data source, such as Salesforce. type: string enum: - manual - subgoal_progress - project_task_completion - project_milestone_completion - external example: manual GoalRemoveSupportingRelationshipRequest: type: object required: - supporting_resource properties: supporting_resource: description: >- The gid of the supporting resource to remove from the parent goal. Must be the gid of a goal, project, or portfolio. type: string example: '12345' GoalAddSupportingRelationshipRequest: type: object required: - supporting_resource properties: supporting_resource: description: >- The gid of the supporting resource to add to the parent goal. Must be the gid of a goal, project, or portfolio. type: string example: '12345' insert_before: description: >- An id of a subgoal of this parent goal. The new subgoal will be added before the one specified here. `insert_before` and `insert_after` parameters cannot both be specified. Currently only supported when adding a subgoal. type: string example: '1331' insert_after: description: >- An id of a subgoal of this parent goal. The new subgoal will be added after the one specified here. `insert_before` and `insert_after` parameters cannot both be specified. Currently only supported when adding a subgoal. type: string example: '1331' contribution_weight: description: The weight that the supporting resource's progress will contribute to the supported goal's progress. This can only be 0 or 1. type: number example: 1.0 GoalMetricCurrentValueRequest: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object properties: current_number_value: description: >- *Conditional*. This number is the current value of a goal metric of type number. type: number example: 8.12 GoalMetricRequest: $ref: '#/components/schemas/GoalMetricBase' GoalRemoveSubgoalRequest: type: object required: - subgoal properties: subgoal: description: >- The goal gid to remove as subgoal from the parent goal type: string example: '1331' GoalRequestBase: allOf: - $ref: '#/components/schemas/GoalBase' - type: object properties: team: type: string description: >- *Conditional*. This property is only present when the `workspace` provided is an organization. example: '12345' nullable: true workspace: type: string description: >- The `gid` of a workspace. example: '12345' time_period: type: string description: >- The `gid` of a time period. example: '12345' nullable: true owner: type: string description: >- The `gid` of a user. example: '12345' nullable: true GoalRequest: allOf: - $ref: '#/components/schemas/GoalRequestBase' - type: object properties: followers: type: array items: type: string description: >- The `gid` of a user. example: - '12345' GoalUpdateRequest: allOf: - $ref: '#/components/schemas/GoalRequestBase' - type: object properties: status: type: string description: >- The current status of this goal. When the goal is open, its status can be `green`, `yellow`, and `red` to reflect "On Track", "At Risk", and "Off Track", respectively. When the goal is closed, the value can be `missed`, `achieved`, `partial`, or `dropped`. *Note* you can only write to this property if `metric` is set. example: green nullable: true GoalResponse: allOf: - $ref: '#/components/schemas/GoalBase' - type: object properties: likes: description: >- Array of likes for users who have liked this goal. type: array items: $ref: '#/components/schemas/Like' readOnly: true num_likes: description: >- The number of users who have liked this goal. type: integer readOnly: true example: 5 team: allOf: - $ref: '#/components/schemas/TeamCompact' - type: object nullable: true description: >- *Conditional*. This property is only present when the `workspace` provided is an organization. workspace: allOf: - $ref: '#/components/schemas/WorkspaceCompact' - type: object followers: type: array items: $ref: '#/components/schemas/UserCompact' description: >- Array of users who are members of this goal. time_period: allOf: - $ref: '#/components/schemas/TimePeriodCompact' - type: object nullable: true metric: allOf: - $ref: '#/components/schemas/GoalMetricBase' - type: object nullable: true properties: can_manage: description: >- *Conditional*. Only relevant for `progress_source` of type `external`. This boolean indicates whether the requester has the ability to update the current value of this metric. This returns `true` if the external metric was created by the requester, `false` otherwise. type: boolean readOnly: true example: true owner: allOf: - $ref: '#/components/schemas/UserCompact' - type: object nullable: true current_status_update: allOf: - $ref: '#/components/schemas/StatusUpdateCompact' - description: The latest `status_update` posted to this goal. nullable: true status: type: string readOnly: true description: >- The current status of this goal. When the goal is open, its status can be `green`, `yellow`, and `red` to reflect "On Track", "At Risk", and "Off Track", respectively. When the goal is closed, the value can be `missed`, `achieved`, `partial`, or `dropped`. *Note* you can only write to this property if `metric` is set. example: green nullable: true GoalRelationshipBase: allOf: - $ref: '#/components/schemas/GoalRelationshipCompact' - type: object properties: supported_goal: allOf: - $ref: '#/components/schemas/GoalCompact' - type: object readOnly: true description: >- The goal that the supporting resource supports. GoalRelationshipCompact: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object description: >- A *goal relationship* is an object representing the relationship between a goal and another goal, a project, or a portfolio. x-docs-overrides: properties.resource_type.example: goal_relationship properties: resource_subtype: description: >- The subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning. type: string readOnly: true example: subgoal enum: - subgoal - supporting_work supporting_resource: allOf: - $ref: '#/components/schemas/ProjectCompact' - type: object readOnly: true description: >- The supporting resource that supports the goal. This can be either a project, portfolio, or goal. contribution_weight: description: The weight that the supporting resource's progress contributes to the supported goal's progress. This can only be 0 or 1. type: number example: 1 GoalRelationshipRequest: allOf: - $ref: '#/components/schemas/GoalRelationshipBase' - type: object GoalRelationshipResponse: allOf: - $ref: '#/components/schemas/GoalRelationshipBase' - type: object JobBase: $ref: '#/components/schemas/JobCompact' JobCompact: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object description: >- A *job* is an object representing a process that handles asynchronous work. x-docs-overrides: properties.resource_type.example: job properties: resource_subtype: description: >- The subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning. type: string readOnly: true example: duplicate_task status: description: >- The current status of this job. The value is one of: `not_started`, `in_progress`, `succeeded`, or `failed`. type: string enum: - not_started - in_progress - succeeded - failed readOnly: true example: in_progress new_project: $ref: '#/components/schemas/ProjectCompact' new_task: allOf: - $ref: '#/components/schemas/TaskCompact' - type: object nullable: true new_project_template: $ref: '#/components/schemas/ProjectTemplateCompact' JobResponse: $ref: '#/components/schemas/JobBase' Like: type: object description: >- An object to represent a user's like. properties: gid: description: >- Globally unique identifier of the object, as a string. type: string readOnly: true example: '12345' user: $ref: '#/components/schemas/UserCompact' MemberCompact: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object description: A *member* object represents either a team or user. x-docs-overrides: properties.resource_type.example: member properties: name: type: string description: The name of the member example: Greg Sanchez resource_type: type: string description: The type of the member (team or user) example: user MembershipCompact: anyOf: - $ref: '#/components/schemas/GoalMembershipCompact' - $ref: '#/components/schemas/ProjectMembershipCompactResponse' ModifyDependenciesRequest: type: object properties: dependencies: description: An array of task gids that a task depends on. type: array items: type: string example: dependencies: - '133713' - '184253' ModifyDependentsRequest: description: A set of dependent tasks. type: object properties: dependents: description: An array of task gids that are dependents of the given task. type: array items: type: string example: dependents: - '133713' - '184253' NextPage: type: object nullable: true description: >- *Conditional*. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed. properties: offset: type: string readOnly: true description: Pagination offset for the request. example: eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9 path: type: string readOnly: true description: A relative path containing the query parameters to fetch for next_page example: /tasks/12345/attachments?limit=2&offset=eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9 uri: type: string format: uri readOnly: true description: A full uri containing the query parameters to fetch for next_page example: https://app.asana.com/api/1.0/tasks/12345/attachments?limit=2&offset=eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9 OrganizationExportBase: $ref: '#/components/schemas/OrganizationExportCompact' OrganizationExportCompact: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object description: >- An *organization_export* object represents a request to export the complete data of an Organization in JSON format. x-docs-overrides: properties.resource_type.example: organization_export properties: 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' download_url: description: |- Download this URL to retreive the full export of the organization in JSON format. It will be compressed in a gzip (.gz) container. *Note: May be null if the export is still in progress or failed. If present, this URL may only be valid for 1 hour from the time of retrieval. You should avoid persisting this URL somewhere and rather refresh on demand to ensure you do not keep stale URLs.* type: string format: uri readOnly: true nullable: true example: >- https://asana-export-us-east-1.s3.us-east-1.amazonaws.com/2563645399633793/domain_export/7588024658887731/download/ domain_export_2563645399633793_7588024658887731_2023018-201726.json.gz?X-Amz-Algorithm=AWS4-HMAC-SHA256& X-Amz-Content-Sha256=xxxxxxxx&X-Amz-Date=xxxxxxxx&X-Amz-Expires=300&X-Amz-Security-Token=xxxxxxxx& X-Amz-Signature=xxxxxxxx&X-Amz-SignedHeaders=host&x-id=GetObject#_=_ state: description: The current state of the export. type: string enum: - pending - started - finished - error readOnly: true example: started organization: $ref: '#/components/schemas/WorkspaceCompact' OrganizationExportRequest: type: object description: >- An *organization_export* request starts a job to export the complete data of the given Organization. properties: organization: description: >- Globally unique identifier for the workspace or organization. type: string example: '1331' OrganizationExportResponse: $ref: '#/components/schemas/OrganizationExportBase' PortfolioAddItemRequest: type: object required: - item properties: item: description: >- The item to add to the portfolio. type: string example: '1331' insert_before: description: >- An id of an item in this portfolio. The new item will be added before the one specified here. `insert_before` and `insert_after` parameters cannot both be specified. type: string example: '1331' insert_after: description: >- An id of an item in this portfolio. The new item will be added after the one specified here. `insert_before` and `insert_after` parameters cannot both be specified. type: string example: '1331' PortfolioBase: allOf: - $ref: '#/components/schemas/PortfolioCompact' - type: object properties: color: description: Color of the portfolio. type: string enum: - dark-pink - dark-green - dark-blue - dark-red - dark-teal - dark-brown - dark-orange - dark-purple - dark-warm-gray - light-pink - light-green - light-blue - light-red - light-teal - light-brown - light-orange - light-purple - light-warm-gray example: light-green PortfolioCompact: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object description: >- 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 500 items and, like projects, a max of 20 custom fields. x-docs-overrides: properties.resource_type.example: portfolio properties: name: description: The name of the portfolio. type: string example: Bug Portfolio PortfolioMembershipBase: $ref: '#/components/schemas/PortfolioMembershipCompact' PortfolioMembershipCompact: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object description: >- This object determines if a user is a member of a portfolio. x-docs-overrides: properties.resource_type.example: portfolio_membership properties: portfolio: description: >- [Opt In](/docs/inputoutput-options). The portfolio the user is a member of. $ref: '#/components/schemas/PortfolioCompact' user: $ref: '#/components/schemas/UserCompact' PortfolioMembershipResponse: $ref: '#/components/schemas/PortfolioMembershipBase' PortfolioRemoveItemRequest: type: object required: - item properties: item: description: >- The item to remove from the portfolio. type: string example: '1331' PortfolioRequest: allOf: - $ref: '#/components/schemas/PortfolioBase' - type: object properties: members: readOnly: true type: array description: >- An array of strings identifying users. These can either be the string "me", an email, or the gid of a user. items: type: string description: >- Gid of an object. example: - '52164' - '15363' workspace: type: string description: >- Gid of an object. example: '167589' public: type: boolean description: >- True if the portfolio is public to its workspace members. example: false PortfolioResponse: allOf: - $ref: '#/components/schemas/PortfolioBase' - type: object properties: 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' created_by: $ref: '#/components/schemas/UserCompact' custom_field_settings: description: Array of custom field settings applied to the portfolio. type: array items: $ref: '#/components/schemas/CustomFieldSettingResponse' current_status_update: allOf: - $ref: '#/components/schemas/StatusUpdateCompact' - description: The latest `status_update` posted to this portfolio. nullable: true due_on: description: >- The localized day on which this portfolio is due. This takes a date with format YYYY-MM-DD. type: string format: date nullable: true example: '2019-09-15' custom_fields: description: Array of Custom Fields. type: array items: $ref: '#/components/schemas/CustomFieldCompact' members: type: array readOnly: true items: $ref: '#/components/schemas/UserCompact' owner: $ref: '#/components/schemas/UserCompact' start_on: description: >- The day on which work for this portfolio begins, or null if the portfolio has no start date. This takes a date with `YYYY-MM-DD` format. *Note: `due_on` must be present in the request when setting or unsetting the `start_on` parameter. Additionally, `start_on` and `due_on` cannot be the same date.* type: string format: date nullable: true example: '2019-09-14' workspace: allOf: - $ref: '#/components/schemas/WorkspaceCompact' - type: object description: >- *Create-only*. The workspace or organization that the portfolio belongs to. permalink_url: type: string readOnly: true description: >- A url that points directly to the object within Asana. example: https://app.asana.com/0/resource/123456789/list public: description: >- True if the portfolio is public to its workspace members. type: boolean example: false project_templates: description: >- Array of project templates that are in the portfolio type: array readOnly: true items: $ref: '#/components/schemas/ProjectTemplateCompact' Preview: type: object description: >- A collection of rich text that will be displayed as a preview to another app. This is read-only except for a small group of whitelisted apps. readOnly: true properties: fallback: description: Some fallback text to display if unable to display the full preview. type: string example: >- Greg: Great! I like this idea.\n\nhttps//a_company.slack.com/archives/ABCDEFG/12345678 footer: description: Text to display in the footer. type: string example: Mar 17, 2019 1:25 PM header: description: Text to display in the header. type: string example: Asana for Slack header_link: description: Where the header will link to. type: string example: https://asana.comn/apps/slack html_text: description: HTML formatted text for the body of the preview. type: string example: Great! I like this idea. text: description: Text for the body of the preview. type: string example: Great! I like this idea. title: description: Text to display as the title. type: string example: Greg title_link: description: Where to title will link to. type: string example: https://asana.slack.com/archives/ABCDEFG/12345678 ProjectBase: allOf: - $ref: '#/components/schemas/ProjectCompact' - type: object properties: archived: description: >- True if the project is archived, false if not. Archived projects do not show in the UI by default and may be treated differently for queries. type: boolean example: false color: description: Color of the project. type: string nullable: true enum: - dark-pink - dark-green - dark-blue - dark-red - dark-teal - dark-brown - dark-orange - dark-purple - dark-warm-gray - light-pink - light-green - light-blue - light-red - light-teal - light-brown - light-orange - light-purple - light-warm-gray - none - null example: light-green 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' current_status: allOf: - $ref: '#/components/schemas/ProjectStatusResponse' - type: object nullable: true description: >- *Deprecated: new integrations should prefer the `current_status_update` resource.* current_status_update: allOf: - $ref: '#/components/schemas/StatusUpdateCompact' - type: object nullable: true description: The latest `status_update` posted to this project. custom_field_settings: description: Array of Custom Field Settings (in compact form). readOnly: true type: array items: $ref: '#/components/schemas/CustomFieldSettingResponse' default_view: description: The default view (list, board, calendar, or timeline) of a project. type: string enum: - list - board - calendar - timeline example: calendar due_date: description: >- *Deprecated: new integrations should prefer the `due_on` field.* type: string nullable: true format: date example: '2019-09-15' due_on: description: >- The day on which this project is due. This takes a date with format YYYY-MM-DD. type: string nullable: true format: date example: '2019-09-15' html_notes: description: >- [Opt In](/docs/inputoutput-options). The notes of the project with formatting as HTML. type: string example: These are things we need to purchase. members: description: Array of users who are members of this project. type: array items: $ref: '#/components/schemas/UserCompact' readOnly: true modified_at: description: >- The time at which this project was last modified. *Note: This does not currently reflect any changes in associations such as tasks or comments that may have been added or removed from the project.* type: string readOnly: true format: date-time example: '2012-02-22T02:06:58.147Z' notes: description: >- Free-form textual information associated with the project (ie., its description). type: string example: These are things we need to purchase. public: description: >- True if the project is public to its team. type: boolean example: false start_on: description: >- The day on which work for this project begins, or null if the project has no start date. This takes a date with `YYYY-MM-DD` format. *Note: `due_on` or `due_at` must be present in the request when setting or unsetting the `start_on` parameter. Additionally, `start_on` and `due_on` cannot be the same date.* type: string nullable: true format: date example: '2019-09-14' default_access_level: description: >- The default access for users or teams who join or are added as members to the project. type: string enum: - admin - editor - commenter - viewer example: admin minimum_access_level_for_customization: description: >- The minimum access level needed for project members to modify this project's workflow and appearance. type: string enum: - admin - editor example: admin minimum_access_level_for_sharing: description: >- The minimum access level needed for project members to share the project and manage project memberships. type: string enum: - admin - editor example: admin ProjectBriefBase: allOf: - $ref: '#/components/schemas/ProjectBriefCompact' - type: object properties: title: description: >- The title of the project brief. type: string example: Stuff to buy — Project Brief html_text: description: >- HTML formatted text for the project brief. type: string example: This is a project brief. ProjectBriefCompact: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object description: >- A *Project Brief* allows you to explain the what and why of the project to your team. x-docs-overrides: properties.resource_type.example: project_brief ProjectBriefRequest: allOf: - $ref: '#/components/schemas/ProjectBriefBase' - type: object properties: text: description: >- The plain text of the project brief. When writing to a project brief, you can specify either `html_text` (preferred) or `text`, but not both. type: string example: This is a project brief. ProjectBriefResponse: allOf: - $ref: '#/components/schemas/ProjectBriefBase' - type: object properties: text: description: >- [Opt In](/docs/inputoutput-options). The plain text of the project brief. type: string example: This is a project brief. permalink_url: type: string readOnly: true description: >- A url that points directly to the object within Asana. example: https://app.asana.com/0/11111111/22222222 project: allOf: - $ref: '#/components/schemas/ProjectCompact' - type: object description: >- The project with which this project brief is associated. ProjectCompact: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object description: >- 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. x-docs-overrides: properties.resource_type.example: project properties: 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 ProjectDuplicateRequest: type: object required: - name properties: name: description: The name of the new project. type: string example: New Project Name team: description: >- Sets the team of the new project. If team is not defined, the new project will be in the same team as the the original project. type: string example: '12345' include: description: >- A comma-separated list of elements that will be duplicated to the new project. Tasks are always included. ##### Fields - forms - members - notes - task_assignee - task_attachments - task_dates - task_dependencies - task_followers - task_notes - task_projects - task_subtasks - task_tags type: string pattern: ([members|notes|forms|task_notes|task_assignee|task_subtasks|task_attachments|task_dates|task_dependencies|task_followers|task_tags|task_projects])(,\1)* example: - members,notes,forms,task_notes,task_assignee,task_subtasks,task_attachments,task_dates,task_dependencies,task_followers,task_tags,task_projects schedule_dates: description: >- A dictionary of options to auto-shift dates. `task_dates` must be included to use this option. Requires either `start_on` or `due_on`, but not both. type: object required: - should_skip_weekends properties: should_skip_weekends: description: >- Determines if the auto-shifted dates should skip weekends. type: boolean example: true due_on: description: >- Sets the last due date in the duplicated project to the given date. The rest of the due dates will be offset by the same amount as the due dates in the original project. type: string example: '2019-05-21' start_on: description: >- Sets the first start date in the duplicated project to the given date. The rest of the start dates will be offset by the same amount as the start dates in the original project. type: string example: '2019-05-21' ProjectMembershipBase: $ref: '#/components/schemas/ProjectMembershipCompact' ProjectMembershipCompact: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object description: >- This object describes a team or a user's membership to a project including their level of access (Admin, Editor, Commenter, or Viewer). x-docs-overrides: properties.resource_type.example: project_membership properties: parent: description: >- [Opt In](/docs/inputoutput-options). The project the user is a member of. $ref: '#/components/schemas/ProjectCompact' member: description: Member can be a user or a team. $ref: '#/components/schemas/MemberCompact' 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 ProjectMembershipCompactResponse: allOf: - $ref: '#/components/schemas/ProjectMembershipCompact' - type: object properties: resource_type: description: The base type of this resource. type: string example: membership resource_subtype: description: Type of the membership. type: string example: project_membership ProjectMembershipNormalResponse: allOf: - $ref: '#/components/schemas/ProjectMembershipBase' - type: object properties: user: $ref: '#/components/schemas/UserCompact' project: description: >- [Opt In](/docs/inputoutput-options). The project the user is a member of. $ref: '#/components/schemas/ProjectCompact' resource_type: description: The base type of this resource. type: string example: project_membership write_access: description: >- Whether the member has full access or comment-only access to the project. type: string enum: - full_write - comment_only readOnly: true example: full_write ProjectRequest: allOf: - $ref: '#/components/schemas/ProjectBase' - type: object properties: custom_fields: description: >- An object where each key is the GID of a custom field and its corresponding value is either an enum GID, string, number, or object (depending on the custom field type). See the [custom fields guide](/docs/custom-fields-guide) for details on creating and updating custom field values. type: object additionalProperties: type: string description: >- "{custom_field_gid}" => Value (can be text, a number, etc.). For date, use format "YYYY-MM-DD" (e.g., 2019-09-15). For date-time, use ISO 8601 date string in UTC (e.g., 2019-09-15T02:06:58.147Z). example: '5678904321': On Hold '4578152156': Not Started followers: description: >- *Create-only*. Comma separated string of users. Followers are a subset of members who have opted in to receive "tasks added" notifications for a project. type: string example: 12345,23456 owner: description: >- The current owner of the project, may be null. nullable: true type: string example: '12345' team: description: >- The team that this project is shared with. type: string example: '12345' workspace: type: string description: >- The `gid` of a workspace. example: '12345' ProjectUpdateRequest: allOf: - $ref: '#/components/schemas/ProjectBase' - type: object properties: custom_fields: description: >- An object where each key is the GID of a custom field and its corresponding value is either an enum GID, string, number, or object (depending on the custom field type). See the [custom fields guide](/docs/custom-fields-guide) for details on creating and updating custom field values. type: object additionalProperties: type: string description: >- "{custom_field_gid}" => Value (can be text, a number, etc.). For date, use format "YYYY-MM-DD" (e.g., 2019-09-15). For date-time, use ISO 8601 date string in UTC (e.g., 2019-09-15T02:06:58.147Z). example: '5678904321': On Hold '4578152156': Not Started followers: description: >- *Create-only*. Comma separated string of users. Followers are a subset of members who have opted in to receive "tasks added" notifications for a project. type: string example: 12345,23456 owner: description: >- The current owner of the project, may be null. nullable: true type: string example: '12345' team: description: >- The team that this project is shared with. type: string example: '12345' ProjectResponse: allOf: - $ref: '#/components/schemas/ProjectBase' - type: object properties: custom_fields: description: Array of Custom Fields. readOnly: true type: array items: $ref: '#/components/schemas/CustomFieldCompact' completed: description: >- True if the project is currently marked complete, false if not. type: boolean readOnly: true example: false completed_at: description: >- The time at which this project was completed, or null if the project is not completed. type: string format: date-time readOnly: true nullable: true example: '2012-02-22T02:06:58.147Z' completed_by: allOf: - $ref: '#/components/schemas/UserCompact' - description: >- The user that marked this project complete, or null if the project is not completed. readOnly: true nullable: true followers: description: >- Array of users following this project. Followers are a subset of members who have opted in to receive "tasks added" notifications for a project. type: array items: $ref: '#/components/schemas/UserCompact' readOnly: true owner: description: >- The current owner of the project, may be null. allOf: - $ref: '#/components/schemas/UserCompact' - type: object nullable: true team: allOf: - $ref: '#/components/schemas/TeamCompact' - type: object description: >- The team that this project is shared with. icon: description: >- The icon for a project. type: string nullable: true enum: - list - board - timeline - calendar - rocket - people - graph - star - bug - light_bulb - globe - gear - notebook - computer - check - target - html - megaphone - chat_bubbles - briefcase - page_layout - mountain_flag - puzzle - presentation - line_and_symbols - speed_dial - ribbon - shoe - shopping_basket - map - ticket - coins example: chat_bubbles permalink_url: type: string readOnly: true description: >- A url that points directly to the object within Asana. example: https://app.asana.com/0/resource/123456789/list project_brief: allOf: - $ref: '#/components/schemas/ProjectBriefCompact' - type: object description: >- [Opt In](/docs/inputoutput-options). The project brief associated with this project. nullable: true created_from_template: allOf: - $ref: '#/components/schemas/ProjectTemplateCompact' - type: object description: >- [Opt In](/docs/inputoutput-options). The project template from which this project was created. If the project was not created from a template, this field will be null. nullable: true workspace: allOf: - $ref: '#/components/schemas/WorkspaceCompact' - type: object readOnly: true description: >- *Create-only*. The workspace or organization this project is associated with. Once created, projects cannot be moved to a different workspace. This attribute can only be specified at creation time. If the workspace for your project is an organization, you must also supply a `team` in the request body. ProjectSectionInsertRequest: type: object properties: section: description: The section to reorder. type: string example: '321654' before_section: description: >- Insert the given section immediately before the section specified by this parameter. type: string example: '86420' after_section: description: >- Insert the given section immediately after the section specified by this parameter. type: string example: '987654' required: - section ProjectStatusBase: allOf: - $ref: '#/components/schemas/ProjectStatusCompact' - type: object properties: text: description: The text content of the status update. type: string example: The project is moving forward according to plan... html_text: description: >- [Opt In](/docs/inputoutput-options). The text content of the status update with formatting as HTML. type: string example: >- The project is moving forward according to plan... color: description: The color associated with the status update. type: string enum: - green - yellow - red - blue - complete ProjectStatusCompact: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object description: >- *Deprecated: new integrations should prefer the `status_update` resource.* A *project status* is an update on the progress of a particular project, and is sent out to all project followers when created. These updates include both text describing the update and a color code intended to represent the overall state of the project: "green" for projects that are on track, "yellow" for projects at risk, and "red" for projects that are behind. x-docs-overrides: properties.resource_type.example: project_status properties: title: description: The title of the project status update. type: string example: Status Update - Jun 15 ProjectStatusRequest: $ref: '#/components/schemas/ProjectStatusBase' ProjectStatusResponse: allOf: - $ref: '#/components/schemas/ProjectStatusBase' - type: object properties: author: $ref: '#/components/schemas/UserCompact' 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' created_by: $ref: '#/components/schemas/UserCompact' modified_at: description: >- The time at which this project status was last modified. *Note: This does not currently reflect any changes in associations such as comments that may have been added or removed from the project status.* type: string format: date-time readOnly: true example: '2012-02-22T02:06:58.147Z' ProjectTemplateCompact: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object description: >- A *project template* is an object that allows new projects to be created with a predefined setup, which may include tasks, sections, Rules, etc. It simplifies the process of running a workflow that involves a similar set of work every time. x-docs-overrides: properties.resource_type.example: project_template properties: name: description: >- Name of the project template. type: string example: Packing list ProjectTemplateBase: allOf: - $ref: '#/components/schemas/ProjectTemplateCompact' - type: object properties: description: description: >- Free-form textual information associated with the project template type: string example: These are things we need to pack for a trip. html_description: description: >- The description of the project template with formatting as HTML. type: string example: These are things we need to pack for a trip. public: description: >- True if the project template is public to its team. type: boolean example: false owner: description: >- The current owner of the project template, may be null. allOf: - $ref: '#/components/schemas/UserCompact' - type: object nullable: true team: allOf: - $ref: '#/components/schemas/TeamCompact' requested_dates: description: >- Array of date variables in this project template. Calendar dates must be provided for these variables when instantiating a project. type: array items: $ref: '#/components/schemas/DateVariableCompact' readOnly: true color: description: Color of the project template. type: string nullable: true enum: - dark-pink - dark-green - dark-blue - dark-red - dark-teal - dark-brown - dark-orange - dark-purple - dark-warm-gray - light-pink - light-green - light-blue - light-red - light-teal - light-brown - light-orange - light-purple - light-warm-gray - null example: light-green requested_roles: description: >- Array of template roles in this project template. User Ids can be provided for these variables when instantiating a project to assign template tasks to the user. type: array items: $ref: '#/components/schemas/TemplateRole' ProjectTemplateResponse: allOf: - $ref: '#/components/schemas/ProjectTemplateBase' ProjectTemplateInstantiateProjectRequest: type: object required: - name properties: name: description: The name of the new project. type: string example: New Project Name team: description: >- *Optional*. Sets the team of the new project. If the project template exists in an _organization_, you may specify a value for `team`. If no value is provided then it defaults to the same team as the project template. type: string example: '12345' public: description: >- Sets the project to public to its team. type: boolean example: true is_strict: description: >- *Optional*. If set to `true`, the endpoint returns an "Unprocessable Entity" error if you fail to provide a calendar date value for any date variable. If set to `false`, a default date is used for each unfulfilled date variable (e.g., the current date is used as the Start Date of a project). type: boolean example: true requested_dates: description: >- Array of mappings of date variables to calendar dates. type: array items: $ref: '#/components/schemas/DateVariableRequest' requested_roles: description: >- Array of mappings of template roles to user ids type: array items: $ref: '#/components/schemas/RequestedRoleRequest' DateVariableCompact: type: object properties: gid: description: >- Globally unique identifier of the date field in the project template. A value of `1` refers to the project start date, while `2` refers to the project due date. type: string readOnly: true example: '1' name: description: >- The name of the date variable. type: string readOnly: true example: Start Date description: description: >- The description of what the date variable is used for when instantiating a project. type: string readOnly: true example: Choose a start date for your project. DateVariableRequest: type: object properties: gid: description: >- Globally unique identifier of the date field in the project template. A value of `1` refers to the project start date, while `2` refers to the project due date. type: string example: '1' value: description: >- The date with which the date variable should be replaced when instantiating a project. This takes a date with `YYYY-MM-DD` format. type: string nullable: true format: date-time example: '2022-01-01' RequestedRoleRequest: type: object properties: gid: description: >- Globally unique identifier of the template role in the project template. type: string example: '1' value: description: >- The user id that should be assigned to the template role. type: string example: '123' ProjectSaveAsTemplateRequest: type: object required: - name - public properties: name: description: The name of the new project template. type: string example: New Project Template team: description: >- Sets the team of the new project template. If the project exists in an organization, specify team and not workspace. type: string example: '12345' workspace: description: >- Sets the workspace of the new project template. Only specify workspace if the project exists in a workspace. type: string example: '12345' public: description: >- Sets the project template to public to its team. type: boolean example: true RuleTriggerRequest: type: object properties: resource: description: >- The ID of the resource. For the duration of the beta, this resource is always a task, and this task must exist in the project in which the rule is created. type: string example: '12345' action_data: type: object additionalProperties: true description: >- The dynamic keys and values of the request. These fields are intended to be used in the action for the rule associated with this trigger. example: jira_ticket_name: Test jira_ticket_id: '123' required: - resource - action_data RuleTriggerResponse: type: object properties: message: description: >- Message providing more detail about the result type: string example: Successfully saved the payload and ran the rule RemoveCustomFieldSettingRequest: type: object required: - custom_field properties: custom_field: description: The custom field to remove from this portfolio. type: string example: '14916' RemoveFollowersRequest: type: object required: - followers properties: followers: description: >- An array of strings identifying users. These can either be the string "me", an email, or the gid of a user. type: string example: 521621,621373 RemoveMembersRequest: type: object required: - members properties: members: description: >- An array of strings identifying users. These can either be the string "me", an email, or the gid of a user. type: string example: 521621,621373 SectionBase: $ref: '#/components/schemas/SectionCompact' SectionCompact: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object description: >- A *section* is a subdivision of a project that groups tasks together. It can either be a header above a list of tasks in a list view or a column in a board view of a project. x-docs-overrides: properties.resource_type.example: section properties: name: description: >- The name of the section (i.e. the text displayed as the section header). type: string example: Next Actions SectionRequest: type: object properties: name: description: >- The text to be displayed as the section name. This cannot be an empty string. type: string example: Next Actions insert_before: description: >- An existing section within this project before which the added section should be inserted. Cannot be provided together with insert_after. type: string example: '86420' insert_after: description: >- An existing section within this project after which the added section should be inserted. Cannot be provided together with insert_before. type: string example: '987654' required: - name SectionResponse: allOf: - $ref: '#/components/schemas/SectionBase' - type: object properties: 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' project: $ref: '#/components/schemas/ProjectCompact' projects: description: >- *Deprecated - please use project instead* type: array readOnly: true items: $ref: '#/components/schemas/ProjectCompact' SectionTaskInsertRequest: type: object properties: task: description: The task to add to this section. type: string example: '123456' insert_before: description: >- An existing task within this section before which the added task should be inserted. Cannot be provided together with insert_after. type: string example: '86420' insert_after: description: >- An existing task within this section after which the added task should be inserted. Cannot be provided together with insert_before. type: string example: '987654' required: - task StatusUpdateBase: allOf: - $ref: '#/components/schemas/StatusUpdateCompact' - type: object required: - text - status_type properties: text: description: The text content of the status update. type: string example: The project is moving forward according to plan... html_text: description: >- [Opt In](/docs/inputoutput-options). The text content of the status update with formatting as HTML. type: string example: >- The project is moving forward according to plan... status_type: description: The type associated with the status update. This represents the current state of the object this object is on. type: string enum: - on_track - at_risk - off_track - on_hold - complete - achieved - partial - missed - dropped StatusUpdateCompact: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object description: >- A *status update* is an update on the progress of a particular project, portfolio, or goal, and is sent out to all of its parent's followers when created. These updates include both text describing the update and a `status_type` intended to represent the overall state of the project. x-docs-overrides: properties.resource_type.example: status_update properties: title: description: The title of the status update. type: string example: Status Update - Jun 15 resource_subtype: type: string description: >- The subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning. The `resource_subtype`s for `status` objects represent the type of their parent. enum: - project_status_update - portfolio_status_update - goal_status_update example: project_status_update readOnly: true StatusUpdateRequest: allOf: - $ref: '#/components/schemas/StatusUpdateBase' - type: object required: - parent properties: parent: allOf: - type: string description: >- The id of parent to send this status update to. This can be a project, goal or portfolio. StatusUpdateResponse: allOf: - $ref: '#/components/schemas/StatusUpdateBase' - type: object properties: author: $ref: '#/components/schemas/UserCompact' 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' created_by: $ref: '#/components/schemas/UserCompact' hearted: description: >- *Deprecated - please use liked instead* True if the status is hearted by the authorized user, false if not. type: boolean example: true readOnly: true hearts: description: >- *Deprecated - please use likes instead* Array of likes for users who have hearted this status. type: array items: $ref: '#/components/schemas/Like' readOnly: true liked: description: >- True if the status is liked by the authorized user, false if not. type: boolean example: true likes: description: Array of likes for users who have liked this status. type: array items: $ref: '#/components/schemas/Like' readOnly: true modified_at: description: >- The time at which this project status was last modified. *Note: This does not currently reflect any changes in associations such as comments that may have been added or removed from the status.* type: string format: date-time readOnly: true example: '2012-02-22T02:06:58.147Z' num_hearts: description: >- *Deprecated - please use likes instead* The number of users who have hearted this status. type: integer example: 5 readOnly: true num_likes: description: The number of users who have liked this status. type: integer example: 5 readOnly: true parent: allOf: - $ref: '#/components/schemas/ProjectCompact' - type: object description: >- The parent of the status update. This can be a project, goal or portfolio, and indicates that this status was sent on that object. StoryBase: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object description: >- A story represents an activity associated with an object in the Asana system. x-docs-overrides: properties.resource_type.example: story properties: 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' resource_subtype: description: >- The subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning. type: string readOnly: true example: comment_added text: description: The plain text of the comment to add. Cannot be used with html_text. type: string example: This is a comment. html_text: description: >- [Opt In](/docs/inputoutput-options). HTML formatted text for a comment. This will not include the name of the creator. type: string example: This is a comment. is_pinned: description: >- *Conditional*. Whether the story should be pinned on the resource. type: boolean example: false sticker_name: description: >- The name of the sticker in this story. `null` if there is no sticker. type: string enum: - green_checkmark - people_dancing - dancing_unicorn - heart - party_popper - people_waving_flags - splashing_narwhal - trophy - yeti_riding_unicorn - celebrating_people - determined_climbers - phoenix_spreading_love example: dancing_unicorn StoryCompact: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object description: >- A story represents an activity associated with an object in the Asana system. x-docs-overrides: properties.resource_type.example: story properties: 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' created_by: $ref: '#/components/schemas/UserCompact' resource_subtype: description: >- The subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning. type: string readOnly: true example: comment_added text: description: >- *Create-only*. Human-readable text for the story or comment. This will not include the name of the creator. *Note: This is not guaranteed to be stable for a given type of story. For example, text for a reassignment may not always say “assigned to …” as the text for a story can both be edited and change based on the language settings of the user making the request.* Use the `resource_subtype` property to discover the action that created the story. type: string example: marked today StoryRequest: $ref: '#/components/schemas/StoryBase' StoryResponse: allOf: - $ref: '#/components/schemas/StoryBase' - type: object properties: created_by: $ref: '#/components/schemas/UserCompact' type: type: string enum: - comment - system readOnly: true example: comment is_editable: description: >- *Conditional*. Whether the text of the story can be edited after creation. type: boolean readOnly: true example: false is_edited: description: >- *Conditional*. Whether the text of the story has been edited after creation. type: boolean readOnly: true example: false hearted: description: >- *Deprecated - please use likes instead* *Conditional*. True if the story is hearted by the authorized user, false if not. type: boolean readOnly: true example: false hearts: description: |- *Deprecated - please use likes instead* *Conditional*. Array of likes for users who have hearted this story. type: array items: $ref: '#/components/schemas/Like' readOnly: true num_hearts: description: |- *Deprecated - please use likes instead* *Conditional*. The number of users who have hearted this story. type: integer readOnly: true example: 5 liked: description: >- *Conditional*. True if the story is liked by the authorized user, false if not. type: boolean readOnly: true example: false likes: description: >- *Conditional*. Array of likes for users who have liked this story. type: array items: $ref: '#/components/schemas/Like' readOnly: true num_likes: description: >- *Conditional*. The number of users who have liked this story. type: integer readOnly: true example: 5 previews: description: >- *Conditional*. A collection of previews to be displayed in the story. *Note: This property only exists for comment stories.* type: array items: $ref: '#/components/schemas/Preview' readOnly: true old_name: description: >- *Conditional*' type: string example: This was the Old Name new_name: description: >- *Conditional* type: string nullable: true readOnly: true example: This is the New Name old_dates: $ref: '#/components/schemas/StoryResponseDates' new_dates: $ref: '#/components/schemas/StoryResponseDates' old_resource_subtype: description: >- *Conditional* type: string readOnly: true example: default_task new_resource_subtype: description: >- *Conditional* type: string readOnly: true example: milestone story: description: >- *Conditional* $ref: '#/components/schemas/StoryCompact' readOnly: true assignee: description: >- *Conditional* $ref: '#/components/schemas/UserCompact' readOnly: true follower: description: >- *Conditional* $ref: '#/components/schemas/UserCompact' readOnly: true old_section: description: >- *Conditional* $ref: '#/components/schemas/SectionCompact' readOnly: true new_section: description: >- *Conditional* $ref: '#/components/schemas/SectionCompact' readOnly: true task: description: >- *Conditional* $ref: '#/components/schemas/TaskCompact' readOnly: true project: description: >- *Conditional* $ref: '#/components/schemas/ProjectCompact' readOnly: true tag: description: >- *Conditional* $ref: '#/components/schemas/TagCompact' readOnly: true custom_field: description: >- *Conditional* $ref: '#/components/schemas/CustomFieldCompact' readOnly: true old_text_value: description: >- *Conditional* type: string readOnly: true example: This was the Old Text new_text_value: description: >- *Conditional* type: string readOnly: true example: This is the New Text old_number_value: description: >- *Conditional* type: integer nullable: true readOnly: true example: 1 new_number_value: description: >- *Conditional* type: integer readOnly: true example: 2 old_enum_value: description: >- *Conditional* $ref: '#/components/schemas/EnumOption' readOnly: true new_enum_value: description: >- *Conditional* $ref: '#/components/schemas/EnumOption' readOnly: true old_date_value: allOf: - $ref: '#/components/schemas/StoryResponseDates' - description: >- *Conditional*. The old value of a date custom field story. readOnly: true new_date_value: allOf: - $ref: '#/components/schemas/StoryResponseDates' - description: >- *Conditional* The new value of a date custom field story. readOnly: true old_people_value: description: >- *Conditional*. The old value of a people custom field story. type: array items: $ref: '#/components/schemas/UserCompact' readOnly: true new_people_value: description: >- *Conditional*. The new value of a people custom field story. type: array items: $ref: '#/components/schemas/UserCompact' readOnly: true old_multi_enum_values: description: >- *Conditional*. The old value of a multi-enum custom field story. type: array items: $ref: '#/components/schemas/EnumOption' readOnly: true new_multi_enum_values: description: >- *Conditional*. The new value of a multi-enum custom field story. type: array items: $ref: '#/components/schemas/EnumOption' readOnly: true new_approval_status: description: >- *Conditional*. The new value of approval status. type: string readOnly: true example: approved old_approval_status: description: >- *Conditional*. The old value of approval status. type: string readOnly: true example: pending duplicate_of: description: >- *Conditional* $ref: '#/components/schemas/TaskCompact' readOnly: true duplicated_from: description: >- *Conditional* $ref: '#/components/schemas/TaskCompact' readOnly: true dependency: description: >- *Conditional* $ref: '#/components/schemas/TaskCompact' readOnly: true source: description: >- The component of the Asana product the user used to trigger the story. type: string enum: - web - email - mobile - api - unknown readOnly: true example: web target: allOf: - $ref: '#/components/schemas/TaskCompact' - type: object readOnly: true description: >- The object this story is associated with. Currently may only be a task. StoryResponseDates: description: >- *Conditional* type: object readOnly: true properties: start_on: description: >- The day on which work for this goal begins, or null if the goal has no start date. This takes a date with `YYYY-MM-DD` format, and cannot be set unless there is an accompanying due date. type: string format: date example: '2019-09-14' nullable: true due_at: description: >- The UTC date and time on which this task is due, or null if the task has no due time. This takes an ISO 8601 date string in UTC and should not be used together with `due_on`. type: string format: date-time example: '2019-09-15T02:06:58.158Z' nullable: true due_on: description: >- The localized day on which this goal is due. This takes a date with format `YYYY-MM-DD`. type: string format: date example: '2019-09-15' TagBase: allOf: - $ref: '#/components/schemas/TagCompact' - type: object properties: color: type: string description: Color of the tag. nullable: true enum: - dark-pink - dark-green - dark-blue - dark-red - dark-teal - dark-brown - dark-orange - dark-purple - dark-warm-gray - light-pink - light-green - light-blue - light-red - light-teal - light-brown - light-orange - light-purple - light-warm-gray - null example: light-green notes: description: >- Free-form textual information associated with the tag (i.e. its description). type: string example: Mittens really likes the stuff from Humboldt. TagCompact: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object description: >- A *tag* is a label that can be attached to any task in Asana. It exists in a single workspace or organization. x-docs-overrides: properties.resource_type.example: tag properties: name: description: >- Name of the tag. 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 TagCreateTagForWorkspaceRequest: allOf: - $ref: '#/components/schemas/TagBase' - type: object properties: followers: type: array description: >- An array of strings identifying users. These can either be the string "me", an email, or the gid of a user. items: type: string example: - '12345' - '42563' TagRequest: allOf: - $ref: '#/components/schemas/TagBase' - type: object properties: followers: type: array description: >- An array of strings identifying users. These can either be the string "me", an email, or the gid of a user. items: type: string example: - '12345' - '42563' workspace: type: string x-env-variable: true description: >- Gid of an object. example: '12345' TagResponse: allOf: - $ref: '#/components/schemas/TagBase' - type: object properties: 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' followers: description: Array of users following this tag. type: array readOnly: true items: $ref: '#/components/schemas/UserCompact' workspace: $ref: '#/components/schemas/WorkspaceCompact' permalink_url: type: string readOnly: true description: >- A url that points directly to the object within Asana. example: https://app.asana.com/0/resource/123456789/list TaskAddFollowersRequest: type: object properties: followers: description: >- An array of strings identifying users. These can either be the string "me", an email, or the gid of a user. type: array items: type: string example: - '13579' - '321654' required: - followers TaskAddProjectRequest: type: object properties: project: description: The project to add the task to. type: string example: '13579' insert_after: description: >- A task in the project to insert the task after, or `null` to insert at the beginning of the list. type: string nullable: true example: '124816' insert_before: description: >- A task in the project to insert the task before, or `null` to insert at the end of the list. type: string nullable: true example: '432134' section: description: >- A section in the project to insert the task into. The task will be inserted at the bottom of the section. type: string nullable: true example: '987654' required: - project TaskAddTagRequest: type: object properties: tag: description: The tag to add to the task. type: string example: '13579' required: - tag TaskBase: allOf: - $ref: '#/components/schemas/TaskCompact' - type: object properties: approval_status: type: string description: >- *Conditional* Reflects the approval status of this task. This field is kept in sync with `completed`, meaning `pending` translates to false while `approved`, `rejected`, and `changes_requested` translate to true. If you set completed to true, this field will be set to `approved`. enum: - pending - approved - rejected - changes_requested example: pending assignee_status: description: >- *Deprecated* Scheduling status of this task for the user it is assigned to. This field can only be set if the assignee is non-null. Setting this field to "inbox" or "upcoming" inserts it at the top of the section, while the other options will insert at the bottom. type: string enum: - today - upcoming - later - new - inbox example: upcoming completed: description: >- True if the task is currently marked complete, false if not. type: boolean example: false completed_at: description: >- The time at which this task was completed, or null if the task is incomplete. type: string format: date-time readOnly: true nullable: true example: '2012-02-22T02:06:58.147Z' completed_by: allOf: - $ref: '#/components/schemas/UserCompact' - readOnly: true nullable: true 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' dependencies: description: >- [Opt In](/docs/inputoutput-options). Array of resources referencing tasks that this task depends on. The objects contain only the gid of the dependency. type: array items: $ref: '#/components/schemas/AsanaResource' readOnly: true dependents: description: >- [Opt In](/docs/inputoutput-options). Array of resources referencing tasks that depend on this task. The objects contain only the ID of the dependent. type: array items: $ref: '#/components/schemas/AsanaResource' readOnly: true due_at: description: >- The UTC date and time on which this task is due, or null if the task has no due time. This takes an ISO 8601 date string in UTC and should not be used together with `due_on`. type: string format: date-time example: '2019-09-15T02:06:58.147Z' nullable: true due_on: description: >- The localized date on which this task is due, or null if the task has no due date. This takes a date with `YYYY-MM-DD` format and should not be used together with `due_at`. type: string format: date example: '2019-09-15' nullable: true external: description: >- *OAuth Required*. *Conditional*. This field is returned only if external values are set or included by using [Opt In] (/docs/inputoutput-options). The external field allows you to store app-specific metadata on tasks, including a gid that can be used to retrieve tasks and a data blob that can store app-specific character strings. Note that you will need to authenticate with Oauth to access or modify this data. Once an external gid is set, you can use the notation `external:custom_gid` to reference your object anywhere in the API where you may use the original object gid. See the page on Custom External Data for more details. type: object properties: gid: type: string example: '1234' data: type: string example: A blob of information. example: gid: my_gid data: A blob of information html_notes: description: >- [Opt In](/docs/inputoutput-options). The notes of the text with formatting as HTML. type: string example: >- Mittens really likes the stuff from Humboldt. hearted: description: >- *Deprecated - please use liked instead* True if the task is hearted by the authorized user, false if not. type: boolean example: true readOnly: true hearts: description: >- *Deprecated - please use likes instead* Array of likes for users who have hearted this task. type: array items: $ref: '#/components/schemas/Like' readOnly: true is_rendered_as_separator: description: >- [Opt In](/docs/inputoutput-options). In some contexts tasks can be rendered as a visual separator; for instance, subtasks can appear similar to [sections](/reference/sections) without being true `section` objects. If a `task` object is rendered this way in any context it will have the property `is_rendered_as_separator` set to `true`. type: boolean example: false readOnly: true liked: description: >- True if the task is liked by the authorized user, false if not. type: boolean example: true likes: description: Array of likes for users who have liked this task. type: array items: $ref: '#/components/schemas/Like' readOnly: true memberships: description: >- *Create-only*. Array of projects this task is associated with and the section it is in. At task creation time, this array can be used to add the task to specific sections. After task creation, these associations can be modified using the `addProject` and `removeProject` endpoints. Note that over time, more types of memberships may be added to this property. type: array readOnly: true items: type: object properties: project: $ref: '#/components/schemas/ProjectCompact' section: $ref: '#/components/schemas/SectionCompact' modified_at: description: |- The time at which this task was last modified. The following conditions will change `modified_at`: - story is created on a task - story is trashed on a task - attachment is trashed on a task - task is assigned or unassigned - custom field value is changed - the task itself is trashed - Or if any of the following fields are updated: - completed - name - due_date - description - attachments - items - schedule_status The following conditions will _not_ change `modified_at`: - moving to a new container (project, portfolio, etc) - comments being added to the task (but the stories they generate _will_ affect `modified_at`) type: string format: date-time readOnly: true example: '2012-02-22T02:06:58.147Z' name: description: >- Name of the task. 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: Buy catnip notes: description: >- Free-form textual information associated with the task (i.e. its description). type: string example: Mittens really likes the stuff from Humboldt. num_hearts: description: >- *Deprecated - please use likes instead* The number of users who have hearted this task. type: integer example: 5 readOnly: true num_likes: description: The number of users who have liked this task. type: integer example: 5 readOnly: true num_subtasks: description: > [Opt In](/docs/inputoutput-options). The number of subtasks on this task. type: integer example: 3 readOnly: true start_at: description: >- Date and time on which work begins for the task, or null if the task has no start time. This takes an ISO 8601 date string in UTC and should not be used together with `start_on`. *Note: `due_at` must be present in the request when setting or unsetting the `start_at` parameter.* type: string nullable: true format: date-time example: '2019-09-14T02:06:58.147Z' start_on: description: >- The day on which work begins for the task , or null if the task has no start date. This takes a date with `YYYY-MM-DD` format and should not be used together with `start_at`. *Note: `due_on` or `due_at` must be present in the request when setting or unsetting the `start_on` parameter.* type: string nullable: true format: date example: '2019-09-14' actual_time_minutes: description: >- This value represents the sum of all the Time Tracking entries in the Actual Time field on a given Task. It is represented as a nullable long value. type: number example: 200 readOnly: true nullable: true TaskCompact: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object description: >- The *task* is the basic object around which many operations in Asana are centered. x-docs-overrides: properties.resource_type.example: task properties: name: description: The name of the task. type: string example: Bug Task resource_subtype: type: string description: >- The subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning. The resource_subtype `milestone` represent a single moment in time. This means tasks with this subtype cannot have a start_date. enum: - default_task - milestone - section - approval example: default_task created_by: type: object readOnly: true description: >- [Opt In](/docs/inputoutput-options). A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks. properties: gid: description: Globally unique identifier of the resource. type: string example: '1111' resource_type: description: The type of resource. type: string example: user TaskTemplateCompact: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object description: >- A *task template* is an object that allows new tasks to be created with a predefined setup. x-docs-overrides: properties.resource_type.example: task_template properties: name: description: >- Name of the task template. type: string example: Packing list TaskTemplateBase: allOf: - $ref: '#/components/schemas/TaskTemplateCompact' TaskTemplateRecipeCompact: allOf: - type: object properties: name: description: >- Name of the task that will be created from this template. type: string example: Bug Report task_resource_subtype: type: string description: >- The subtype of the task that will be created from this template. enum: - default_task - milestone_task - approval_task example: default_task TaskTemplateRecipe: allOf: - $ref: '#/components/schemas/TaskTemplateRecipeCompact' - type: object properties: description: description: >- Description of the task that will be created from this template. type: string example: >- Please describe the bug you found and how to reproduce it. html_description: description: >- HTML description of the task that will be created from this template. type: string example: >- Please describe the bug you found and how to reproduce it. memberships: description: >- Array of projects that the task created from this template will be added to type: array items: $ref: '#/components/schemas/ProjectCompact' relative_start_on: nullable: true description: >- The number of days after the task has been instantiated on which that the task will start type: integer example: 1 relative_due_on: nullable: true description: >- The number of days after the task has been instantiated on which that the task will be due type: integer example: 2 due_time: nullable: true description: >- The time of day that the task will be due type: string example: 13:15:00.000Z dependencies: description: >- Array of task templates that the task created from this template will depend on type: array items: $ref: '#/components/schemas/TaskTemplateRecipeCompact' dependents: description: >- Array of task templates that will depend on the task created from this template type: array items: $ref: '#/components/schemas/TaskTemplateRecipeCompact' followers: description: >- Array of users that will be added as followers to the task created from this template type: array items: $ref: '#/components/schemas/UserCompact' attachments: description: >- Array of attachments that will be added to the task created from this template type: array items: $ref: '#/components/schemas/AttachmentCompact' subtasks: description: >- Array of subtasks that will be added to the task created from this template type: array items: $ref: '#/components/schemas/TaskTemplateRecipeCompact' custom_fields: description: >- Array of custom fields that will be added to the task created from this template type: array items: $ref: '#/components/schemas/CustomFieldCompact' TaskTemplateResponse: allOf: - $ref: '#/components/schemas/TaskTemplateBase' - type: object properties: name: description: >- Name of the task template. type: string example: Bug Report Template project: description: >- The project that this task template belongs to. nullable: true allOf: - $ref: '#/components/schemas/ProjectCompact' template: description: >- The configuration for the task that will be created from this template. allOf: - $ref: '#/components/schemas/TaskTemplateRecipe' created_by: description: >- The user who created this task template. allOf: - $ref: '#/components/schemas/UserCompact' created_at: description: >- The time at which this task template was created. type: string format: date-time example: '2019-01-01T00:00:00.000Z' TaskCountResponse: description: A response object returned from the task count endpoint. type: object properties: num_tasks: description: The number of tasks in a project. type: integer example: 200 num_incomplete_tasks: description: The number of incomplete tasks in a project. type: integer example: 50 num_completed_tasks: description: The number of completed tasks in a project. type: integer example: 150 num_milestones: description: The number of milestones in a project. type: integer example: 10 num_incomplete_milestones: description: The number of incomplete milestones in a project. type: integer example: 7 num_completed_milestones: description: The number of completed milestones in a project. type: integer example: 3 TaskDuplicateRequest: type: object properties: name: description: The name of the new task. type: string example: New Task Name include: description: >- A comma-separated list of fields that will be duplicated to the new task. ##### Fields - assignee - attachments - dates - dependencies - followers - notes - parent - projects - subtasks - tags type: string pattern: ([notes|assignee|subtasks|attachments|tags|followers|projects|dates|dependencies|parent])(,\1)* example: - notes,assignee,subtasks,attachments,tags,followers,projects,dates,dependencies,parent TaskRemoveFollowersRequest: type: object properties: followers: description: >- An array of strings identifying users. These can either be the string "me", an email, or the gid of a user. type: array items: type: string example: - '13579' - '321654' required: - followers TaskRemoveProjectRequest: type: object properties: project: description: The project to remove the task from. type: string example: '13579' required: - project TaskRemoveTagRequest: type: object properties: tag: description: The tag to remove from the task. type: string example: '13579' required: - tag TaskTemplateInstantiateTaskRequest: type: object properties: name: description: The name of the new task. If not provided, the name of the task template will be used. type: string example: New Task TaskRequest: allOf: - $ref: '#/components/schemas/TaskBase' - type: object properties: assignee: type: string readOnly: false x-env-variable: true description: >- Gid of a user. example: '12345' nullable: true assignee_section: nullable: true type: string description: >- The *assignee section* is a subdivision of a project that groups tasks together in the assignee's "My Tasks" list. It can either be a header above a list of tasks in a list view or a column in a board view of "My Tasks." The `assignee_section` property will be returned in the response only if the request was sent by the user who is the assignee of the task. Note that you can only write to `assignee_section` with the gid of an existing section visible in the user's "My Tasks" list. example: '12345' custom_fields: description: >- An object where each key is the GID of a custom field and its corresponding value is either an enum GID, string, number, object, or array (depending on the custom field type). See the [custom fields guide](/docs/custom-fields-guide) for details on creating and updating custom field values. type: object additionalProperties: type: string description: >- "{custom_field_gid}" => Value (can be text, a number, etc.). For date, use format "YYYY-MM-DD" (e.g., 2019-09-15). For date-time, use ISO 8601 date string in UTC (e.g., 2019-09-15T02:06:58.147Z). example: '5678904321': On Hold '4578152156': Not Started followers: type: array description: >- *Create-Only* An array of strings identifying users. These can either be the string "me", an email, or the gid of a user. In order to change followers on an existing task use `addFollowers` and `removeFollowers`. items: type: string description: >- Gid of a user. example: - '12345' parent: type: string readOnly: false x-env-variable: true description: >- Gid of a task. example: '12345' nullable: true projects: type: array description: >- *Create-Only* Array of project gids. In order to change projects on an existing task use `addProject` and `removeProject`. items: type: string description: >- Gid of a project. example: - '12345' tags: type: array description: >- *Create-Only* Array of tag gids. In order to change tags on an existing task use `addTag` and `removeTag`. items: type: string description: >- Gid of a tag. example: - '12345' workspace: type: string readOnly: false x-env-variable: true description: >- Gid of a workspace. example: '12345' TaskResponse: allOf: - $ref: '#/components/schemas/TaskBase' - type: object properties: assignee: allOf: - $ref: '#/components/schemas/UserCompact' - nullable: true assignee_section: allOf: - $ref: '#/components/schemas/SectionCompact' - type: object nullable: true description: >- The *assignee section* is a subdivision of a project that groups tasks together in the assignee's "My Tasks" list. It can either be a header above a list of tasks in a list view or a column in a board view of "My Tasks." The `assignee_section` property will be returned in the response only if the request was sent by the user who is the assignee of the task. Note that you can only write to `assignee_section` with the gid of an existing section visible in the user's "My Tasks" list. custom_fields: description: >- Array of custom field values applied to the task. These represent the custom field values recorded on this project for a particular custom field. For example, these custom field values will contain an `enum_value` property for custom fields of type `enum`, a `text_value` property for custom fields of type `text`, and so on. Please note that the `gid` returned on each custom field value *is identical* to the `gid` of the custom field, which allows referencing the custom field metadata through the `/custom_fields/custom_field-gid` endpoint. type: array items: $ref: '#/components/schemas/CustomFieldResponse' readOnly: true followers: description: Array of users following this task. type: array readOnly: true items: $ref: '#/components/schemas/UserCompact' parent: allOf: - $ref: '#/components/schemas/TaskCompact' - type: object readOnly: true description: >- The parent of this task, or `null` if this is not a subtask. This property cannot be modified using a PUT request but you can change it with the `setParent` endpoint. You can create subtasks by using the subtasks endpoint. nullable: true projects: description: >- *Create-only.* Array of projects this task is associated with. At task creation time, this array can be used to add the task to many projects at once. After task creation, these associations can be modified using the addProject and removeProject endpoints. type: array readOnly: true items: $ref: '#/components/schemas/ProjectCompact' tags: description: >- Array of tags associated with this task. In order to change tags on an existing task use `addTag` and `removeTag`. type: array readOnly: true items: $ref: '#/components/schemas/TagCompact' example: - gid: '59746' name: Grade A workspace: allOf: - $ref: '#/components/schemas/WorkspaceCompact' - type: object readOnly: true description: >- *Create-only*. The workspace this task is associated with. Once created, task cannot be moved to a different workspace. This attribute can only be specified at creation time. permalink_url: type: string readOnly: true description: >- A url that points directly to the object within Asana. example: https://app.asana.com/0/resource/123456789/list TaskSetParentRequest: type: object properties: parent: description: >- The new parent of the task, or `null` for no parent. type: string example: '987654' insert_after: description: >- A subtask of the parent to insert the task after, or `null` to insert at the beginning of the list. type: string example: 'null' insert_before: description: >- A subtask of the parent to insert the task before, or `null` to insert at the end of the list. type: string example: '124816' required: - parent TeamAddUserRequest: 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' TeamBase: $ref: '#/components/schemas/TeamCompact' TeamCompact: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object description: >- A *team* is used to group related projects and people together within an organization. Each project in an organization is associated with a team. x-docs-overrides: properties.resource_type.example: team properties: name: description: The name of the team. type: string example: Marketing TeamMembershipBase: $ref: '#/components/schemas/TeamMembershipCompact' TeamMembershipCompact: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object description: >- This object represents a user's connection to a team. x-docs-overrides: properties.resource_type.example: team_membership properties: user: $ref: '#/components/schemas/UserCompact' team: $ref: '#/components/schemas/TeamCompact' is_guest: type: boolean description: >- Describes if the user is a guest in the team. example: false is_limited_access: type: boolean readOnly: true description: >- Describes if the user has limited access to the team. example: false is_admin: type: boolean description: >- Describes if the user is a team admin. example: false TeamMembershipResponse: $ref: '#/components/schemas/TeamMembershipBase' TeamRemoveUserRequest: 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' TeamRequest: allOf: - $ref: '#/components/schemas/TeamBase' - type: object properties: description: description: > The description of the team. type: string example: All developers should be members of this team. html_description: description: > The description of the team with formatting as HTML. type: string example: >- All developers should be members of this team. organization: type: string description: > The organization/workspace the team belongs to. This must be the same organization you are in and cannot be changed once set. example: '123456789' visibility: description: > The visibility of the team to users in the same organization type: string enum: - secret - request_to_join - public edit_team_name_or_description_access_level: description: > Controls who can edit team name and description type: string readOnly: true enum: - all_team_members - only_team_admins edit_team_visibility_or_trash_team_access_level: description: > Controls who can edit team visibility and trash teams type: string readOnly: true enum: - all_team_members - only_team_admins member_invite_management_access_level: description: > Controls who can accept or deny member invites for a given team type: string readOnly: true enum: - all_team_members - only_team_admins guest_invite_management_access_level: description: > Controls who can accept or deny guest invites for a given team type: string readOnly: true enum: - all_team_members - only_team_admins join_request_management_access_level: description: > Controls who can accept or deny join team requests for a Membership by Request team type: string readOnly: true enum: - all_team_members - only_team_admins team_member_removal_access_level: description: > Controls who can remove team members type: string readOnly: true enum: - all_team_members - only_team_admins TeamResponse: allOf: - $ref: '#/components/schemas/TeamBase' - type: object properties: description: description: > [Opt In](/docs/inputoutput-options). The description of the team. type: string example: All developers should be members of this team. html_description: description: > [Opt In](/docs/inputoutput-options). The description of the team with formatting as HTML. type: string example: >- All developers should be members of this team. organization: allOf: - $ref: '#/components/schemas/WorkspaceCompact' - type: object description: | The organization/workspace the team belongs to. permalink_url: type: string readOnly: true description: >- A url that points directly to the object within Asana. example: https://app.asana.com/0/resource/123456789/list visibility: description: > The visibility of the team to users in the same organization type: string enum: - secret - request_to_join - public edit_team_name_or_description_access_level: description: > Controls who can edit team name and description type: string readOnly: true enum: - all_team_members - only_team_admins edit_team_visibility_or_trash_team_access_level: description: > Controls who can edit team visibility and trash teams type: string readOnly: true enum: - all_team_members - only_team_admins member_invite_management_access_level: description: > Controls who can accept or deny member invites for a given team type: string readOnly: true enum: - all_team_members - only_team_admins guest_invite_management_access_level: description: > Controls who can accept or deny guest invites for a given team type: string readOnly: true enum: - all_team_members - only_team_admins join_request_management_access_level: description: > Controls who can accept or deny join team requests for a Membership by Request team type: string readOnly: true enum: - all_team_members - only_team_admins team_member_removal_access_level: description: > Controls who can remove team members type: string readOnly: true enum: - all_team_members - only_team_admins TemplateRole: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object properties: name: type: string description: >- Name of the template role. example: Designer TimePeriodBase: allOf: - $ref: '#/components/schemas/TimePeriodCompact' - type: object properties: parent: allOf: - $ref: '#/components/schemas/TimePeriodCompact' - nullable: true TimePeriodCompact: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object x-docs-overrides: properties.resource_type.example: time_period properties: end_on: type: string description: >- The localized end date of the time period in `YYYY-MM-DD` format. example: '2019-09-14' start_on: type: string description: >- The localized start date of the time period in `YYYY-MM-DD` format. example: '2019-09-13' period: type: string description: >- The cadence and index of the time period. The value is one of: `FY`, `H1`, `H2`, `Q1`, `Q2`, `Q3`, or `Q4`. enum: - FY - H1 - H2 - Q1 - Q2 - Q3 - Q4 example: Q1 display_name: type: string description: >- A string representing the cadence code and the fiscal year. example: Q1 FY22 TimePeriodResponse: $ref: '#/components/schemas/TimePeriodBase' UserBase: $ref: '#/components/schemas/UserCompact' UserCompact: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object description: >- A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks. x-docs-overrides: properties.resource_type.example: user properties: name: type: string description: >- *Read-only except when same user as requester*. The user’s name. example: Greg Sanchez UserRequest: $ref: '#/components/schemas/UserBase' UserBaseResponse: allOf: - $ref: '#/components/schemas/UserBase' - type: object properties: email: type: string format: email readOnly: true description: The user's email address. example: gsanchez@example.com photo: type: object nullable: true properties: image_21x21: type: string format: uri image_27x27: type: string format: uri image_36x36: type: string format: uri image_60x60: type: string format: uri image_128x128: type: string format: uri image_1024x1024: type: string format: uri readOnly: true description: >- A map of the user’s profile photo in various sizes, or null if no photo is set. Sizes provided are 21, 27, 36, 60, 128, and 1024. All images are in PNG format, except for 1024 (which is in JPEG format). example: image_21x21: https://... image_27x27: https://... image_36x36: https://... image_60x60: https://... image_128x128: https://... image_1024x1024: https://... UserResponse: allOf: - $ref: '#/components/schemas/UserBaseResponse' - type: object properties: workspaces: description: >- Workspaces and organizations this user may access. Note\: The API will only return workspaces and organizations that also contain the authenticated user. readOnly: true type: array items: $ref: '#/components/schemas/WorkspaceCompact' UserTaskListBase: $ref: '#/components/schemas/UserTaskListCompact' UserTaskListCompact: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object description: >- 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. x-docs-overrides: properties.resource_type.example: user_task_list properties: 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: - $ref: '#/components/schemas/UserCompact' workspace: description: The workspace in which the user task list is located. readOnly: true allOf: - $ref: '#/components/schemas/WorkspaceCompact' UserTaskListRequest: $ref: '#/components/schemas/UserTaskListBase' UserTaskListResponse: $ref: '#/components/schemas/UserTaskListBase' WebhookCompact: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object description: >- Webhook objects represent the state of an active subscription for a server to be updated with information from Asana. This schema represents the subscription itself, not the objects that are sent to the server. For information on those please refer to the [event](/reference/events) schema. x-docs-overrides: properties.resource_type.example: webhook properties: active: description: >- If true, the webhook will send events - if false it is considered inactive and will not generate events. type: boolean readOnly: true example: false resource: $ref: '#/components/schemas/AsanaNamedResource' target: description: The URL to receive the HTTP POST. type: string format: uri readOnly: true example: https://example.com/receive-webhook/7654 WebhookFilter: type: object description: >- A WebhookFilter can be passed on creation of a webhook in order to filter the types of actions that trigger delivery of an [event](/reference/events) properties: resource_type: type: string description: >- The type of the resource which created the event when modified; for example, to filter to changes on regular tasks this field should be set to `task`. example: task resource_subtype: description: >- The resource subtype of the resource that the filter applies to. This should be set to the same value as is returned on the `resource_subtype` field on the resources themselves. type: string example: milestone action: type: string description: >- The type of change on the **resource** to pass through the filter. For more information refer to `Event.action` in the [event](/reference/events) schema. This can be one of `changed`, `added`, `removed`, `deleted`, and `undeleted` depending on the nature of what has occurred on the resource. example: changed fields: type: array description: >- *Conditional.* A whitelist of fields for events which will pass the filter when the resource is changed. These can be any combination of the fields on the resources themselves. This field is only valid for `action` of type `changed` items: type: string example: - due_at - due_on - dependencies WebhookRequest: type: object properties: resource: description: >- A resource ID to subscribe to. Many Asana resources are valid to create webhooks on, but higher-level resources require filters. type: string example: '12345' target: description: >- The URL to receive the HTTP POST. The full URL will be used to deliver events from this webhook (including parameters) which allows encoding of application-specific state when the webhook is created. type: string format: uri example: >- https://example.com/receive-webhook/7654?app_specific_param=app_specific_value filters: type: array description: >- An array of WebhookFilter objects to specify a whitelist of filters to apply to events from this webhook. If a webhook event passes any of the filters the event will be delivered; otherwise no event will be sent to the receiving server. items: allOf: - $ref: '#/components/schemas/WebhookFilter' - description: >- A set of filters to specify a whitelist for what types of events will be delivered. - type: object required: - resource - target WebhookResponse: allOf: - $ref: '#/components/schemas/WebhookCompact' - type: object properties: 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' last_failure_at: description: >- The timestamp when the webhook last received an error when sending an event to the target. type: string format: date-time readOnly: true example: '2012-02-22T02:06:58.147Z' last_failure_content: description: >- The contents of the last error response sent to the webhook when attempting to deliver events to the target. type: string readOnly: true example: 500 Server Error\n\nCould not complete the request last_success_at: description: >- The timestamp when the webhook last successfully sent an event to the target. type: string format: date-time readOnly: true example: '2012-02-22T02:06:58.147Z' filters: description: >- Whitelist of filters to apply to events from this webhook. If a webhook event passes any of the filters the event will be delivered; otherwise no event will be sent to the receiving server. type: array items: allOf: - $ref: '#/components/schemas/WebhookFilter' - description: A set of filters to specify a whitelist for what types of events will be delivered. - type: object WebhookUpdateRequest: type: object properties: filters: type: array description: >- An array of WebhookFilter objects to specify a whitelist of filters to apply to events from this webhook. If a webhook event passes any of the filters the event will be delivered; otherwise no event will be sent to the receiving server. items: allOf: - $ref: '#/components/schemas/WebhookFilter' - description: >- A set of filters to specify a whitelist for what types of events will be delivered. - type: object 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: $ref: '#/components/schemas/WorkspaceCompact' WorkspaceCompact: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object description: >- A *workspace* is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace. x-docs-overrides: properties.resource_type.example: workspace properties: name: description: The name of the workspace. type: string example: My Company Workspace WorkspaceMembershipBase: $ref: '#/components/schemas/WorkspaceMembershipCompact' WorkspaceMembershipCompact: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object description: >- This object determines if a user is a member of a workspace. x-docs-overrides: properties.resource_type.example: workspace_membership properties: user: $ref: '#/components/schemas/UserCompact' workspace: $ref: '#/components/schemas/WorkspaceCompact' WorkspaceMembershipRequest: $ref: '#/components/schemas/WorkspaceMembershipBase' WorkspaceMembershipResponse: allOf: - $ref: '#/components/schemas/WorkspaceMembershipBase' - type: object properties: user_task_list: $ref: '#/components/schemas/UserTaskListResponse' description: >- The user's "My Tasks" in the workspace. 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. 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' 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: $ref: '#/components/schemas/WorkspaceBase' WorkspaceResponse: allOf: - $ref: '#/components/schemas/WorkspaceBase' - type: object properties: 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 GoalMembershipBase: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object description: This object represents a user's connection to a goal. x-docs-overrides: properties.resource_type.example: membership properties: resource_subtype: type: string readOnly: true description: The type of membership. example: goal_membership member: $ref: '#/components/schemas/MemberCompact' parent: allOf: - $ref: '#/components/schemas/GoalCompact' - type: object readOnly: true role: type: string description: >- Describes if the member is a commenter or editor in goal. enum: - commenter - editor example: editor goal: allOf: - $ref: '#/components/schemas/GoalCompact' - type: object readOnly: true deprecated: true description: >- *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. GoalMembershipCompact: allOf: - $ref: '#/components/schemas/GoalMembershipBase' - type: object properties: 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 GoalMembershipResponse: allOf: - $ref: '#/components/schemas/GoalMembershipBase' - type: object properties: user: allOf: - $ref: '#/components/schemas/UserCompact' - type: object deprecated: true readOnly: true description: >- *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. workspace: allOf: - $ref: '#/components/schemas/WorkspaceCompact' - type: object deprecated: true readOnly: true description: >- *Deprecated:* A *workspace* is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace. MembershipRequest: type: object properties: is_active: description: >- *Optional*. Denotes if a member is active. Applies to all memberships type: boolean example: true CreateMembershipRequest: allOf: - $ref: '#/components/schemas/MembershipRequest' - type: object properties: member: description: The gid of the user or team type: string example: 12345 parent: description: The gid of the `goal` type: string example: '987654' MembershipResponse: anyOf: - $ref: '#/components/schemas/GoalMembershipResponse' - $ref: '#/components/schemas/ProjectMembershipCompactResponse' UpdateTimeTrackingEntryRequest: type: object properties: duration_minutes: description: >- *Optional*. Time in minutes tracked by the entry type: integer example: 12 entered_on: description: >- *Optional*. The day that this entry is logged on. Defaults to today if no day specified type: string format: date example: '2023-03-19' CreateTimeTrackingEntryRequest: type: object properties: duration_minutes: description: >- Time in minutes tracked by the entry. Must be greater than 0 type: integer example: 12 entered_on: description: >- *Optional*. The day that this entry is logged on. Defaults to today if not specified type: string format: date example: '2023-03-19' TimeTrackingEntryCompact: allOf: - $ref: '#/components/schemas/AsanaResource' - type: object properties: duration_minutes: description: >- Time in minutes tracked by the entry. type: integer example: 12 entered_on: description: >- The day that this entry is logged on. type: string format: date example: '2015-03-14' created_by: $ref: '#/components/schemas/UserCompact' readOnly: true TimeTrackingEntryBase: allOf: - $ref: '#/components/schemas/TimeTrackingEntryCompact' - type: object properties: task: $ref: '#/components/schemas/TaskCompact' readOnly: true 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' securitySchemes: personalAccessToken: type: http description: >- A personal access token allows access to the api for the user who created it. This should be kept a secret and be treated like a password. scheme: bearer oauth2: type: oauth2 description: >- We require that applications designed to access the Asana API on behalf of multiple users implement OAuth 2.0. Asana supports the Authorization Code Grant flow. flows: authorizationCode: authorizationUrl: https://app.asana.com/-/oauth_authorize tokenUrl: https://app.asana.com/-/oauth_token refreshUrl: https://app.asana.com/-/oauth_token scopes: default: >- Provides access to all endpoints documented in our API reference. If no scopes are requested, this scope is assumed by default. openid: >- Provides access to OpenID Connect ID tokens and the OpenID Connect user info endpoint. email: >- Provides access to the user’s email through the OpenID Connect user info endpoint. profile: >- Provides access to the user’s name and profile photo through the OpenID Connect user info endpoint. paths: /attachments/{attachment_gid}: parameters: - $ref: '#/components/parameters/attachment_path_gid' - $ref: '#/components/parameters/pretty' get: summary: Get an attachment description: Get the full record for a single attachment. tags: - Attachments operationId: getAttachment parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - connected_to_app - created_at - download_url - host - name - parent - parent.created_by - parent.name - parent.resource_subtype - permanent_url - resource_subtype - size - view_url schema: type: array items: type: string enum: - connected_to_app - created_at - download_url - host - name - parent - parent.created_by - parent.name - parent.resource_subtype - permanent_url - resource_subtype - size - view_url style: form explode: false responses: 200: description: Successfully retrieved the record for a single attachment. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/AttachmentResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 402: $ref: '#/components/responses/PaymentRequired' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 424: $ref: '#/components/responses/TooManyRequests' 500: $ref: '#/components/responses/InternalServerError' 501: $ref: '#/components/responses/BadGateway' 503: $ref: '#/components/responses/ServiceUnavailable' 504: $ref: '#/components/responses/GatewayTimeout' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); Attachment result = client.attachments.getAttachment(attachmentGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.attachments.getAttachment(attachmentGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.AttachmentsApi(); let attachment_gid = "12345"; // String | Globally unique identifier for the attachment. let opts = { 'opt_fields': ["connected_to_app","created_at","download_url","host","name","parent","parent.created_by","parent.name","parent.resource_subtype","permanent_url","resource_subtype","size","view_url"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getAttachment(attachment_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.AttachmentsApi(api_client) attachment_gid = '12345' # str | Globally unique identifier for the attachment. opt_fields = ["connected_to_app","created_at","download_url","host","name","parent","parent.created_by","parent.name","parent.resource_subtype","permanent_url","resource_subtype","size","view_url"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get an attachment api_response = api_instance.get_attachment(attachment_gid, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling AttachmentsApi->get_attachment: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.attachments.get_attachment(attachment_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- attachments->getAttachment($attachment_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.attachments.get_attachment(attachment_gid: 'attachment_gid', param: "value", param: "value", options: {pretty: true}) delete: summary: Delete an attachment description: |- Deletes a specific, existing attachment. Returns an empty data record. tags: - Attachments operationId: deleteAttachment responses: 200: description: Successfully deleted the specified attachment. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/EmptyResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.attachments.deleteAttachment(attachmentGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.attachments.deleteAttachment(attachmentGid) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.AttachmentsApi(); let attachment_gid = "12345"; // String | Globally unique identifier for the attachment. apiInstance.deleteAttachment(attachment_gid, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.AttachmentsApi(api_client) attachment_gid = '12345' # str | Globally unique identifier for the attachment. try: # Delete an attachment api_response = api_instance.delete_attachment(attachment_gid) pprint(api_response) except ApiException as e: print("Exception when calling AttachmentsApi->delete_attachment: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.attachments.delete_attachment(attachment_gid, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- attachments->deleteAttachment($attachment_gid, array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.attachments.delete_attachment(attachment_gid: 'attachment_gid', options: {pretty: true}) /attachments: parameters: - $ref: '#/components/parameters/pretty' get: summary: Get attachments from an object description: >- Returns the compact records for all attachments on the object. There are three possible `parent` values for this request: `project`, `project_brief`, and `task`. For a project, an attachment refers to a file uploaded to the "Key resources" section in the project Overview. For a project brief, an attachment refers to inline files in the project brief itself. For a task, an attachment refers to a file directly associated to that task. Note that within the Asana app, inline images in the task description do not appear in the index of image thumbnails nor as stories in the task. However, requests made to `GET /attachments` for a task will return all of the images in the task, including inline images. tags: - Attachments operationId: getAttachmentsForObject parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - name: parent required: true in: query description: >- Globally unique identifier for object to fetch statuses from. Must be a GID for a `project`, `project_brief`, or `task`. schema: type: string example: '159874' - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - connected_to_app - created_at - download_url - host - name - offset - parent - parent.created_by - parent.name - parent.resource_subtype - path - permanent_url - resource_subtype - size - uri - view_url schema: type: array items: type: string enum: - connected_to_app - created_at - download_url - host - name - offset - parent - parent.created_by - parent.name - parent.resource_subtype - path - permanent_url - resource_subtype - size - uri - view_url style: form explode: false responses: 200: description: >- Successfully retrieved the specified object's attachments. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/AttachmentCompact' next_page: $ref: '#/components/schemas/NextPage' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.attachments.getAttachmentsForObject(parent) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.attachments.getAttachmentsForObject({param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.AttachmentsApi(); let parent = "159874"; // String | Globally unique identifier for object to fetch statuses from. Must be a GID for a `project`, `project_brief`, or `task`. let opts = { 'limit': 50, // Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", // String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'opt_fields': ["connected_to_app","created_at","download_url","host","name","offset","parent","parent.created_by","parent.name","parent.resource_subtype","path","permanent_url","resource_subtype","size","uri","view_url"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getAttachmentsForObject(parent, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.AttachmentsApi(api_client) parent = '159874' # str | Globally unique identifier for object to fetch statuses from. Must be a GID for a `project`, `project_brief`, or `task`. limit = 50 # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. (optional) offset = 'eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9' # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' (optional) opt_fields = ["connected_to_app","created_at","download_url","host","name","offset","parent","parent.created_by","parent.name","parent.resource_subtype","path","permanent_url","resource_subtype","size","uri","view_url"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get attachments from an object api_response = api_instance.get_attachments_for_object(parent, limit=limit, offset=offset, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling AttachmentsApi->get_attachments_for_object: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.attachments.get_attachments_for_object({'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- attachments->getAttachmentsForObject(array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.attachments.get_attachments_for_object(parent: ''parent_example'', param: "value", param: "value", options: {pretty: true}) post: summary: Upload an attachment description: |- Upload an attachment. This method uploads an attachment on an object and returns the compact record for the created attachment object. This is possible by either: - Providing the URL of the external resource being attached, or - Downloading the file content first and then uploading it as any other attachment. Note that it is not possible to attach files from third party services such as Dropbox, Box, Vimeo & Google Drive via the API The 100MB size limit on attachments in Asana is enforced on this endpoint. This endpoint expects a multipart/form-data encoded request containing the full contents of the file to be uploaded. Requests made should follow the HTTP/1.1 specification that line terminators are of the form `CRLF` or `\r\n` outlined [here](http://www.w3.org/Protocols/HTTP/1.1/draft-ietf-http-v11-spec-01#Basic-Rules) in order for the server to reliably and properly handle the request. tags: - Attachments operationId: createAttachmentForObject parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - connected_to_app - created_at - download_url - host - name - parent - parent.created_by - parent.name - parent.resource_subtype - permanent_url - resource_subtype - size - view_url schema: type: array items: type: string enum: - connected_to_app - created_at - download_url - host - name - parent - parent.created_by - parent.name - parent.resource_subtype - permanent_url - resource_subtype - size - view_url style: form explode: false requestBody: description: |- The file you want to upload. *Note when using curl:* Be sure to add an `‘@’` before the file path, and use the `--form` option instead of the `-d` option. When uploading PDFs with curl, force the content-type to be pdf by appending the content type to the file path: `--form "file=@file.pdf;type=application/pdf"`. content: multipart/form-data: schema: $ref: '#/components/schemas/AttachmentRequest' responses: 200: description: Successfully uploaded the attachment to the parent object. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/AttachmentResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); Attachment result = client.attachments.createAttachmentForObject(file, parent, url, name) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; const fs = require("fs"); // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.AttachmentsApi(); let opts = { 'resource_subtype': "external" // String | 'file': fs.createReadStream("file_example") // Blob | 'parent': "parent_example" // String | 'url': "url_example" // String | 'name': "name_example" // String | 'connect_to_app': true // Boolean | 'opt_fields': ["connected_to_app","created_at","download_url","host","name","parent","parent.created_by","parent.name","parent.resource_subtype","permanent_url","resource_subtype","size","view_url"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.createAttachmentForObject(opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.AttachmentsApi(api_client) resource_subtype = 'external' # str | (optional) file = 'file_example' # str | (optional) parent = 'parent_example' # str | (optional) url = 'url_example' # str | (optional) name = 'name_example' # str | (optional) connect_to_app = true # bool | (optional) opt_fields = ["connected_to_app","created_at","download_url","host","name","parent","parent.created_by","parent.name","parent.resource_subtype","permanent_url","resource_subtype","size","view_url"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Upload an attachment api_response = api_instance.create_attachment_for_object(resource_subtype=resource_subtype, file=file, parent=parent, url=url, name=name, connect_to_app=connect_to_app, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling AttachmentsApi->create_attachment_for_object: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.attachments.create_attachment_for_object({'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- attachments->createAttachmentForObject(array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.attachments.create_attachment_for_object(field: "value", field: "value", options: {pretty: true}) /workspaces/{workspace_gid}/audit_log_events: parameters: - $ref: '#/components/parameters/workspace_path_gid' - $ref: '#/components/parameters/audit_log_start_at' - $ref: '#/components/parameters/audit_log_end_at' - $ref: '#/components/parameters/audit_log_event_type' - $ref: '#/components/parameters/audit_log_actor_type' - $ref: '#/components/parameters/audit_log_actor_gid' - $ref: '#/components/parameters/audit_log_resource_gid' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' get: summary: Get audit log events description: >- Retrieve the audit log events that have been captured in your domain. This endpoint will return a list of [AuditLogEvent](/reference/audit-log-api) objects, sorted by creation time in ascending order. Note that the Audit Log API captures events from October 8th, 2021 and later. Queries for events before this date will not return results. There are a number of query parameters (below) that can be used to filter the set of [AuditLogEvent](/reference/audit-log-api) objects that are returned in the response. Any combination of query parameters is valid. When no filters are provided, all of the events that have been captured in your domain will match. The list of events will always be [paginated](/docs/pagination). The default limit is 1000 events. The next set of events can be retrieved using the `offset` from the previous response. If there are no events that match the provided filters in your domain, the endpoint will return `null` for the `next_page` field. Querying again with the same filters may return new events if they were captured after the last request. Once a response includes a `next_page` with an `offset`, subsequent requests can be made with the latest `offset` to poll for new events that match the provided filters. *Note: If the filters you provided match events in your domain and `next_page` is present in the response, we will continue to send `next_page` on subsequent requests even when there are no more events that match the filters. This was put in place so that you can implement an audit log stream that will return future events that match these filters. If you are not interested in future events that match the filters you have defined, you can rely on checking empty `data` response for the end of current events that match your filters.* When no `offset` is provided, the response will begin with the oldest events that match the provided filters. It is important to note that [AuditLogEvent](/reference/audit-log-api) objects will be permanently deleted from our systems after 90 days. If you wish to keep a permanent record of these events, we recommend using a SIEM tool to ingest and store these logs. tags: - Audit log API operationId: getAuditLogEvents responses: 200: description: >- AuditLogEvents were successfully retrieved. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/AuditLogEvent' next_page: $ref: '#/components/schemas/NextPage' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.auditlogapi.getAuditLogEvents(workspaceGid, resourceGid, actorGid, actorType, eventType, endAt, startAt) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.auditlogapi.getAuditLogEvents(workspaceGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.AuditLogAPIApi(); let workspace_gid = "12345"; // String | Globally unique identifier for the workspace or organization. let opts = { 'start_at': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter to events created after this time (inclusive). 'end_at': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter to events created before this time (exclusive). 'event_type': "event_type_example", // String | Filter to events of this type. Refer to the [supported audit log events](/docs/audit-log-events#supported-audit-log-events) for a full list of values. 'actor_type': "actor_type_example", // String | Filter to events with an actor of this type. This only needs to be included if querying for actor types without an ID. If `actor_gid` is included, this should be excluded. 'actor_gid': "actor_gid_example", // String | Filter to events triggered by the actor with this ID. 'resource_gid': "resource_gid_example", // String | Filter to events with this resource ID. 'limit': 50, // Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9" // String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' }; apiInstance.getAuditLogEvents(workspace_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.AuditLogAPIApi(api_client) workspace_gid = '12345' # str | Globally unique identifier for the workspace or organization. start_at = '2013-10-20T19:20:30+01:00' # datetime | Filter to events created after this time (inclusive). (optional) end_at = '2013-10-20T19:20:30+01:00' # datetime | Filter to events created before this time (exclusive). (optional) event_type = 'event_type_example' # str | Filter to events of this type. Refer to the [supported audit log events](/docs/audit-log-events#supported-audit-log-events) for a full list of values. (optional) actor_type = 'actor_type_example' # str | Filter to events with an actor of this type. This only needs to be included if querying for actor types without an ID. If `actor_gid` is included, this should be excluded. (optional) actor_gid = 'actor_gid_example' # str | Filter to events triggered by the actor with this ID. (optional) resource_gid = 'resource_gid_example' # str | Filter to events with this resource ID. (optional) limit = 50 # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. (optional) offset = 'eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9' # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' (optional) try: # Get audit log events api_response = api_instance.get_audit_log_events(workspace_gid, start_at=start_at, end_at=end_at, event_type=event_type, actor_type=actor_type, actor_gid=actor_gid, resource_gid=resource_gid, limit=limit, offset=offset) pprint(api_response) except ApiException as e: print("Exception when calling AuditLogAPIApi->get_audit_log_events: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.audit_log_api.get_audit_log_events(workspace_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- auditlogapi->getAuditLogEvents($workspace_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.audit_log_api.get_audit_log_events(workspace_gid: 'workspace_gid', param: "value", param: "value", options: {pretty: true}) /batch: parameters: - $ref: '#/components/parameters/pretty' post: summary: Submit parallel requests description: |- Make multiple requests in parallel to Asana's API. tags: - Batch API operationId: createBatchRequest parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - body - headers - status_code schema: type: array items: type: string enum: - body - headers - status_code style: form explode: false requestBody: description: >- The requests to batch together via the Batch API. required: true content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/BatchRequest' responses: 200: description: Successfully completed the requested batch API operations. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/BatchResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.batchapi.createBatchRequest() .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.batchapi.createBatchRequest({field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.BatchAPIApi(); let body = new Asana.BatchBody.constructFromObject({data: {param1: "value1", param2: "value2",}}); // BatchBody | The requests to batch together via the Batch API. let opts = { 'opt_fields': ["body","headers","status_code"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.createBatchRequest(body, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.BatchAPIApi(api_client) body = asana.BatchBody({"param1": "value1", "param2": "value2",}) # BatchBody | The requests to batch together via the Batch API. opt_fields = ["body","headers","status_code"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Submit parallel requests api_response = api_instance.create_batch_request(body, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling BatchAPIApi->create_batch_request: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.batch_api.create_batch_request({'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- batchapi->createBatchRequest(array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.batch_api.create_batch_request(field: "value", field: "value", options: {pretty: true}) /projects/{project_gid}/custom_field_settings: parameters: - $ref: '#/components/parameters/project_path_gid' - $ref: '#/components/parameters/pretty' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' get: summary: Get a project's custom fields description: >- Returns a list of all of the custom fields settings on a project, in compact form. Note that, as in all queries to collections which return compact representation, `opt_fields` can be used to include more data than is returned in the compact representation. See the [documentation for input/output options](https://developers.asana.com/docs/inputoutput-options) for more information. tags: - Custom field settings operationId: getCustomFieldSettingsForProject parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - custom_field - custom_field.asana_created_field - custom_field.created_by - custom_field.created_by.name - custom_field.currency_code - custom_field.custom_label - custom_field.custom_label_position - custom_field.date_value - custom_field.date_value.date - custom_field.date_value.date_time - custom_field.description - custom_field.display_value - custom_field.enabled - custom_field.enum_options - custom_field.enum_options.color - custom_field.enum_options.enabled - custom_field.enum_options.name - custom_field.enum_value - custom_field.enum_value.color - custom_field.enum_value.enabled - custom_field.enum_value.name - custom_field.format - custom_field.has_notifications_enabled - custom_field.is_formula_field - custom_field.is_global_to_workspace - custom_field.is_value_read_only - custom_field.multi_enum_values - custom_field.multi_enum_values.color - custom_field.multi_enum_values.enabled - custom_field.multi_enum_values.name - custom_field.name - custom_field.number_value - custom_field.people_value - custom_field.people_value.name - custom_field.precision - custom_field.resource_subtype - custom_field.text_value - custom_field.type - is_important - offset - parent - parent.name - path - project - project.name - uri schema: type: array items: type: string enum: - custom_field - custom_field.asana_created_field - custom_field.created_by - custom_field.created_by.name - custom_field.currency_code - custom_field.custom_label - custom_field.custom_label_position - custom_field.date_value - custom_field.date_value.date - custom_field.date_value.date_time - custom_field.description - custom_field.display_value - custom_field.enabled - custom_field.enum_options - custom_field.enum_options.color - custom_field.enum_options.enabled - custom_field.enum_options.name - custom_field.enum_value - custom_field.enum_value.color - custom_field.enum_value.enabled - custom_field.enum_value.name - custom_field.format - custom_field.has_notifications_enabled - custom_field.is_formula_field - custom_field.is_global_to_workspace - custom_field.is_value_read_only - custom_field.multi_enum_values - custom_field.multi_enum_values.color - custom_field.multi_enum_values.enabled - custom_field.multi_enum_values.name - custom_field.name - custom_field.number_value - custom_field.people_value - custom_field.people_value.name - custom_field.precision - custom_field.resource_subtype - custom_field.text_value - custom_field.type - is_important - offset - parent - parent.name - path - project - project.name - uri style: form explode: false responses: 200: description: >- Successfully retrieved custom field settings objects for a project. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/CustomFieldSettingResponse' next_page: $ref: '#/components/schemas/NextPage' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.customfieldsettings.getCustomFieldSettingsForProject(projectGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.customfieldsettings.getCustomFieldSettingsForProject(projectGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.CustomFieldSettingsApi(); let project_gid = "1331"; // String | Globally unique identifier for the project. let opts = { 'limit': 50, // Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", // String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'opt_fields': ["custom_field","custom_field.asana_created_field","custom_field.created_by","custom_field.created_by.name","custom_field.currency_code","custom_field.custom_label","custom_field.custom_label_position","custom_field.date_value","custom_field.date_value.date","custom_field.date_value.date_time","custom_field.description","custom_field.display_value","custom_field.enabled","custom_field.enum_options","custom_field.enum_options.color","custom_field.enum_options.enabled","custom_field.enum_options.name","custom_field.enum_value","custom_field.enum_value.color","custom_field.enum_value.enabled","custom_field.enum_value.name","custom_field.format","custom_field.has_notifications_enabled","custom_field.is_formula_field","custom_field.is_global_to_workspace","custom_field.is_value_read_only","custom_field.multi_enum_values","custom_field.multi_enum_values.color","custom_field.multi_enum_values.enabled","custom_field.multi_enum_values.name","custom_field.name","custom_field.number_value","custom_field.people_value","custom_field.people_value.name","custom_field.precision","custom_field.resource_subtype","custom_field.text_value","custom_field.type","is_important","offset","parent","parent.name","path","project","project.name","uri"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getCustomFieldSettingsForProject(project_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.CustomFieldSettingsApi(api_client) project_gid = '1331' # str | Globally unique identifier for the project. limit = 50 # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. (optional) offset = 'eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9' # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' (optional) opt_fields = ["custom_field","custom_field.asana_created_field","custom_field.created_by","custom_field.created_by.name","custom_field.currency_code","custom_field.custom_label","custom_field.custom_label_position","custom_field.date_value","custom_field.date_value.date","custom_field.date_value.date_time","custom_field.description","custom_field.display_value","custom_field.enabled","custom_field.enum_options","custom_field.enum_options.color","custom_field.enum_options.enabled","custom_field.enum_options.name","custom_field.enum_value","custom_field.enum_value.color","custom_field.enum_value.enabled","custom_field.enum_value.name","custom_field.format","custom_field.has_notifications_enabled","custom_field.is_formula_field","custom_field.is_global_to_workspace","custom_field.is_value_read_only","custom_field.multi_enum_values","custom_field.multi_enum_values.color","custom_field.multi_enum_values.enabled","custom_field.multi_enum_values.name","custom_field.name","custom_field.number_value","custom_field.people_value","custom_field.people_value.name","custom_field.precision","custom_field.resource_subtype","custom_field.text_value","custom_field.type","is_important","offset","parent","parent.name","path","project","project.name","uri"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get a project's custom fields api_response = api_instance.get_custom_field_settings_for_project(project_gid, limit=limit, offset=offset, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling CustomFieldSettingsApi->get_custom_field_settings_for_project: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.custom_field_settings.get_custom_field_settings_for_project(project_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- customfieldsettings->getCustomFieldSettingsForProject($project_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.custom_field_settings.get_custom_field_settings_for_project(project_gid: 'project_gid', param: "value", param: "value", options: {pretty: true}) /portfolios/{portfolio_gid}/custom_field_settings: parameters: - $ref: '#/components/parameters/portfolio_path_gid' - $ref: '#/components/parameters/pretty' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' get: summary: Get a portfolio's custom fields description: >- Returns a list of all of the custom fields settings on a portfolio, in compact form. tags: - Custom field settings operationId: getCustomFieldSettingsForPortfolio parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - custom_field - custom_field.asana_created_field - custom_field.created_by - custom_field.created_by.name - custom_field.currency_code - custom_field.custom_label - custom_field.custom_label_position - custom_field.date_value - custom_field.date_value.date - custom_field.date_value.date_time - custom_field.description - custom_field.display_value - custom_field.enabled - custom_field.enum_options - custom_field.enum_options.color - custom_field.enum_options.enabled - custom_field.enum_options.name - custom_field.enum_value - custom_field.enum_value.color - custom_field.enum_value.enabled - custom_field.enum_value.name - custom_field.format - custom_field.has_notifications_enabled - custom_field.is_formula_field - custom_field.is_global_to_workspace - custom_field.is_value_read_only - custom_field.multi_enum_values - custom_field.multi_enum_values.color - custom_field.multi_enum_values.enabled - custom_field.multi_enum_values.name - custom_field.name - custom_field.number_value - custom_field.people_value - custom_field.people_value.name - custom_field.precision - custom_field.resource_subtype - custom_field.text_value - custom_field.type - is_important - offset - parent - parent.name - path - project - project.name - uri schema: type: array items: type: string enum: - custom_field - custom_field.asana_created_field - custom_field.created_by - custom_field.created_by.name - custom_field.currency_code - custom_field.custom_label - custom_field.custom_label_position - custom_field.date_value - custom_field.date_value.date - custom_field.date_value.date_time - custom_field.description - custom_field.display_value - custom_field.enabled - custom_field.enum_options - custom_field.enum_options.color - custom_field.enum_options.enabled - custom_field.enum_options.name - custom_field.enum_value - custom_field.enum_value.color - custom_field.enum_value.enabled - custom_field.enum_value.name - custom_field.format - custom_field.has_notifications_enabled - custom_field.is_formula_field - custom_field.is_global_to_workspace - custom_field.is_value_read_only - custom_field.multi_enum_values - custom_field.multi_enum_values.color - custom_field.multi_enum_values.enabled - custom_field.multi_enum_values.name - custom_field.name - custom_field.number_value - custom_field.people_value - custom_field.people_value.name - custom_field.precision - custom_field.resource_subtype - custom_field.text_value - custom_field.type - is_important - offset - parent - parent.name - path - project - project.name - uri style: form explode: false responses: 200: description: >- Successfully retrieved custom field settings objects for a portfolio. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/CustomFieldSettingResponse' next_page: $ref: '#/components/schemas/NextPage' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.customfieldsettings.getCustomFieldSettingsForPortfolio(portfolioGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.customfieldsettings.getCustomFieldSettingsForPortfolio(portfolioGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.CustomFieldSettingsApi(); let portfolio_gid = "12345"; // String | Globally unique identifier for the portfolio. let opts = { 'limit': 50, // Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", // String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'opt_fields': ["custom_field","custom_field.asana_created_field","custom_field.created_by","custom_field.created_by.name","custom_field.currency_code","custom_field.custom_label","custom_field.custom_label_position","custom_field.date_value","custom_field.date_value.date","custom_field.date_value.date_time","custom_field.description","custom_field.display_value","custom_field.enabled","custom_field.enum_options","custom_field.enum_options.color","custom_field.enum_options.enabled","custom_field.enum_options.name","custom_field.enum_value","custom_field.enum_value.color","custom_field.enum_value.enabled","custom_field.enum_value.name","custom_field.format","custom_field.has_notifications_enabled","custom_field.is_formula_field","custom_field.is_global_to_workspace","custom_field.is_value_read_only","custom_field.multi_enum_values","custom_field.multi_enum_values.color","custom_field.multi_enum_values.enabled","custom_field.multi_enum_values.name","custom_field.name","custom_field.number_value","custom_field.people_value","custom_field.people_value.name","custom_field.precision","custom_field.resource_subtype","custom_field.text_value","custom_field.type","is_important","offset","parent","parent.name","path","project","project.name","uri"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getCustomFieldSettingsForPortfolio(portfolio_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.CustomFieldSettingsApi(api_client) portfolio_gid = '12345' # str | Globally unique identifier for the portfolio. limit = 50 # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. (optional) offset = 'eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9' # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' (optional) opt_fields = ["custom_field","custom_field.asana_created_field","custom_field.created_by","custom_field.created_by.name","custom_field.currency_code","custom_field.custom_label","custom_field.custom_label_position","custom_field.date_value","custom_field.date_value.date","custom_field.date_value.date_time","custom_field.description","custom_field.display_value","custom_field.enabled","custom_field.enum_options","custom_field.enum_options.color","custom_field.enum_options.enabled","custom_field.enum_options.name","custom_field.enum_value","custom_field.enum_value.color","custom_field.enum_value.enabled","custom_field.enum_value.name","custom_field.format","custom_field.has_notifications_enabled","custom_field.is_formula_field","custom_field.is_global_to_workspace","custom_field.is_value_read_only","custom_field.multi_enum_values","custom_field.multi_enum_values.color","custom_field.multi_enum_values.enabled","custom_field.multi_enum_values.name","custom_field.name","custom_field.number_value","custom_field.people_value","custom_field.people_value.name","custom_field.precision","custom_field.resource_subtype","custom_field.text_value","custom_field.type","is_important","offset","parent","parent.name","path","project","project.name","uri"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get a portfolio's custom fields api_response = api_instance.get_custom_field_settings_for_portfolio(portfolio_gid, limit=limit, offset=offset, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling CustomFieldSettingsApi->get_custom_field_settings_for_portfolio: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.custom_field_settings.get_custom_field_settings_for_portfolio(portfolio_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- customfieldsettings->getCustomFieldSettingsForPortfolio($portfolio_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.custom_field_settings.get_custom_field_settings_for_portfolio(portfolio_gid: 'portfolio_gid', param: "value", param: "value", options: {pretty: true}) /custom_fields: parameters: - $ref: '#/components/parameters/pretty' post: summary: Create a custom field description: |- Creates a new custom field in a workspace. Every custom field is required to be created in a specific workspace, and this workspace cannot be changed once set. A custom field’s name must be unique within a workspace and not conflict with names of existing task properties such as `Due Date` or `Assignee`. A custom field’s type must be one of `text`, `enum`, `multi_enum`, `number`, `date`, or `people`. Returns the full record of the newly created custom field. tags: - Custom fields operationId: createCustomField parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - asana_created_field - created_by - created_by.name - currency_code - custom_label - custom_label_position - date_value - date_value.date - date_value.date_time - description - display_value - enabled - enum_options - enum_options.color - enum_options.enabled - enum_options.name - enum_value - enum_value.color - enum_value.enabled - enum_value.name - format - has_notifications_enabled - is_formula_field - is_global_to_workspace - is_value_read_only - multi_enum_values - multi_enum_values.color - multi_enum_values.enabled - multi_enum_values.name - name - number_value - people_value - people_value.name - precision - resource_subtype - text_value - type schema: type: array items: type: string enum: - asana_created_field - created_by - created_by.name - currency_code - custom_label - custom_label_position - date_value - date_value.date - date_value.date_time - description - display_value - enabled - enum_options - enum_options.color - enum_options.enabled - enum_options.name - enum_value - enum_value.color - enum_value.enabled - enum_value.name - format - has_notifications_enabled - is_formula_field - is_global_to_workspace - is_value_read_only - multi_enum_values - multi_enum_values.color - multi_enum_values.enabled - multi_enum_values.name - name - number_value - people_value - people_value.name - precision - resource_subtype - text_value - type style: form explode: false requestBody: description: The custom field object to create. required: true content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/CustomFieldRequest' responses: 201: description: Custom field successfully created. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/CustomFieldResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); CustomField result = client.customfields.createCustomField() .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.customfields.createCustomField({field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.CustomFieldsApi(); let body = new Asana.CustomFieldsBody.constructFromObject({data: {param1: "value1", param2: "value2",}}); // CustomFieldsBody | The custom field object to create. let opts = { 'opt_fields': ["asana_created_field","created_by","created_by.name","currency_code","custom_label","custom_label_position","date_value","date_value.date","date_value.date_time","description","display_value","enabled","enum_options","enum_options.color","enum_options.enabled","enum_options.name","enum_value","enum_value.color","enum_value.enabled","enum_value.name","format","has_notifications_enabled","is_formula_field","is_global_to_workspace","is_value_read_only","multi_enum_values","multi_enum_values.color","multi_enum_values.enabled","multi_enum_values.name","name","number_value","people_value","people_value.name","precision","resource_subtype","text_value","type"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.createCustomField(body, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.CustomFieldsApi(api_client) body = asana.CustomFieldsBody({"param1": "value1", "param2": "value2",}) # CustomFieldsBody | The custom field object to create. opt_fields = ["asana_created_field","created_by","created_by.name","currency_code","custom_label","custom_label_position","date_value","date_value.date","date_value.date_time","description","display_value","enabled","enum_options","enum_options.color","enum_options.enabled","enum_options.name","enum_value","enum_value.color","enum_value.enabled","enum_value.name","format","has_notifications_enabled","is_formula_field","is_global_to_workspace","is_value_read_only","multi_enum_values","multi_enum_values.color","multi_enum_values.enabled","multi_enum_values.name","name","number_value","people_value","people_value.name","precision","resource_subtype","text_value","type"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Create a custom field api_response = api_instance.create_custom_field(body, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling CustomFieldsApi->create_custom_field: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.custom_fields.create_custom_field({'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- customfields->createCustomField(array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.custom_fields.create_custom_field(field: "value", field: "value", options: {pretty: true}) /custom_fields/{custom_field_gid}: parameters: - $ref: '#/components/parameters/custom_field_path_gid' - $ref: '#/components/parameters/pretty' get: summary: Get a custom field description: |- Get the complete definition of a custom field’s metadata. Since custom fields can be defined for one of a number of types, and these types have different data and behaviors, there are fields that are relevant to a particular type. For instance, as noted above, enum_options is only relevant for the enum type and defines the set of choices that the enum could represent. The examples below show some of these type-specific custom field definitions. tags: - Custom fields operationId: getCustomField parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - asana_created_field - created_by - created_by.name - currency_code - custom_label - custom_label_position - date_value - date_value.date - date_value.date_time - description - display_value - enabled - enum_options - enum_options.color - enum_options.enabled - enum_options.name - enum_value - enum_value.color - enum_value.enabled - enum_value.name - format - has_notifications_enabled - is_formula_field - is_global_to_workspace - is_value_read_only - multi_enum_values - multi_enum_values.color - multi_enum_values.enabled - multi_enum_values.name - name - number_value - people_value - people_value.name - precision - resource_subtype - text_value - type schema: type: array items: type: string enum: - asana_created_field - created_by - created_by.name - currency_code - custom_label - custom_label_position - date_value - date_value.date - date_value.date_time - description - display_value - enabled - enum_options - enum_options.color - enum_options.enabled - enum_options.name - enum_value - enum_value.color - enum_value.enabled - enum_value.name - format - has_notifications_enabled - is_formula_field - is_global_to_workspace - is_value_read_only - multi_enum_values - multi_enum_values.color - multi_enum_values.enabled - multi_enum_values.name - name - number_value - people_value - people_value.name - precision - resource_subtype - text_value - type style: form explode: false responses: 200: description: >- Successfully retrieved the complete definition of a custom field’s metadata. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/CustomFieldResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); CustomField result = client.customfields.getCustomField(customFieldGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.customfields.getCustomField(customFieldGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.CustomFieldsApi(); let custom_field_gid = "12345"; // String | Globally unique identifier for the custom field. let opts = { 'opt_fields': ["asana_created_field","created_by","created_by.name","currency_code","custom_label","custom_label_position","date_value","date_value.date","date_value.date_time","description","display_value","enabled","enum_options","enum_options.color","enum_options.enabled","enum_options.name","enum_value","enum_value.color","enum_value.enabled","enum_value.name","format","has_notifications_enabled","is_formula_field","is_global_to_workspace","is_value_read_only","multi_enum_values","multi_enum_values.color","multi_enum_values.enabled","multi_enum_values.name","name","number_value","people_value","people_value.name","precision","resource_subtype","text_value","type"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getCustomField(custom_field_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.CustomFieldsApi(api_client) custom_field_gid = '12345' # str | Globally unique identifier for the custom field. opt_fields = ["asana_created_field","created_by","created_by.name","currency_code","custom_label","custom_label_position","date_value","date_value.date","date_value.date_time","description","display_value","enabled","enum_options","enum_options.color","enum_options.enabled","enum_options.name","enum_value","enum_value.color","enum_value.enabled","enum_value.name","format","has_notifications_enabled","is_formula_field","is_global_to_workspace","is_value_read_only","multi_enum_values","multi_enum_values.color","multi_enum_values.enabled","multi_enum_values.name","name","number_value","people_value","people_value.name","precision","resource_subtype","text_value","type"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get a custom field api_response = api_instance.get_custom_field(custom_field_gid, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling CustomFieldsApi->get_custom_field: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.custom_fields.get_custom_field(custom_field_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- customfields->getCustomField($custom_field_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.custom_fields.get_custom_field(custom_field_gid: 'custom_field_gid', param: "value", param: "value", options: {pretty: true}) put: summary: Update a custom field description: >- A specific, existing custom field can be updated by making a PUT request on the URL for that custom field. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged When using this method, it is best to specify only those fields you wish to change, or else you may overwrite changes made by another user since you last retrieved the custom field. A custom field’s `type` cannot be updated. An enum custom field’s `enum_options` cannot be updated with this endpoint. Instead see “Work With Enum Options” for information on how to update `enum_options`. Locked custom fields can only be updated by the user who locked the field. Returns the complete updated custom field record. tags: - Custom fields operationId: updateCustomField parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - asana_created_field - created_by - created_by.name - currency_code - custom_label - custom_label_position - date_value - date_value.date - date_value.date_time - description - display_value - enabled - enum_options - enum_options.color - enum_options.enabled - enum_options.name - enum_value - enum_value.color - enum_value.enabled - enum_value.name - format - has_notifications_enabled - is_formula_field - is_global_to_workspace - is_value_read_only - multi_enum_values - multi_enum_values.color - multi_enum_values.enabled - multi_enum_values.name - name - number_value - people_value - people_value.name - precision - resource_subtype - text_value - type schema: type: array items: type: string enum: - asana_created_field - created_by - created_by.name - currency_code - custom_label - custom_label_position - date_value - date_value.date - date_value.date_time - description - display_value - enabled - enum_options - enum_options.color - enum_options.enabled - enum_options.name - enum_value - enum_value.color - enum_value.enabled - enum_value.name - format - has_notifications_enabled - is_formula_field - is_global_to_workspace - is_value_read_only - multi_enum_values - multi_enum_values.color - multi_enum_values.enabled - multi_enum_values.name - name - number_value - people_value - people_value.name - precision - resource_subtype - text_value - type style: form explode: false requestBody: description: The custom field object with all updated properties. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/CustomFieldRequest' responses: 200: description: The custom field was successfully updated. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/CustomFieldResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); CustomField result = client.customfields.updateCustomField(customFieldGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.customfields.updateCustomField(customFieldGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.CustomFieldsApi(); let custom_field_gid = "12345"; // String | Globally unique identifier for the custom field. let opts = { 'body': new Asana.CustomFieldsCustomFieldGidBody.constructFromObject({data: {param1: "value1", param2: "value2",}}) // CustomFieldsCustomFieldGidBody | The custom field object with all updated properties. 'opt_fields': ["asana_created_field","created_by","created_by.name","currency_code","custom_label","custom_label_position","date_value","date_value.date","date_value.date_time","description","display_value","enabled","enum_options","enum_options.color","enum_options.enabled","enum_options.name","enum_value","enum_value.color","enum_value.enabled","enum_value.name","format","has_notifications_enabled","is_formula_field","is_global_to_workspace","is_value_read_only","multi_enum_values","multi_enum_values.color","multi_enum_values.enabled","multi_enum_values.name","name","number_value","people_value","people_value.name","precision","resource_subtype","text_value","type"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.updateCustomField(custom_field_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.CustomFieldsApi(api_client) custom_field_gid = '12345' # str | Globally unique identifier for the custom field. body = asana.CustomFieldsCustomFieldGidBody({"param1": "value1", "param2": "value2",}) # CustomFieldsCustomFieldGidBody | The custom field object with all updated properties. (optional) opt_fields = ["asana_created_field","created_by","created_by.name","currency_code","custom_label","custom_label_position","date_value","date_value.date","date_value.date_time","description","display_value","enabled","enum_options","enum_options.color","enum_options.enabled","enum_options.name","enum_value","enum_value.color","enum_value.enabled","enum_value.name","format","has_notifications_enabled","is_formula_field","is_global_to_workspace","is_value_read_only","multi_enum_values","multi_enum_values.color","multi_enum_values.enabled","multi_enum_values.name","name","number_value","people_value","people_value.name","precision","resource_subtype","text_value","type"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Update a custom field api_response = api_instance.update_custom_field(custom_field_gid, body=body, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling CustomFieldsApi->update_custom_field: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.custom_fields.update_custom_field(custom_field_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- customfields->updateCustomField($custom_field_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.custom_fields.update_custom_field(custom_field_gid: 'custom_field_gid', field: "value", field: "value", options: {pretty: true}) delete: summary: Delete a custom field description: >- A specific, existing custom field can be deleted by making a DELETE request on the URL for that custom field. Locked custom fields can only be deleted by the user who locked the field. Returns an empty data record. tags: - Custom fields operationId: deleteCustomField responses: 200: description: The custom field was successfully deleted. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/EmptyResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.customfields.deleteCustomField(customFieldGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.customfields.deleteCustomField(customFieldGid) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.CustomFieldsApi(); let custom_field_gid = "12345"; // String | Globally unique identifier for the custom field. apiInstance.deleteCustomField(custom_field_gid, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.CustomFieldsApi(api_client) custom_field_gid = '12345' # str | Globally unique identifier for the custom field. try: # Delete a custom field api_response = api_instance.delete_custom_field(custom_field_gid) pprint(api_response) except ApiException as e: print("Exception when calling CustomFieldsApi->delete_custom_field: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.custom_fields.delete_custom_field(custom_field_gid, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- customfields->deleteCustomField($custom_field_gid, array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.custom_fields.delete_custom_field(custom_field_gid: 'custom_field_gid', options: {pretty: true}) /workspaces/{workspace_gid}/custom_fields: parameters: - $ref: '#/components/parameters/workspace_path_gid' - $ref: '#/components/parameters/pretty' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' get: summary: Get a workspace's custom fields description: >- Returns a list of the compact representation of all of the custom fields in a workspace. tags: - Custom fields operationId: getCustomFieldsForWorkspace parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - asana_created_field - created_by - created_by.name - currency_code - custom_label - custom_label_position - date_value - date_value.date - date_value.date_time - description - display_value - enabled - enum_options - enum_options.color - enum_options.enabled - enum_options.name - enum_value - enum_value.color - enum_value.enabled - enum_value.name - format - has_notifications_enabled - is_formula_field - is_global_to_workspace - is_value_read_only - multi_enum_values - multi_enum_values.color - multi_enum_values.enabled - multi_enum_values.name - name - number_value - offset - path - people_value - people_value.name - precision - resource_subtype - text_value - type - uri schema: type: array items: type: string enum: - asana_created_field - created_by - created_by.name - currency_code - custom_label - custom_label_position - date_value - date_value.date - date_value.date_time - description - display_value - enabled - enum_options - enum_options.color - enum_options.enabled - enum_options.name - enum_value - enum_value.color - enum_value.enabled - enum_value.name - format - has_notifications_enabled - is_formula_field - is_global_to_workspace - is_value_read_only - multi_enum_values - multi_enum_values.color - multi_enum_values.enabled - multi_enum_values.name - name - number_value - offset - path - people_value - people_value.name - precision - resource_subtype - text_value - type - uri style: form explode: false responses: 200: description: >- Successfully retrieved all custom fields for the given workspace. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/CustomFieldResponse' next_page: $ref: '#/components/schemas/NextPage' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.customfields.getCustomFieldsForWorkspace(workspaceGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.customfields.getCustomFieldsForWorkspace(workspaceGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.CustomFieldsApi(); let workspace_gid = "12345"; // String | Globally unique identifier for the workspace or organization. let opts = { 'limit': 50, // Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", // String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'opt_fields': ["asana_created_field","created_by","created_by.name","currency_code","custom_label","custom_label_position","date_value","date_value.date","date_value.date_time","description","display_value","enabled","enum_options","enum_options.color","enum_options.enabled","enum_options.name","enum_value","enum_value.color","enum_value.enabled","enum_value.name","format","has_notifications_enabled","is_formula_field","is_global_to_workspace","is_value_read_only","multi_enum_values","multi_enum_values.color","multi_enum_values.enabled","multi_enum_values.name","name","number_value","offset","path","people_value","people_value.name","precision","resource_subtype","text_value","type","uri"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getCustomFieldsForWorkspace(workspace_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.CustomFieldsApi(api_client) workspace_gid = '12345' # str | Globally unique identifier for the workspace or organization. limit = 50 # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. (optional) offset = 'eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9' # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' (optional) opt_fields = ["asana_created_field","created_by","created_by.name","currency_code","custom_label","custom_label_position","date_value","date_value.date","date_value.date_time","description","display_value","enabled","enum_options","enum_options.color","enum_options.enabled","enum_options.name","enum_value","enum_value.color","enum_value.enabled","enum_value.name","format","has_notifications_enabled","is_formula_field","is_global_to_workspace","is_value_read_only","multi_enum_values","multi_enum_values.color","multi_enum_values.enabled","multi_enum_values.name","name","number_value","offset","path","people_value","people_value.name","precision","resource_subtype","text_value","type","uri"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get a workspace's custom fields api_response = api_instance.get_custom_fields_for_workspace(workspace_gid, limit=limit, offset=offset, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling CustomFieldsApi->get_custom_fields_for_workspace: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.custom_fields.get_custom_fields_for_workspace(workspace_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- customfields->getCustomFieldsForWorkspace($workspace_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.custom_fields.get_custom_fields_for_workspace(workspace_gid: 'workspace_gid', param: "value", param: "value", options: {pretty: true}) /custom_fields/{custom_field_gid}/enum_options: parameters: - $ref: '#/components/parameters/custom_field_path_gid' - $ref: '#/components/parameters/pretty' post: summary: Create an enum option description: >- Creates an enum option and adds it to this custom field’s list of enum options. A custom field can have at most 500 enum options (including disabled options). By default new enum options are inserted at the end of a custom field’s list. Locked custom fields can only have enum options added by the user who locked the field. Returns the full record of the newly created enum option. tags: - Custom fields operationId: createEnumOptionForCustomField parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - color - enabled - name schema: type: array items: type: string enum: - color - enabled - name style: form explode: false requestBody: description: The enum option object to create. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/EnumOptionRequest' responses: 201: description: Custom field enum option successfully created. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/EnumOption' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.customfields.createEnumOptionForCustomField(customFieldGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.customfields.createEnumOptionForCustomField(customFieldGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.CustomFieldsApi(); let custom_field_gid = "12345"; // String | Globally unique identifier for the custom field. let opts = { 'body': new Asana.CustomFieldGidEnumOptionsBody.constructFromObject({data: {param1: "value1", param2: "value2",}}) // CustomFieldGidEnumOptionsBody | The enum option object to create. 'opt_fields': ["color","enabled","name"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.createEnumOptionForCustomField(custom_field_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.CustomFieldsApi(api_client) custom_field_gid = '12345' # str | Globally unique identifier for the custom field. body = asana.CustomFieldGidEnumOptionsBody({"param1": "value1", "param2": "value2",}) # CustomFieldGidEnumOptionsBody | The enum option object to create. (optional) opt_fields = ["color","enabled","name"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Create an enum option api_response = api_instance.create_enum_option_for_custom_field(custom_field_gid, body=body, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling CustomFieldsApi->create_enum_option_for_custom_field: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.custom_fields.create_enum_option_for_custom_field(custom_field_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- customfields->createEnumOptionForCustomField($custom_field_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.custom_fields.create_enum_option_for_custom_field(custom_field_gid: 'custom_field_gid', field: "value", field: "value", options: {pretty: true}) /custom_fields/{custom_field_gid}/enum_options/insert: parameters: - $ref: '#/components/parameters/custom_field_path_gid' - $ref: '#/components/parameters/pretty' post: summary: Reorder a custom field's enum description: >- Moves a particular enum option to be either before or after another specified enum option in the custom field. Locked custom fields can only be reordered by the user who locked the field. tags: - Custom fields operationId: insertEnumOptionForCustomField parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - color - enabled - name schema: type: array items: type: string enum: - color - enabled - name style: form explode: false requestBody: description: The enum option object to create. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/EnumOptionInsertRequest' responses: 200: description: Custom field enum option successfully reordered. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/EnumOption' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.customfields.insertEnumOptionForCustomField(customFieldGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.customfields.insertEnumOptionForCustomField(customFieldGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.CustomFieldsApi(); let custom_field_gid = "12345"; // String | Globally unique identifier for the custom field. let opts = { 'body': new Asana.EnumOptionsInsertBody.constructFromObject({data: {param1: "value1", param2: "value2",}}) // EnumOptionsInsertBody | The enum option object to create. 'opt_fields': ["color","enabled","name"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.insertEnumOptionForCustomField(custom_field_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.CustomFieldsApi(api_client) custom_field_gid = '12345' # str | Globally unique identifier for the custom field. body = asana.EnumOptionsInsertBody({"param1": "value1", "param2": "value2",}) # EnumOptionsInsertBody | The enum option object to create. (optional) opt_fields = ["color","enabled","name"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Reorder a custom field's enum api_response = api_instance.insert_enum_option_for_custom_field(custom_field_gid, body=body, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling CustomFieldsApi->insert_enum_option_for_custom_field: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.custom_fields.insert_enum_option_for_custom_field(custom_field_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- customfields->insertEnumOptionForCustomField($custom_field_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.custom_fields.insert_enum_option_for_custom_field(custom_field_gid: 'custom_field_gid', field: "value", field: "value", options: {pretty: true}) /enum_options/{enum_option_gid}: parameters: - name: enum_option_gid in: path required: true description: >- Globally unique identifier for the enum option. schema: type: string example: '124578' - $ref: '#/components/parameters/pretty' put: summary: Update an enum option description: >- Updates an existing enum option. Enum custom fields require at least one enabled enum option. Locked custom fields can only be updated by the user who locked the field. Returns the full record of the updated enum option. tags: - Custom fields operationId: updateEnumOption parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - color - enabled - name schema: type: array items: type: string enum: - color - enabled - name style: form explode: false requestBody: description: The enum option object to update content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/EnumOptionBase' responses: 200: description: Successfully updated the specified custom field enum. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/EnumOption' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.customfields.updateEnumOption(enumOptionGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.customfields.updateEnumOption(enumOptionGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.CustomFieldsApi(); let enum_option_gid = "124578"; // String | Globally unique identifier for the enum option. let opts = { 'body': new Asana.EnumOptionsEnumOptionGidBody.constructFromObject({data: {param1: "value1", param2: "value2",}}) // EnumOptionsEnumOptionGidBody | The enum option object to update 'opt_fields': ["color","enabled","name"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.updateEnumOption(enum_option_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.CustomFieldsApi(api_client) enum_option_gid = '124578' # str | Globally unique identifier for the enum option. body = asana.EnumOptionsEnumOptionGidBody({"param1": "value1", "param2": "value2",}) # EnumOptionsEnumOptionGidBody | The enum option object to update (optional) opt_fields = ["color","enabled","name"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Update an enum option api_response = api_instance.update_enum_option(enum_option_gid, body=body, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling CustomFieldsApi->update_enum_option: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.custom_fields.update_enum_option(enum_option_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- customfields->updateEnumOption($enum_option_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.custom_fields.update_enum_option(enum_option_gid: 'enum_option_gid', field: "value", field: "value", options: {pretty: true}) /events: parameters: - name: resource in: query required: true description: >- A resource ID to subscribe to. The resource can be a task or project. schema: type: string example: '12345' - name: sync in: query required: false description: >- A sync token received from the last request, or none on first sync. Events will be returned from the point in time that the sync token was generated. *Note: On your first request, omit the sync token. The response will be the same as for an expired sync token, and will include a new valid sync token.If the sync token is too old (which may happen from time to time) the API will return a `412 Precondition Failed` error, and include a fresh sync token in the response.* schema: type: string example: de4774f6915eae04714ca93bb2f5ee81 - $ref: '#/components/parameters/pretty' get: summary: Get events on a resource description: |- Returns the full record for all events that have occurred since the sync token was created. A `GET` request to the endpoint `/[path_to_resource]/events` can be made in lieu of including the resource ID in the data for the request. Asana limits a single sync token to 100 events. If more than 100 events exist for a given resource, `has_more: true` will be returned in the response, indicating that there are more events to pull. *Note: The resource returned will be the resource that triggered the event. This may be different from the one that the events were requested for. For example, a subscription to a project will contain events for tasks contained within the project.* tags: - Events operationId: getEvents parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - action - change - change.action - change.added_value - change.field - change.new_value - change.removed_value - created_at - parent - parent.name - resource - resource.name - type - user - user.name schema: type: array items: type: string enum: - action - change - change.action - change.added_value - change.field - change.new_value - change.removed_value - created_at - parent - parent.name - resource - resource.name - type - user - user.name style: form explode: false responses: 200: description: Successfully retrieved events. content: application/json: schema: type: object description: >- The full record for all events that have occurred since the sync token was created. properties: data: type: array items: $ref: '#/components/schemas/EventResponse' sync: description: A sync token to be used with the next call to the /events endpoint. type: string example: de4774f6915eae04714ca93bb2f5ee81 has_more: description: Indicates whether there are more events to pull. type: boolean example: true 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 412: description: >- The request is missing or has an expired sync token. content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string readOnly: true description: >- Message providing more detail about the error that occurred, if available. example: Sync token invalid or too old. If you are attempting to keep resources in sync, you must fetch the full dataset for this query now and use the new sync token for the next sync. sync: type: string readOnly: true description: A sync token to be used with the next call to the /events endpoint. example: de4774f6915eae04714ca93bb2f5ee81 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.events.getEvents(sync, resource) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.events.getEvents({param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.EventsApi(); let resource = "12345"; // String | A resource ID to subscribe to. The resource can be a task or project. let opts = { 'sync': "de4774f6915eae04714ca93bb2f5ee81", // String | A sync token received from the last request, or none on first sync. Events will be returned from the point in time that the sync token was generated. *Note: On your first request, omit the sync token. The response will be the same as for an expired sync token, and will include a new valid sync token.If the sync token is too old (which may happen from time to time) the API will return a `412 Precondition Failed` error, and include a fresh sync token in the response.* 'opt_fields': ["action","change","change.action","change.added_value","change.field","change.new_value","change.removed_value","created_at","parent","parent.name","resource","resource.name","type","user","user.name"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getEvents(resource, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.EventsApi(api_client) resource = '12345' # str | A resource ID to subscribe to. The resource can be a task or project. sync = 'de4774f6915eae04714ca93bb2f5ee81' # str | A sync token received from the last request, or none on first sync. Events will be returned from the point in time that the sync token was generated. *Note: On your first request, omit the sync token. The response will be the same as for an expired sync token, and will include a new valid sync token.If the sync token is too old (which may happen from time to time) the API will return a `412 Precondition Failed` error, and include a fresh sync token in the response.* (optional) opt_fields = ["action","change","change.action","change.added_value","change.field","change.new_value","change.removed_value","created_at","parent","parent.name","resource","resource.name","type","user","user.name"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get events on a resource api_response = api_instance.get_events(resource, sync=sync, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling EventsApi->get_events: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.events.get_events({'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- events->getEvents(array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.events.get_events(resource: ''resource_example'', param: "value", param: "value", options: {pretty: true}) /goal_relationships/{goal_relationship_gid}: parameters: - $ref: '#/components/parameters/goal_relationship_path_gid' - $ref: '#/components/parameters/pretty' get: summary: Get a goal relationship description: |- Returns the complete updated goal relationship record for a single goal relationship. tags: - Goal relationships operationId: getGoalRelationship parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - contribution_weight - resource_subtype - supported_goal - supported_goal.name - supported_goal.owner - supported_goal.owner.name - supporting_resource - supporting_resource.name schema: type: array items: type: string enum: - contribution_weight - resource_subtype - supported_goal - supported_goal.name - supported_goal.owner - supported_goal.owner.name - supporting_resource - supporting_resource.name style: form explode: false responses: 200: description: Successfully retrieved the record for the goal relationship. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/GoalRelationshipResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.goalrelationships.getGoalRelationship(goalRelationshipGid) .option("pretty", true) .execute(); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.GoalRelationshipsApi(); let goal_relationship_gid = "12345"; // String | Globally unique identifier for the goal relationship. let opts = { 'opt_fields': ["contribution_weight","resource_subtype","supported_goal","supported_goal.name","supported_goal.owner","supported_goal.owner.name","supporting_resource","supporting_resource.name"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getGoalRelationship(goal_relationship_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.GoalRelationshipsApi(api_client) goal_relationship_gid = '12345' # str | Globally unique identifier for the goal relationship. opt_fields = ["contribution_weight","resource_subtype","supported_goal","supported_goal.name","supported_goal.owner","supported_goal.owner.name","supporting_resource","supporting_resource.name"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get a goal relationship api_response = api_instance.get_goal_relationship(goal_relationship_gid, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling GoalRelationshipsApi->get_goal_relationship: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.goal_relationships.get_goal_relationship(goal_relationship_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- goalrelationships->getGoalRelationship($goal_relationship_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.goal_relationships.get_goal_relationship(goal_relationship_gid: 'goal_relationship_gid', param: "value", param: "value", options: {pretty: true}) put: summary: Update a goal relationship description: |- An existing goal relationship can be updated by making a PUT request on the URL for that goal relationship. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged. Returns the complete updated goal relationship record. tags: - Goal relationships operationId: updateGoalRelationship parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - contribution_weight - resource_subtype - supported_goal - supported_goal.name - supported_goal.owner - supported_goal.owner.name - supporting_resource - supporting_resource.name schema: type: array items: type: string enum: - contribution_weight - resource_subtype - supported_goal - supported_goal.name - supported_goal.owner - supported_goal.owner.name - supporting_resource - supporting_resource.name style: form explode: false requestBody: description: The updated fields for the goal relationship. required: true content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/GoalRelationshipRequest' responses: 200: description: Successfully updated the goal relationship. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/GoalRelationshipResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.goalrelationships.updateGoalRelationship(goalRelationshipGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.GoalRelationshipsApi(); let body = new Asana.GoalRelationshipsGoalRelationshipGidBody.constructFromObject({data: {param1: "value1", param2: "value2",}}); // GoalRelationshipsGoalRelationshipGidBody | The updated fields for the goal relationship. let goal_relationship_gid = "12345"; // String | Globally unique identifier for the goal relationship. let opts = { 'opt_fields': ["contribution_weight","resource_subtype","supported_goal","supported_goal.name","supported_goal.owner","supported_goal.owner.name","supporting_resource","supporting_resource.name"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.updateGoalRelationship(bodygoal_relationship_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.GoalRelationshipsApi(api_client) body = asana.GoalRelationshipsGoalRelationshipGidBody({"param1": "value1", "param2": "value2",}) # GoalRelationshipsGoalRelationshipGidBody | The updated fields for the goal relationship. goal_relationship_gid = '12345' # str | Globally unique identifier for the goal relationship. opt_fields = ["contribution_weight","resource_subtype","supported_goal","supported_goal.name","supported_goal.owner","supported_goal.owner.name","supporting_resource","supporting_resource.name"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Update a goal relationship api_response = api_instance.update_goal_relationship(body, goal_relationship_gid, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling GoalRelationshipsApi->update_goal_relationship: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.goal_relationships.update_goal_relationship(goal_relationship_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- goalrelationships->updateGoalRelationship($goal_relationship_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.goal_relationships.update_goal_relationship(goal_relationship_gid: 'goal_relationship_gid', field: "value", field: "value", options: {pretty: true}) /goal_relationships: get: summary: Get goal relationships description: |- Returns compact goal relationship records. tags: - Goal relationships operationId: getGoalRelationships parameters: - $ref: '#/components/parameters/pretty' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - name: supported_goal required: true in: query description: Globally unique identifier for the supported goal in the goal relationship. schema: type: string example: '12345' - name: resource_subtype in: query description: If provided, filter to goal relationships with a given resource_subtype. schema: type: string example: subgoal - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - contribution_weight - offset - path - resource_subtype - supported_goal - supported_goal.name - supported_goal.owner - supported_goal.owner.name - supporting_resource - supporting_resource.name - uri schema: type: array items: type: string enum: - contribution_weight - offset - path - resource_subtype - supported_goal - supported_goal.name - supported_goal.owner - supported_goal.owner.name - supporting_resource - supporting_resource.name - uri style: form explode: false responses: 200: description: Successfully retrieved the requested goal relationships. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/GoalRelationshipCompact' next_page: $ref: '#/components/schemas/NextPage' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.goalrelationships.getGoalRelationships(resourceSubtype, supportedGoal) .option("pretty", true) .execute(); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.GoalRelationshipsApi(); let supported_goal = "12345"; // String | Globally unique identifier for the supported goal in the goal relationship. let opts = { 'limit': 50, // Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", // String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'resource_subtype': "subgoal", // String | If provided, filter to goal relationships with a given resource_subtype. 'opt_fields': ["contribution_weight","offset","path","resource_subtype","supported_goal","supported_goal.name","supported_goal.owner","supported_goal.owner.name","supporting_resource","supporting_resource.name","uri"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getGoalRelationships(supported_goal, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.GoalRelationshipsApi(api_client) supported_goal = '12345' # str | Globally unique identifier for the supported goal in the goal relationship. limit = 50 # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. (optional) offset = 'eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9' # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' (optional) resource_subtype = 'subgoal' # str | If provided, filter to goal relationships with a given resource_subtype. (optional) opt_fields = ["contribution_weight","offset","path","resource_subtype","supported_goal","supported_goal.name","supported_goal.owner","supported_goal.owner.name","supporting_resource","supporting_resource.name","uri"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get goal relationships api_response = api_instance.get_goal_relationships(supported_goal, limit=limit, offset=offset, resource_subtype=resource_subtype, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling GoalRelationshipsApi->get_goal_relationships: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.goal_relationships.get_goal_relationships({'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- goalrelationships->getGoalRelationships(array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.goal_relationships.get_goal_relationships(supported_goal: ''supported_goal_example'', param: "value", param: "value", options: {pretty: true}) /goals/{goal_gid}/addSupportingRelationship: parameters: - $ref: '#/components/parameters/goal_path_gid' - $ref: '#/components/parameters/pretty' post: summary: Add a supporting goal relationship description: |- Creates a goal relationship by adding a supporting resource to a given goal. Returns the newly created goal relationship record. tags: - Goal relationships operationId: addSupportingRelationship parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - contribution_weight - resource_subtype - supported_goal - supported_goal.name - supported_goal.owner - supported_goal.owner.name - supporting_resource - supporting_resource.name schema: type: array items: type: string enum: - contribution_weight - resource_subtype - supported_goal - supported_goal.name - supported_goal.owner - supported_goal.owner.name - supporting_resource - supporting_resource.name style: form explode: false requestBody: description: The supporting resource to be added to the goal required: true content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/GoalAddSupportingRelationshipRequest' responses: 200: description: Successfully created the goal relationship. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/GoalRelationshipResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.goalrelationships.addSupportingRelationship(goalGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.GoalRelationshipsApi(); let body = new Asana.GoalGidAddSupportingRelationshipBody.constructFromObject({data: {param1: "value1", param2: "value2",}}); // GoalGidAddSupportingRelationshipBody | The supporting resource to be added to the goal let goal_gid = "12345"; // String | Globally unique identifier for the goal. let opts = { 'opt_fields': ["contribution_weight","resource_subtype","supported_goal","supported_goal.name","supported_goal.owner","supported_goal.owner.name","supporting_resource","supporting_resource.name"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.addSupportingRelationship(bodygoal_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.GoalRelationshipsApi(api_client) body = asana.GoalGidAddSupportingRelationshipBody({"param1": "value1", "param2": "value2",}) # GoalGidAddSupportingRelationshipBody | The supporting resource to be added to the goal goal_gid = '12345' # str | Globally unique identifier for the goal. opt_fields = ["contribution_weight","resource_subtype","supported_goal","supported_goal.name","supported_goal.owner","supported_goal.owner.name","supporting_resource","supporting_resource.name"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Add a supporting goal relationship api_response = api_instance.add_supporting_relationship(body, goal_gid, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling GoalRelationshipsApi->add_supporting_relationship: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.goal_relationships.add_supporting_relationship(goal_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- goalrelationships->addSupportingRelationship($goal_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.goal_relationships.add_supporting_relationship(goal_gid: 'goal_gid', field: "value", field: "value", options: {pretty: true}) /goals/{goal_gid}/removeSupportingRelationship: parameters: - $ref: '#/components/parameters/goal_path_gid' - $ref: '#/components/parameters/pretty' post: summary: Removes a supporting goal relationship description: |- Removes a goal relationship for a given parent goal. tags: - Goal relationships operationId: removeSupportingRelationship requestBody: description: The supporting resource to be removed from the goal required: true content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/GoalRemoveSupportingRelationshipRequest' responses: 200: description: Successfully removed the goal relationship. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/EmptyResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.goalrelationships.removeSupportingRelationship(goalGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.GoalRelationshipsApi(); let body = new Asana.GoalGidRemoveSupportingRelationshipBody.constructFromObject({data: {param1: "value1", param2: "value2",}}); // GoalGidRemoveSupportingRelationshipBody | The supporting resource to be removed from the goal let goal_gid = "12345"; // String | Globally unique identifier for the goal. apiInstance.removeSupportingRelationship(bodygoal_gid, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.GoalRelationshipsApi(api_client) body = asana.GoalGidRemoveSupportingRelationshipBody({"param1": "value1", "param2": "value2",}) # GoalGidRemoveSupportingRelationshipBody | The supporting resource to be removed from the goal goal_gid = '12345' # str | Globally unique identifier for the goal. try: # Removes a supporting goal relationship api_response = api_instance.remove_supporting_relationship(body, goal_gid) pprint(api_response) except ApiException as e: print("Exception when calling GoalRelationshipsApi->remove_supporting_relationship: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.goal_relationships.remove_supporting_relationship(goal_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- goalrelationships->removeSupportingRelationship($goal_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.goal_relationships.remove_supporting_relationship(goal_gid: 'goal_gid', field: "value", field: "value", options: {pretty: true}) /goals/{goal_gid}: parameters: - $ref: '#/components/parameters/goal_path_gid' - $ref: '#/components/parameters/pretty' get: summary: Get a goal description: Returns the complete goal record for a single goal. tags: - Goals operationId: getGoal parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name schema: type: array items: type: string enum: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name style: form explode: false responses: 200: description: Successfully retrieved the record for a single goal. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/GoalResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 402: $ref: '#/components/responses/PaymentRequired' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.goals.getGoal(goalGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.goals.getGoal(goalGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.GoalsApi(); let goal_gid = "12345"; // String | Globally unique identifier for the goal. let opts = { 'opt_fields': ["current_status_update","current_status_update.resource_subtype","current_status_update.title","due_on","followers","followers.name","html_notes","is_workspace_level","liked","likes","likes.user","likes.user.name","metric","metric.can_manage","metric.currency_code","metric.current_display_value","metric.current_number_value","metric.initial_number_value","metric.precision","metric.progress_source","metric.resource_subtype","metric.target_number_value","metric.unit","name","notes","num_likes","owner","owner.name","start_on","status","team","team.name","time_period","time_period.display_name","time_period.end_on","time_period.period","time_period.start_on","workspace","workspace.name"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getGoal(goal_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.GoalsApi(api_client) goal_gid = '12345' # str | Globally unique identifier for the goal. opt_fields = ["current_status_update","current_status_update.resource_subtype","current_status_update.title","due_on","followers","followers.name","html_notes","is_workspace_level","liked","likes","likes.user","likes.user.name","metric","metric.can_manage","metric.currency_code","metric.current_display_value","metric.current_number_value","metric.initial_number_value","metric.precision","metric.progress_source","metric.resource_subtype","metric.target_number_value","metric.unit","name","notes","num_likes","owner","owner.name","start_on","status","team","team.name","time_period","time_period.display_name","time_period.end_on","time_period.period","time_period.start_on","workspace","workspace.name"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get a goal api_response = api_instance.get_goal(goal_gid, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling GoalsApi->get_goal: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.goals.get_goal(goal_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- goals->getGoal($goal_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.goals.get_goal(goal_gid: 'goal_gid', param: "value", param: "value", options: {pretty: true}) put: summary: Update a goal description: |- An existing goal can be updated by making a PUT request on the URL for that goal. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged. Returns the complete updated goal record. tags: - Goals operationId: updateGoal parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name schema: type: array items: type: string enum: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name style: form explode: false requestBody: description: The updated fields for the goal. required: true content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/GoalUpdateRequest' responses: 200: description: Successfully updated the goal. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/GoalResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.goals.updateGoal(goalGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.goals.updateGoal(goalGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.GoalsApi(); let body = new Asana.GoalsGoalGidBody.constructFromObject({data: {param1: "value1", param2: "value2",}}); // GoalsGoalGidBody | The updated fields for the goal. let goal_gid = "12345"; // String | Globally unique identifier for the goal. let opts = { 'opt_fields': ["current_status_update","current_status_update.resource_subtype","current_status_update.title","due_on","followers","followers.name","html_notes","is_workspace_level","liked","likes","likes.user","likes.user.name","metric","metric.can_manage","metric.currency_code","metric.current_display_value","metric.current_number_value","metric.initial_number_value","metric.precision","metric.progress_source","metric.resource_subtype","metric.target_number_value","metric.unit","name","notes","num_likes","owner","owner.name","start_on","status","team","team.name","time_period","time_period.display_name","time_period.end_on","time_period.period","time_period.start_on","workspace","workspace.name"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.updateGoal(bodygoal_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.GoalsApi(api_client) body = asana.GoalsGoalGidBody({"param1": "value1", "param2": "value2",}) # GoalsGoalGidBody | The updated fields for the goal. goal_gid = '12345' # str | Globally unique identifier for the goal. opt_fields = ["current_status_update","current_status_update.resource_subtype","current_status_update.title","due_on","followers","followers.name","html_notes","is_workspace_level","liked","likes","likes.user","likes.user.name","metric","metric.can_manage","metric.currency_code","metric.current_display_value","metric.current_number_value","metric.initial_number_value","metric.precision","metric.progress_source","metric.resource_subtype","metric.target_number_value","metric.unit","name","notes","num_likes","owner","owner.name","start_on","status","team","team.name","time_period","time_period.display_name","time_period.end_on","time_period.period","time_period.start_on","workspace","workspace.name"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Update a goal api_response = api_instance.update_goal(body, goal_gid, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling GoalsApi->update_goal: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.goals.update_goal(goal_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- goals->updateGoal($goal_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.goals.update_goal(goal_gid: 'goal_gid', field: "value", field: "value", options: {pretty: true}) delete: summary: Delete a goal description: |- A specific, existing goal can be deleted by making a DELETE request on the URL for that goal. Returns an empty data record. tags: - Goals operationId: deleteGoal responses: 200: description: Successfully deleted the specified goal. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/EmptyResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 402: $ref: '#/components/responses/PaymentRequired' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.goals.deleteGoal(goalGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.goals.deleteGoal(goalGid) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.GoalsApi(); let goal_gid = "12345"; // String | Globally unique identifier for the goal. apiInstance.deleteGoal(goal_gid, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.GoalsApi(api_client) goal_gid = '12345' # str | Globally unique identifier for the goal. try: # Delete a goal api_response = api_instance.delete_goal(goal_gid) pprint(api_response) except ApiException as e: print("Exception when calling GoalsApi->delete_goal: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.goals.delete_goal(goal_gid, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- goals->deleteGoal($goal_gid, array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.goals.delete_goal(goal_gid: 'goal_gid', options: {pretty: true}) /goals: parameters: - $ref: '#/components/parameters/pretty' get: summary: Get goals description: >- Returns compact goal records. tags: - Goals operationId: getGoals parameters: - name: portfolio in: query description: Globally unique identifier for supporting portfolio. schema: type: string example: '159874' - name: project in: query description: Globally unique identifier for supporting project. schema: type: string example: '512241' - name: is_workspace_level in: query description: Filter to goals with is_workspace_level set to query value. Must be used with the workspace parameter. schema: type: boolean example: false - name: team in: query description: Globally unique identifier for the team. schema: type: string example: '31326' - name: workspace in: query description: Globally unique identifier for the workspace. schema: type: string example: '31326' - name: time_periods in: query description: Globally unique identifiers for the time periods. schema: type: array items: type: string example: 221693,506165 - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - offset - owner - owner.name - path - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - uri - workspace - workspace.name schema: type: array items: type: string enum: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - offset - owner - owner.name - path - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - uri - workspace - workspace.name style: form explode: false responses: 200: description: >- Successfully retrieved the requested goals. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/GoalCompact' next_page: $ref: '#/components/schemas/NextPage' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 402: $ref: '#/components/responses/PaymentRequired' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.goals.getGoals(timePeriods, workspace, team, isWorkspaceLevel, project, portfolio) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.goals.getGoals({param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.GoalsApi(); let opts = { 'portfolio': "159874", // String | Globally unique identifier for supporting portfolio. 'project': "512241", // String | Globally unique identifier for supporting project. 'is_workspace_level': false, // Boolean | Filter to goals with is_workspace_level set to query value. Must be used with the workspace parameter. 'team': "31326", // String | Globally unique identifier for the team. 'workspace': "31326", // String | Globally unique identifier for the workspace. 'time_periods': ["221693,506165"], // [String] | Globally unique identifiers for the time periods. 'limit': 50, // Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", // String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'opt_fields': ["current_status_update","current_status_update.resource_subtype","current_status_update.title","due_on","followers","followers.name","html_notes","is_workspace_level","liked","likes","likes.user","likes.user.name","metric","metric.can_manage","metric.currency_code","metric.current_display_value","metric.current_number_value","metric.initial_number_value","metric.precision","metric.progress_source","metric.resource_subtype","metric.target_number_value","metric.unit","name","notes","num_likes","offset","owner","owner.name","path","start_on","status","team","team.name","time_period","time_period.display_name","time_period.end_on","time_period.period","time_period.start_on","uri","workspace","workspace.name"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getGoals(opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.GoalsApi(api_client) portfolio = '159874' # str | Globally unique identifier for supporting portfolio. (optional) project = '512241' # str | Globally unique identifier for supporting project. (optional) is_workspace_level = false # bool | Filter to goals with is_workspace_level set to query value. Must be used with the workspace parameter. (optional) team = '31326' # str | Globally unique identifier for the team. (optional) workspace = '31326' # str | Globally unique identifier for the workspace. (optional) time_periods = ['221693,506165'] # list[str] | Globally unique identifiers for the time periods. (optional) limit = 50 # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. (optional) offset = 'eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9' # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' (optional) opt_fields = ["current_status_update","current_status_update.resource_subtype","current_status_update.title","due_on","followers","followers.name","html_notes","is_workspace_level","liked","likes","likes.user","likes.user.name","metric","metric.can_manage","metric.currency_code","metric.current_display_value","metric.current_number_value","metric.initial_number_value","metric.precision","metric.progress_source","metric.resource_subtype","metric.target_number_value","metric.unit","name","notes","num_likes","offset","owner","owner.name","path","start_on","status","team","team.name","time_period","time_period.display_name","time_period.end_on","time_period.period","time_period.start_on","uri","workspace","workspace.name"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get goals api_response = api_instance.get_goals(portfolio=portfolio, project=project, is_workspace_level=is_workspace_level, team=team, workspace=workspace, time_periods=time_periods, limit=limit, offset=offset, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling GoalsApi->get_goals: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.goals.get_goals({'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- goals->getGoals(array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.goals.get_goals(param: "value", param: "value", options: {pretty: true}) post: summary: Create a goal description: |- Creates a new goal in a workspace or team. Returns the full record of the newly created goal. tags: - Goals operationId: createGoal parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name schema: type: array items: type: string enum: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name style: form explode: false requestBody: description: The goal to create. required: true content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/GoalRequest' responses: 201: description: Successfully created a new goal. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/GoalResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 402: $ref: '#/components/responses/PaymentRequired' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.goals.createGoal() .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.goals.createGoal({field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.GoalsApi(); let body = new Asana.GoalsBody.constructFromObject({data: {param1: "value1", param2: "value2",}}); // GoalsBody | The goal to create. let opts = { 'opt_fields': ["current_status_update","current_status_update.resource_subtype","current_status_update.title","due_on","followers","followers.name","html_notes","is_workspace_level","liked","likes","likes.user","likes.user.name","metric","metric.can_manage","metric.currency_code","metric.current_display_value","metric.current_number_value","metric.initial_number_value","metric.precision","metric.progress_source","metric.resource_subtype","metric.target_number_value","metric.unit","name","notes","num_likes","owner","owner.name","start_on","status","team","team.name","time_period","time_period.display_name","time_period.end_on","time_period.period","time_period.start_on","workspace","workspace.name"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.createGoal(body, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.GoalsApi(api_client) body = asana.GoalsBody({"param1": "value1", "param2": "value2",}) # GoalsBody | The goal to create. opt_fields = ["current_status_update","current_status_update.resource_subtype","current_status_update.title","due_on","followers","followers.name","html_notes","is_workspace_level","liked","likes","likes.user","likes.user.name","metric","metric.can_manage","metric.currency_code","metric.current_display_value","metric.current_number_value","metric.initial_number_value","metric.precision","metric.progress_source","metric.resource_subtype","metric.target_number_value","metric.unit","name","notes","num_likes","owner","owner.name","start_on","status","team","team.name","time_period","time_period.display_name","time_period.end_on","time_period.period","time_period.start_on","workspace","workspace.name"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Create a goal api_response = api_instance.create_goal(body, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling GoalsApi->create_goal: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.goals.create_goal({'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- goals->createGoal(array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.goals.create_goal(field: "value", field: "value", options: {pretty: true}) /goals/{goal_gid}/setMetric: parameters: - $ref: '#/components/parameters/goal_path_gid' - $ref: '#/components/parameters/pretty' post: summary: Create a goal metric description: >- Creates and adds a goal metric to a specified goal. Note that this replaces an existing goal metric if one already exists. tags: - Goals operationId: createGoalMetric parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name schema: type: array items: type: string enum: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name style: form explode: false requestBody: description: The goal metric to create. required: true content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/GoalMetricRequest' responses: 200: description: Successfully created a new goal metric. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/GoalResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 402: $ref: '#/components/responses/PaymentRequired' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.goals.createGoalMetric(goalGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.goals.createGoalMetric(goalGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.GoalsApi(); let body = new Asana.GoalGidSetMetricBody.constructFromObject({data: {param1: "value1", param2: "value2",}}); // GoalGidSetMetricBody | The goal metric to create. let goal_gid = "12345"; // String | Globally unique identifier for the goal. let opts = { 'opt_fields': ["current_status_update","current_status_update.resource_subtype","current_status_update.title","due_on","followers","followers.name","html_notes","is_workspace_level","liked","likes","likes.user","likes.user.name","metric","metric.can_manage","metric.currency_code","metric.current_display_value","metric.current_number_value","metric.initial_number_value","metric.precision","metric.progress_source","metric.resource_subtype","metric.target_number_value","metric.unit","name","notes","num_likes","owner","owner.name","start_on","status","team","team.name","time_period","time_period.display_name","time_period.end_on","time_period.period","time_period.start_on","workspace","workspace.name"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.createGoalMetric(bodygoal_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.GoalsApi(api_client) body = asana.GoalGidSetMetricBody({"param1": "value1", "param2": "value2",}) # GoalGidSetMetricBody | The goal metric to create. goal_gid = '12345' # str | Globally unique identifier for the goal. opt_fields = ["current_status_update","current_status_update.resource_subtype","current_status_update.title","due_on","followers","followers.name","html_notes","is_workspace_level","liked","likes","likes.user","likes.user.name","metric","metric.can_manage","metric.currency_code","metric.current_display_value","metric.current_number_value","metric.initial_number_value","metric.precision","metric.progress_source","metric.resource_subtype","metric.target_number_value","metric.unit","name","notes","num_likes","owner","owner.name","start_on","status","team","team.name","time_period","time_period.display_name","time_period.end_on","time_period.period","time_period.start_on","workspace","workspace.name"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Create a goal metric api_response = api_instance.create_goal_metric(body, goal_gid, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling GoalsApi->create_goal_metric: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.goals.create_goal_metric(goal_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- goals->createGoalMetric($goal_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.goals.create_goal_metric(goal_gid: 'goal_gid', field: "value", field: "value", options: {pretty: true}) /goals/{goal_gid}/setMetricCurrentValue: parameters: - $ref: '#/components/parameters/goal_path_gid' - $ref: '#/components/parameters/pretty' post: summary: Update a goal metric description: |- Updates a goal's existing metric's `current_number_value` if one exists, otherwise responds with a 400 status code. Returns the complete updated goal metric record. tags: - Goals operationId: updateGoalMetric parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name schema: type: array items: type: string enum: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name style: form explode: false requestBody: description: The updated fields for the goal metric. required: true content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/GoalMetricCurrentValueRequest' responses: 200: description: Successfully updated the goal metric. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/GoalResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 402: $ref: '#/components/responses/PaymentRequired' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.goals.updateGoalMetric(goalGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.goals.updateGoalMetric(goalGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.GoalsApi(); let body = new Asana.GoalGidSetMetricCurrentValueBody.constructFromObject({data: {param1: "value1", param2: "value2",}}); // GoalGidSetMetricCurrentValueBody | The updated fields for the goal metric. let goal_gid = "12345"; // String | Globally unique identifier for the goal. let opts = { 'opt_fields': ["current_status_update","current_status_update.resource_subtype","current_status_update.title","due_on","followers","followers.name","html_notes","is_workspace_level","liked","likes","likes.user","likes.user.name","metric","metric.can_manage","metric.currency_code","metric.current_display_value","metric.current_number_value","metric.initial_number_value","metric.precision","metric.progress_source","metric.resource_subtype","metric.target_number_value","metric.unit","name","notes","num_likes","owner","owner.name","start_on","status","team","team.name","time_period","time_period.display_name","time_period.end_on","time_period.period","time_period.start_on","workspace","workspace.name"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.updateGoalMetric(bodygoal_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.GoalsApi(api_client) body = asana.GoalGidSetMetricCurrentValueBody({"param1": "value1", "param2": "value2",}) # GoalGidSetMetricCurrentValueBody | The updated fields for the goal metric. goal_gid = '12345' # str | Globally unique identifier for the goal. opt_fields = ["current_status_update","current_status_update.resource_subtype","current_status_update.title","due_on","followers","followers.name","html_notes","is_workspace_level","liked","likes","likes.user","likes.user.name","metric","metric.can_manage","metric.currency_code","metric.current_display_value","metric.current_number_value","metric.initial_number_value","metric.precision","metric.progress_source","metric.resource_subtype","metric.target_number_value","metric.unit","name","notes","num_likes","owner","owner.name","start_on","status","team","team.name","time_period","time_period.display_name","time_period.end_on","time_period.period","time_period.start_on","workspace","workspace.name"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Update a goal metric api_response = api_instance.update_goal_metric(body, goal_gid, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling GoalsApi->update_goal_metric: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.goals.update_goal_metric(goal_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- goals->updateGoalMetric($goal_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.goals.update_goal_metric(goal_gid: 'goal_gid', field: "value", field: "value", options: {pretty: true}) /goals/{goal_gid}/addFollowers: parameters: - $ref: '#/components/parameters/goal_path_gid' - $ref: '#/components/parameters/pretty' post: summary: Add a collaborator to a goal description: >- Adds followers to a goal. Returns the goal the followers were added to. Each goal can be associated with zero or more followers in the system. Requests to add/remove followers, if successful, will return the complete updated goal record, described above. tags: - Goals operationId: addFollowers parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name schema: type: array items: type: string enum: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name style: form explode: false requestBody: description: The followers to be added as collaborators required: true content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/TaskAddFollowersRequest' responses: 200: description: Successfully added users as collaborators. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/GoalResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 402: $ref: '#/components/responses/PaymentRequired' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.goals.addFollowers(goalGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.goals.addFollowers(goalGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.GoalsApi(); let body = new Asana.GoalGidAddFollowersBody.constructFromObject({data: {param1: "value1", param2: "value2",}}); // GoalGidAddFollowersBody | The followers to be added as collaborators let goal_gid = "12345"; // String | Globally unique identifier for the goal. let opts = { 'opt_fields': ["current_status_update","current_status_update.resource_subtype","current_status_update.title","due_on","followers","followers.name","html_notes","is_workspace_level","liked","likes","likes.user","likes.user.name","metric","metric.can_manage","metric.currency_code","metric.current_display_value","metric.current_number_value","metric.initial_number_value","metric.precision","metric.progress_source","metric.resource_subtype","metric.target_number_value","metric.unit","name","notes","num_likes","owner","owner.name","start_on","status","team","team.name","time_period","time_period.display_name","time_period.end_on","time_period.period","time_period.start_on","workspace","workspace.name"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.addFollowers(bodygoal_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.GoalsApi(api_client) body = asana.GoalGidAddFollowersBody({"param1": "value1", "param2": "value2",}) # GoalGidAddFollowersBody | The followers to be added as collaborators goal_gid = '12345' # str | Globally unique identifier for the goal. opt_fields = ["current_status_update","current_status_update.resource_subtype","current_status_update.title","due_on","followers","followers.name","html_notes","is_workspace_level","liked","likes","likes.user","likes.user.name","metric","metric.can_manage","metric.currency_code","metric.current_display_value","metric.current_number_value","metric.initial_number_value","metric.precision","metric.progress_source","metric.resource_subtype","metric.target_number_value","metric.unit","name","notes","num_likes","owner","owner.name","start_on","status","team","team.name","time_period","time_period.display_name","time_period.end_on","time_period.period","time_period.start_on","workspace","workspace.name"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Add a collaborator to a goal api_response = api_instance.add_followers(body, goal_gid, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling GoalsApi->add_followers: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.goals.add_followers(goal_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- goals->addFollowers($goal_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.goals.add_followers(goal_gid: 'goal_gid', field: "value", field: "value", options: {pretty: true}) /goals/{goal_gid}/removeFollowers: parameters: - $ref: '#/components/parameters/goal_path_gid' - $ref: '#/components/parameters/pretty' post: summary: Remove a collaborator from a goal description: "Removes followers from a goal. Returns the goal the followers\ \ were removed from.\nEach goal can be associated with zero or more followers\ \ in the system.\nRequests to add/remove followers, if successful, will return\ \ the complete updated goal record, described above." tags: - Goals operationId: removeFollowers parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name schema: type: array items: type: string enum: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name style: form explode: false requestBody: description: The followers to be removed as collaborators required: true content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/TaskAddFollowersRequest' responses: 200: description: Successfully removed users as collaborators. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/GoalResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 402: $ref: '#/components/responses/PaymentRequired' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.goals.removeFollowers(goalGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.goals.removeFollowers(goalGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.GoalsApi(); let body = new Asana.GoalGidRemoveFollowersBody.constructFromObject({data: {param1: "value1", param2: "value2",}}); // GoalGidRemoveFollowersBody | The followers to be removed as collaborators let goal_gid = "12345"; // String | Globally unique identifier for the goal. let opts = { 'opt_fields': ["current_status_update","current_status_update.resource_subtype","current_status_update.title","due_on","followers","followers.name","html_notes","is_workspace_level","liked","likes","likes.user","likes.user.name","metric","metric.can_manage","metric.currency_code","metric.current_display_value","metric.current_number_value","metric.initial_number_value","metric.precision","metric.progress_source","metric.resource_subtype","metric.target_number_value","metric.unit","name","notes","num_likes","owner","owner.name","start_on","status","team","team.name","time_period","time_period.display_name","time_period.end_on","time_period.period","time_period.start_on","workspace","workspace.name"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.removeFollowers(bodygoal_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.GoalsApi(api_client) body = asana.GoalGidRemoveFollowersBody({"param1": "value1", "param2": "value2",}) # GoalGidRemoveFollowersBody | The followers to be removed as collaborators goal_gid = '12345' # str | Globally unique identifier for the goal. opt_fields = ["current_status_update","current_status_update.resource_subtype","current_status_update.title","due_on","followers","followers.name","html_notes","is_workspace_level","liked","likes","likes.user","likes.user.name","metric","metric.can_manage","metric.currency_code","metric.current_display_value","metric.current_number_value","metric.initial_number_value","metric.precision","metric.progress_source","metric.resource_subtype","metric.target_number_value","metric.unit","name","notes","num_likes","owner","owner.name","start_on","status","team","team.name","time_period","time_period.display_name","time_period.end_on","time_period.period","time_period.start_on","workspace","workspace.name"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Remove a collaborator from a goal api_response = api_instance.remove_followers(body, goal_gid, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling GoalsApi->remove_followers: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.goals.remove_followers(goal_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- goals->removeFollowers($goal_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.goals.remove_followers(goal_gid: 'goal_gid', field: "value", field: "value", options: {pretty: true}) /goals/{goal_gid}/parentGoals: parameters: - $ref: '#/components/parameters/goal_path_gid' - $ref: '#/components/parameters/pretty' get: summary: Get parent goals from a goal description: Returns a compact representation of all of the parent goals of a goal. tags: - Goals operationId: getParentGoalsForGoal parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name schema: type: array items: type: string enum: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name style: form explode: false responses: 200: description: Successfully retrieved the specified goal's parent goals. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/GoalCompact' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 402: $ref: '#/components/responses/PaymentRequired' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.goals.getParentGoalsForGoal(goalGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.goals.getParentGoalsForGoal(goalGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.GoalsApi(); let goal_gid = "12345"; // String | Globally unique identifier for the goal. let opts = { 'opt_fields': ["current_status_update","current_status_update.resource_subtype","current_status_update.title","due_on","followers","followers.name","html_notes","is_workspace_level","liked","likes","likes.user","likes.user.name","metric","metric.can_manage","metric.currency_code","metric.current_display_value","metric.current_number_value","metric.initial_number_value","metric.precision","metric.progress_source","metric.resource_subtype","metric.target_number_value","metric.unit","name","notes","num_likes","owner","owner.name","start_on","status","team","team.name","time_period","time_period.display_name","time_period.end_on","time_period.period","time_period.start_on","workspace","workspace.name"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getParentGoalsForGoal(goal_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.GoalsApi(api_client) goal_gid = '12345' # str | Globally unique identifier for the goal. opt_fields = ["current_status_update","current_status_update.resource_subtype","current_status_update.title","due_on","followers","followers.name","html_notes","is_workspace_level","liked","likes","likes.user","likes.user.name","metric","metric.can_manage","metric.currency_code","metric.current_display_value","metric.current_number_value","metric.initial_number_value","metric.precision","metric.progress_source","metric.resource_subtype","metric.target_number_value","metric.unit","name","notes","num_likes","owner","owner.name","start_on","status","team","team.name","time_period","time_period.display_name","time_period.end_on","time_period.period","time_period.start_on","workspace","workspace.name"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get parent goals from a goal api_response = api_instance.get_parent_goals_for_goal(goal_gid, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling GoalsApi->get_parent_goals_for_goal: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.goals.get_parent_goals_for_goal(goal_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- goals->getParentGoalsForGoal($goal_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.goals.get_parent_goals_for_goal(goal_gid: 'goal_gid', param: "value", param: "value", options: {pretty: true}) /jobs/{job_gid}: parameters: - $ref: '#/components/parameters/job_path_gid' - $ref: '#/components/parameters/pretty' get: summary: Get a job by id description: |- Returns the full record for a job. tags: - Jobs operationId: getJob parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - new_project - new_project.name - new_project_template - new_project_template.name - new_task - new_task.created_by - new_task.name - new_task.resource_subtype - new_task_template - new_task_template.name - resource_subtype - status schema: type: array items: type: string enum: - new_project - new_project.name - new_project_template - new_project_template.name - new_task - new_task.created_by - new_task.name - new_task.resource_subtype - new_task_template - new_task_template.name - resource_subtype - status style: form explode: false responses: 200: description: Successfully retrieved Job. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/JobResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); Job result = client.jobs.getJob(jobGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.jobs.getJob(jobGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.JobsApi(); let job_gid = "12345"; // String | Globally unique identifier for the job. let opts = { 'opt_fields': ["new_project","new_project.name","new_project_template","new_project_template.name","new_task","new_task.created_by","new_task.name","new_task.resource_subtype","resource_subtype","status"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getJob(job_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.JobsApi(api_client) job_gid = '12345' # str | Globally unique identifier for the job. opt_fields = ["new_project","new_project.name","new_project_template","new_project_template.name","new_task","new_task.created_by","new_task.name","new_task.resource_subtype","resource_subtype","status"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get a job by id api_response = api_instance.get_job(job_gid, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling JobsApi->get_job: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.jobs.get_job(job_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- jobs->getJob($job_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.jobs.get_job(job_gid: 'job_gid', param: "value", param: "value", options: {pretty: true}) /memberships: parameters: - $ref: '#/components/parameters/pretty' get: summary: Get multiple memberships description: >- Returns compact `goal_membership` or `project_membership` records. The possible types for `parent` in this request are `goal` or `project`. An additional member (user GID or team GID) can be passed in to filter to a specific membership. tags: - Memberships operationId: getMemberships parameters: - name: parent in: query description: >- Globally unique identifier for `goal` or `project`. schema: type: string example: '159874' - name: member in: query description: Globally unique identifier for `team` or `user`. schema: type: string example: '1061493' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - offset - path - uri schema: type: array items: type: string enum: - offset - path - uri style: form explode: false responses: 200: description: >- Successfully retrieved the requested membership. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/MembershipCompact' next_page: $ref: '#/components/schemas/NextPage' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.MembershipsApi(); let opts = { 'parent': "159874", // String | Globally unique identifier for `goal` or `project`. 'member': "1061493", // String | Globally unique identifier for `team` or `user`. 'limit': 50, // Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", // String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'opt_fields': ["offset","path","uri"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getMemberships(opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.MembershipsApi(api_client) parent = '159874' # str | Globally unique identifier for `goal` or `project`. (optional) member = '1061493' # str | Globally unique identifier for `team` or `user`. (optional) limit = 50 # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. (optional) offset = 'eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9' # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' (optional) opt_fields = ["offset","path","uri"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get multiple memberships api_response = api_instance.get_memberships(parent=parent, member=member, limit=limit, offset=offset, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling MembershipsApi->get_memberships: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.memberships.get_memberships({'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- memberships->getMemberships(array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.memberships.get_memberships(parent: ''parent_example'', param: "value", param: "value", options: {pretty: true}) post: summary: Create a membership description: |- Creates a new membership in a `goal`. `Teams` or `users` can be a member of `goals`. Returns the full record of the newly created membership. tags: - Memberships operationId: createMembership requestBody: description: The updated fields for the membership. required: false content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/CreateMembershipRequest' responses: 200: description: >- Successfully created the requested membership. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/MembershipResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.MembershipsApi(); let opts = { 'body': new Asana.MembershipsBody.constructFromObject({data: {param1: "value1", param2: "value2",}}) // MembershipsBody | The updated fields for the membership. }; apiInstance.createMembership(opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.MembershipsApi(api_client) body = asana.MembershipsBody({"param1": "value1", "param2": "value2",}) # MembershipsBody | The updated fields for the membership. (optional) try: # Create a membership api_response = api_instance.create_membership(body=body) pprint(api_response) except ApiException as e: print("Exception when calling MembershipsApi->create_membership: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.memberships.create_membership({'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- memberships->createMembership(array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.memberships.create_membership(field: "value", field: "value", options: {pretty: true}) /memberships/{membership_gid}: parameters: - $ref: '#/components/parameters/membership_path_gid' - $ref: '#/components/parameters/pretty' get: summary: Get a membership description: >- Returns compact `project_membership` record for a single membership. `GET` only supports project memberships currently tags: - Memberships operationId: getMembership parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - access_level - member - member.name - parent - parent.name - resource_subtype schema: type: array items: type: string enum: - access_level - member - member.name - parent - parent.name - resource_subtype style: form explode: false responses: 200: description: >- Successfully retrieved the record for a single membership. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ProjectMembershipCompactResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.MembershipsApi(); let membership_gid = "12345"; // String | Globally unique identifier for the membership. let opts = { 'opt_fields': ["access_level","member","member.name","parent","parent.name","resource_subtype"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getMembership(membership_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.MembershipsApi(api_client) membership_gid = '12345' # str | Globally unique identifier for the membership. opt_fields = ["access_level","member","member.name","parent","parent.name","resource_subtype"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get a membership api_response = api_instance.get_membership(membership_gid, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling MembershipsApi->get_membership: %s\n" % e) delete: summary: Delete a membership description: |- A specific, existing membership can be deleted by making a `DELETE` request on the URL for that membership. Returns an empty data record. tags: - Memberships operationId: deleteMembership responses: 200: description: >- Successfully deleted the requested membership. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/EmptyResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.MembershipsApi(); let membership_gid = "12345"; // String | Globally unique identifier for the membership. apiInstance.deleteMembership(membership_gid, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.MembershipsApi(api_client) membership_gid = '12345' # str | Globally unique identifier for the membership. try: # Delete a membership api_response = api_instance.delete_membership(membership_gid) pprint(api_response) except ApiException as e: print("Exception when calling MembershipsApi->delete_membership: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.memberships.delete_membership(membership_gid, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- memberships->deleteMembership($membership_gid, array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.memberships.delete_membership(membership_gid: 'membership_gid', options: {pretty: true}) /organization_exports: parameters: - $ref: '#/components/parameters/pretty' post: summary: Create an organization export request description: >- This method creates a request to export an Organization. Asana will complete the export at some point after you create the request. tags: - Organization exports operationId: createOrganizationExport parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - created_at - download_url - organization - organization.name - state schema: type: array items: type: string enum: - created_at - download_url - organization - organization.name - state style: form explode: false requestBody: description: The organization to export. required: true content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/OrganizationExportRequest' responses: 201: description: Successfully created organization export request. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/OrganizationExportResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); OrganizationExport result = client.organizationexports.createOrganizationExport() .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.organizationexports.createOrganizationExport({field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.OrganizationExportsApi(); let body = new Asana.OrganizationExportsBody.constructFromObject({data: {param1: "value1", param2: "value2",}}); // OrganizationExportsBody | The organization to export. let opts = { 'opt_fields': ["created_at","download_url","organization","organization.name","state"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.createOrganizationExport(body, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.OrganizationExportsApi(api_client) body = asana.OrganizationExportsBody({"param1": "value1", "param2": "value2",}) # OrganizationExportsBody | The organization to export. opt_fields = ["created_at","download_url","organization","organization.name","state"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Create an organization export request api_response = api_instance.create_organization_export(body, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling OrganizationExportsApi->create_organization_export: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.organization_exports.create_organization_export({'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- organizationexports->createOrganizationExport(array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.organization_exports.create_organization_export(field: "value", field: "value", options: {pretty: true}) /organization_exports/{organization_export_gid}: parameters: - $ref: '#/components/parameters/organization_export_path_gid' - $ref: '#/components/parameters/pretty' get: summary: Get details on an org export request description: >- Returns details of a previously-requested Organization export. tags: - Organization exports operationId: getOrganizationExport parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - created_at - download_url - organization - organization.name - state schema: type: array items: type: string enum: - created_at - download_url - organization - organization.name - state style: form explode: false responses: 200: description: Successfully retrieved organization export object. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/OrganizationExportResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); OrganizationExport result = client.organizationexports.getOrganizationExport(organizationExportGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.organizationexports.getOrganizationExport(organizationExportGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.OrganizationExportsApi(); let organization_export_gid = "12345"; // String | Globally unique identifier for the organization export. let opts = { 'opt_fields': ["created_at","download_url","organization","organization.name","state"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getOrganizationExport(organization_export_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.OrganizationExportsApi(api_client) organization_export_gid = '12345' # str | Globally unique identifier for the organization export. opt_fields = ["created_at","download_url","organization","organization.name","state"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get details on an org export request api_response = api_instance.get_organization_export(organization_export_gid, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling OrganizationExportsApi->get_organization_export: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.organization_exports.get_organization_export(organization_export_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- organizationexports->getOrganizationExport($organization_export_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.organization_exports.get_organization_export(organization_export_gid: 'organization_export_gid', param: "value", param: "value", options: {pretty: true}) /portfolio_memberships: parameters: - $ref: '#/components/parameters/portfolio_query_param' - $ref: '#/components/parameters/workspace_query_param' - $ref: '#/components/parameters/user_query_param' - $ref: '#/components/parameters/pretty' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' get: summary: Get multiple portfolio memberships description: >- Returns a list of portfolio memberships in compact representation. You must specify `portfolio`, `portfolio` and `user`, or `workspace` and `user`. tags: - Portfolio memberships operationId: getPortfolioMemberships parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - offset - path - portfolio - portfolio.name - uri - user - user.name schema: type: array items: type: string enum: - offset - path - portfolio - portfolio.name - uri - user - user.name style: form explode: false responses: 200: description: Successfully retrieved portfolio memberships. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/PortfolioMembershipCompact' next_page: $ref: '#/components/schemas/NextPage' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.portfoliomemberships.getPortfolioMemberships(user, workspace, portfolio) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.portfoliomemberships.getPortfolioMemberships({param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.PortfolioMembershipsApi(); let opts = { 'portfolio': "12345", // String | The portfolio to filter results on. 'workspace': "12345", // String | The workspace to filter results on. 'user': "me", // String | A string identifying a user. This can either be the string \"me\", an email, or the gid of a user. 'limit': 50, // Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", // String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'opt_fields': ["offset","path","portfolio","portfolio.name","uri","user","user.name"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getPortfolioMemberships(opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.PortfolioMembershipsApi(api_client) portfolio = '12345' # str | The portfolio to filter results on. (optional) workspace = '12345' # str | The workspace to filter results on. (optional) user = 'me' # str | A string identifying a user. This can either be the string \"me\", an email, or the gid of a user. (optional) limit = 50 # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. (optional) offset = 'eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9' # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' (optional) opt_fields = ["offset","path","portfolio","portfolio.name","uri","user","user.name"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get multiple portfolio memberships api_response = api_instance.get_portfolio_memberships(portfolio=portfolio, workspace=workspace, user=user, limit=limit, offset=offset, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling PortfolioMembershipsApi->get_portfolio_memberships: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.portfolio_memberships.get_portfolio_memberships({'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- portfoliomemberships->getPortfolioMemberships(array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.portfolio_memberships.get_portfolio_memberships(param: "value", param: "value", options: {pretty: true}) /portfolio_memberships/{portfolio_membership_gid}: parameters: - $ref: '#/components/parameters/portfolio_membership_path_gid' - $ref: '#/components/parameters/pretty' get: summary: Get a portfolio membership description: >- Returns the complete portfolio record for a single portfolio membership. tags: - Portfolio memberships operationId: getPortfolioMembership parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - portfolio - portfolio.name - user - user.name schema: type: array items: type: string enum: - portfolio - portfolio.name - user - user.name style: form explode: false responses: 200: description: >- Successfully retrieved the requested portfolio membership. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/PortfolioMembershipResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); PortfolioMembership result = client.portfoliomemberships.getPortfolioMembership(portfolioMembershipGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.portfoliomemberships.getPortfolioMembership(portfolioMembershipGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.PortfolioMembershipsApi(); let portfolio_membership_gid = "1331"; // String | let opts = { 'opt_fields': ["portfolio","portfolio.name","user","user.name"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getPortfolioMembership(portfolio_membership_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.PortfolioMembershipsApi(api_client) portfolio_membership_gid = '1331' # str | opt_fields = ["portfolio","portfolio.name","user","user.name"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get a portfolio membership api_response = api_instance.get_portfolio_membership(portfolio_membership_gid, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling PortfolioMembershipsApi->get_portfolio_membership: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.portfolio_memberships.get_portfolio_membership(portfolio_membership_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- portfoliomemberships->getPortfolioMembership($portfolio_membership_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.portfolio_memberships.get_portfolio_membership(portfolio_membership_gid: 'portfolio_membership_gid', param: "value", param: "value", options: {pretty: true}) /portfolios/{portfolio_gid}/portfolio_memberships: parameters: - $ref: '#/components/parameters/portfolio_path_gid' - $ref: '#/components/parameters/user_query_param' - $ref: '#/components/parameters/pretty' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' get: summary: Get memberships from a portfolio description: >- Returns the compact portfolio membership records for the portfolio. tags: - Portfolio memberships operationId: getPortfolioMembershipsForPortfolio parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - offset - path - portfolio - portfolio.name - uri - user - user.name schema: type: array items: type: string enum: - offset - path - portfolio - portfolio.name - uri - user - user.name style: form explode: false responses: 200: description: >- Successfully retrieved the requested portfolio's memberships. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/PortfolioMembershipCompact' next_page: $ref: '#/components/schemas/NextPage' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.portfoliomemberships.getPortfolioMembershipsForPortfolio(portfolioGid, user) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.portfoliomemberships.getPortfolioMembershipsForPortfolio(portfolioGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.PortfolioMembershipsApi(); let portfolio_gid = "12345"; // String | Globally unique identifier for the portfolio. let opts = { 'user': "me", // String | A string identifying a user. This can either be the string \"me\", an email, or the gid of a user. 'limit': 50, // Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", // String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'opt_fields': ["offset","path","portfolio","portfolio.name","uri","user","user.name"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getPortfolioMembershipsForPortfolio(portfolio_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.PortfolioMembershipsApi(api_client) portfolio_gid = '12345' # str | Globally unique identifier for the portfolio. user = 'me' # str | A string identifying a user. This can either be the string \"me\", an email, or the gid of a user. (optional) limit = 50 # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. (optional) offset = 'eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9' # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' (optional) opt_fields = ["offset","path","portfolio","portfolio.name","uri","user","user.name"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get memberships from a portfolio api_response = api_instance.get_portfolio_memberships_for_portfolio(portfolio_gid, user=user, limit=limit, offset=offset, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling PortfolioMembershipsApi->get_portfolio_memberships_for_portfolio: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.portfolio_memberships.get_portfolio_memberships_for_portfolio(portfolio_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- portfoliomemberships->getPortfolioMembershipsForPortfolio($portfolio_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.portfolio_memberships.get_portfolio_memberships_for_portfolio(portfolio_gid: 'portfolio_gid', param: "value", param: "value", options: {pretty: true}) /portfolios: parameters: - $ref: '#/components/parameters/pretty' get: summary: Get multiple portfolios description: >- Returns a list of the portfolios in compact representation that are owned by the current API user. tags: - Portfolios operationId: getPortfolios parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - name: workspace in: query required: true description: >- The workspace or organization to filter portfolios on. schema: type: string example: '1331' - name: owner in: query required: false description: >- The user who owns the portfolio. Currently, API users can only get a list of portfolios that they themselves own, unless the request is made from a Service Account. In the case of a Service Account, if this parameter is specified, then all portfolios owned by this parameter are returned. Otherwise, all portfolios across the workspace are returned. schema: type: string example: '14916' - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - color - created_at - created_by - created_by.name - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - due_on - members - members.name - name - offset - owner - owner.name - path - permalink_url - project_templates - project_templates.name - public - start_on - uri - workspace - workspace.name schema: type: array items: type: string enum: - color - created_at - created_by - created_by.name - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - due_on - members - members.name - name - offset - owner - owner.name - path - permalink_url - project_templates - project_templates.name - public - start_on - uri - workspace - workspace.name style: form explode: false responses: 200: description: Successfully retrieved portfolios. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/PortfolioCompact' next_page: $ref: '#/components/schemas/NextPage' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.portfolios.getPortfolios(owner, workspace) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.portfolios.getPortfolios({param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.PortfoliosApi(); let workspace = "1331"; // String | The workspace or organization to filter portfolios on. let opts = { 'limit': 50, // Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", // String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'owner': "14916", // String | The user who owns the portfolio. Currently, API users can only get a list of portfolios that they themselves own, unless the request is made from a Service Account. In the case of a Service Account, if this parameter is specified, then all portfolios owned by this parameter are returned. Otherwise, all portfolios across the workspace are returned. 'opt_fields': ["color","created_at","created_by","created_by.name","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.project","custom_field_settings.project.name","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.is_formula_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","due_on","members","members.name","name","offset","owner","owner.name","path","permalink_url","project_templates","project_templates.name","public","start_on","uri","workspace","workspace.name"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getPortfolios(workspace, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.PortfoliosApi(api_client) workspace = '1331' # str | The workspace or organization to filter portfolios on. limit = 50 # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. (optional) offset = 'eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9' # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' (optional) owner = '14916' # str | The user who owns the portfolio. Currently, API users can only get a list of portfolios that they themselves own, unless the request is made from a Service Account. In the case of a Service Account, if this parameter is specified, then all portfolios owned by this parameter are returned. Otherwise, all portfolios across the workspace are returned. (optional) opt_fields = ["color","created_at","created_by","created_by.name","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.project","custom_field_settings.project.name","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.is_formula_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","due_on","members","members.name","name","offset","owner","owner.name","path","permalink_url","project_templates","project_templates.name","public","start_on","uri","workspace","workspace.name"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get multiple portfolios api_response = api_instance.get_portfolios(workspace, limit=limit, offset=offset, owner=owner, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling PortfoliosApi->get_portfolios: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.portfolios.get_portfolios({'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- portfolios->getPortfolios(array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.portfolios.get_portfolios(workspace: ''workspace_example'', owner: ''owner_example'', param: "value", param: "value", options: {pretty: true}) post: summary: Create a portfolio description: |- Creates a new portfolio in the given workspace with the supplied name. Note that portfolios created in the Asana UI may have some state (like the “Priority” custom field) which is automatically added to the portfolio when it is created. Portfolios created via our API will *not* be created with the same initial state to allow integrations to create their own starting state on a portfolio. tags: - Portfolios operationId: createPortfolio parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - color - created_at - created_by - created_by.name - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - due_on - members - members.name - name - owner - owner.name - permalink_url - project_templates - project_templates.name - public - start_on - workspace - workspace.name schema: type: array items: type: string enum: - color - created_at - created_by - created_by.name - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - due_on - members - members.name - name - owner - owner.name - permalink_url - project_templates - project_templates.name - public - start_on - workspace - workspace.name style: form explode: false requestBody: description: The portfolio to create. required: true content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/PortfolioRequest' responses: 201: description: Successfully created portfolio. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/PortfolioResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); Portfolio result = client.portfolios.createPortfolio() .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.portfolios.createPortfolio({field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.PortfoliosApi(); let body = new Asana.PortfoliosBody.constructFromObject({data: {param1: "value1", param2: "value2",}}); // PortfoliosBody | The portfolio to create. let opts = { 'opt_fields': ["color","created_at","created_by","created_by.name","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.project","custom_field_settings.project.name","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.is_formula_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","due_on","members","members.name","name","owner","owner.name","permalink_url","project_templates","project_templates.name","public","start_on","workspace","workspace.name"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.createPortfolio(body, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.PortfoliosApi(api_client) body = asana.PortfoliosBody({"param1": "value1", "param2": "value2",}) # PortfoliosBody | The portfolio to create. opt_fields = ["color","created_at","created_by","created_by.name","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.project","custom_field_settings.project.name","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.is_formula_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","due_on","members","members.name","name","owner","owner.name","permalink_url","project_templates","project_templates.name","public","start_on","workspace","workspace.name"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Create a portfolio api_response = api_instance.create_portfolio(body, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling PortfoliosApi->create_portfolio: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.portfolios.create_portfolio({'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- portfolios->createPortfolio(array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.portfolios.create_portfolio(field: "value", field: "value", options: {pretty: true}) /portfolios/{portfolio_gid}: parameters: - $ref: '#/components/parameters/portfolio_path_gid' - $ref: '#/components/parameters/pretty' get: summary: Get a portfolio description: Returns the complete portfolio record for a single portfolio. tags: - Portfolios operationId: getPortfolio parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - color - created_at - created_by - created_by.name - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - due_on - members - members.name - name - owner - owner.name - permalink_url - project_templates - project_templates.name - public - start_on - workspace - workspace.name schema: type: array items: type: string enum: - color - created_at - created_by - created_by.name - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - due_on - members - members.name - name - owner - owner.name - permalink_url - project_templates - project_templates.name - public - start_on - workspace - workspace.name style: form explode: false responses: 200: description: Successfully retrieved the requested portfolio. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/PortfolioResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); Portfolio result = client.portfolios.getPortfolio(portfolioGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.portfolios.getPortfolio(portfolioGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.PortfoliosApi(); let portfolio_gid = "12345"; // String | Globally unique identifier for the portfolio. let opts = { 'opt_fields': ["color","created_at","created_by","created_by.name","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.project","custom_field_settings.project.name","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.is_formula_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","due_on","members","members.name","name","owner","owner.name","permalink_url","project_templates","project_templates.name","public","start_on","workspace","workspace.name"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getPortfolio(portfolio_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.PortfoliosApi(api_client) portfolio_gid = '12345' # str | Globally unique identifier for the portfolio. opt_fields = ["color","created_at","created_by","created_by.name","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.project","custom_field_settings.project.name","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.is_formula_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","due_on","members","members.name","name","owner","owner.name","permalink_url","project_templates","project_templates.name","public","start_on","workspace","workspace.name"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get a portfolio api_response = api_instance.get_portfolio(portfolio_gid, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling PortfoliosApi->get_portfolio: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.portfolios.get_portfolio(portfolio_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- portfolios->getPortfolio($portfolio_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.portfolios.get_portfolio(portfolio_gid: 'portfolio_gid', param: "value", param: "value", options: {pretty: true}) put: summary: Update a portfolio description: |- An existing portfolio can be updated by making a PUT request on the URL for that portfolio. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged. Returns the complete updated portfolio record. tags: - Portfolios operationId: updatePortfolio parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - color - created_at - created_by - created_by.name - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - due_on - members - members.name - name - owner - owner.name - permalink_url - project_templates - project_templates.name - public - start_on - workspace - workspace.name schema: type: array items: type: string enum: - color - created_at - created_by - created_by.name - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - due_on - members - members.name - name - owner - owner.name - permalink_url - project_templates - project_templates.name - public - start_on - workspace - workspace.name style: form explode: false requestBody: description: The updated fields for the portfolio. required: true content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/PortfolioRequest' responses: 200: description: Successfully updated the portfolio. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/PortfolioResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); Portfolio result = client.portfolios.updatePortfolio(portfolioGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.portfolios.updatePortfolio(portfolioGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.PortfoliosApi(); let body = new Asana.PortfoliosPortfolioGidBody.constructFromObject({data: {param1: "value1", param2: "value2",}}); // PortfoliosPortfolioGidBody | The updated fields for the portfolio. let portfolio_gid = "12345"; // String | Globally unique identifier for the portfolio. let opts = { 'opt_fields': ["color","created_at","created_by","created_by.name","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.project","custom_field_settings.project.name","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.is_formula_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","due_on","members","members.name","name","owner","owner.name","permalink_url","project_templates","project_templates.name","public","start_on","workspace","workspace.name"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.updatePortfolio(bodyportfolio_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.PortfoliosApi(api_client) body = asana.PortfoliosPortfolioGidBody({"param1": "value1", "param2": "value2",}) # PortfoliosPortfolioGidBody | The updated fields for the portfolio. portfolio_gid = '12345' # str | Globally unique identifier for the portfolio. opt_fields = ["color","created_at","created_by","created_by.name","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.project","custom_field_settings.project.name","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.is_formula_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","due_on","members","members.name","name","owner","owner.name","permalink_url","project_templates","project_templates.name","public","start_on","workspace","workspace.name"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Update a portfolio api_response = api_instance.update_portfolio(body, portfolio_gid, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling PortfoliosApi->update_portfolio: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.portfolios.update_portfolio(portfolio_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- portfolios->updatePortfolio($portfolio_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.portfolios.update_portfolio(portfolio_gid: 'portfolio_gid', field: "value", field: "value", options: {pretty: true}) delete: summary: Delete a portfolio description: |- An existing portfolio can be deleted by making a DELETE request on the URL for that portfolio. Returns an empty data record. tags: - Portfolios operationId: deletePortfolio responses: 200: description: Successfully deleted the specified portfolio. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/EmptyResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.portfolios.deletePortfolio(portfolioGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.portfolios.deletePortfolio(portfolioGid) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.PortfoliosApi(); let portfolio_gid = "12345"; // String | Globally unique identifier for the portfolio. apiInstance.deletePortfolio(portfolio_gid, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.PortfoliosApi(api_client) portfolio_gid = '12345' # str | Globally unique identifier for the portfolio. try: # Delete a portfolio api_response = api_instance.delete_portfolio(portfolio_gid) pprint(api_response) except ApiException as e: print("Exception when calling PortfoliosApi->delete_portfolio: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.portfolios.delete_portfolio(portfolio_gid, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- portfolios->deletePortfolio($portfolio_gid, array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.portfolios.delete_portfolio(portfolio_gid: 'portfolio_gid', options: {pretty: true}) /portfolios/{portfolio_gid}/items: parameters: - $ref: '#/components/parameters/portfolio_path_gid' - $ref: '#/components/parameters/pretty' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' get: summary: Get portfolio items description: >- Get a list of the items in compact form in a portfolio. tags: - Portfolios operationId: getItemsForPortfolio parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - archived - color - completed - completed_at - completed_by - completed_by.name - created_at - created_from_template - created_from_template.name - current_status - current_status.author - current_status.author.name - current_status.color - current_status.created_at - current_status.created_by - current_status.created_by.name - current_status.html_text - current_status.modified_at - current_status.text - current_status.title - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - default_access_level - default_view - due_date - due_on - followers - followers.name - html_notes - icon - members - members.name - minimum_access_level_for_customization - minimum_access_level_for_sharing - modified_at - name - notes - offset - owner - path - permalink_url - privacy_setting - project_brief - public - start_on - team - team.name - uri - workspace - workspace.name schema: type: array items: type: string enum: - archived - color - completed - completed_at - completed_by - completed_by.name - created_at - created_from_template - created_from_template.name - current_status - current_status.author - current_status.author.name - current_status.color - current_status.created_at - current_status.created_by - current_status.created_by.name - current_status.html_text - current_status.modified_at - current_status.text - current_status.title - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - default_access_level - default_view - due_date - due_on - followers - followers.name - html_notes - icon - members - members.name - minimum_access_level_for_customization - minimum_access_level_for_sharing - modified_at - name - notes - offset - owner - path - permalink_url - privacy_setting - project_brief - public - start_on - team - team.name - uri - workspace - workspace.name style: form explode: false responses: 200: description: Successfully retrieved the requested portfolio's items. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/ProjectCompact' next_page: $ref: '#/components/schemas/NextPage' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.portfolios.getItemsForPortfolio(portfolioGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.portfolios.getItemsForPortfolio(portfolioGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.PortfoliosApi(); let portfolio_gid = "12345"; // String | Globally unique identifier for the portfolio. let opts = { 'limit': 50, // Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", // String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'opt_fields': ["archived","color","completed","completed_at","completed_by","completed_by.name","created_at","created_from_template","created_from_template.name","current_status","current_status.author","current_status.author.name","current_status.color","current_status.created_at","current_status.created_by","current_status.created_by.name","current_status.html_text","current_status.modified_at","current_status.text","current_status.title","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.project","custom_field_settings.project.name","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.is_formula_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","default_access_level","default_view","due_date","due_on","followers","followers.name","html_notes","icon","members","members.name","minimum_access_level_for_customization","minimum_access_level_for_sharing","modified_at","name","notes","offset","owner","path","permalink_url","project_brief","public","start_on","team","team.name","uri","workspace","workspace.name"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getItemsForPortfolio(portfolio_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.PortfoliosApi(api_client) portfolio_gid = '12345' # str | Globally unique identifier for the portfolio. limit = 50 # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. (optional) offset = 'eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9' # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' (optional) opt_fields = ["archived","color","completed","completed_at","completed_by","completed_by.name","created_at","created_from_template","created_from_template.name","current_status","current_status.author","current_status.author.name","current_status.color","current_status.created_at","current_status.created_by","current_status.created_by.name","current_status.html_text","current_status.modified_at","current_status.text","current_status.title","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.project","custom_field_settings.project.name","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.is_formula_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","default_access_level","default_view","due_date","due_on","followers","followers.name","html_notes","icon","members","members.name","minimum_access_level_for_customization","minimum_access_level_for_sharing","modified_at","name","notes","offset","owner","path","permalink_url","project_brief","public","start_on","team","team.name","uri","workspace","workspace.name"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get portfolio items api_response = api_instance.get_items_for_portfolio(portfolio_gid, limit=limit, offset=offset, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling PortfoliosApi->get_items_for_portfolio: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.portfolios.get_items_for_portfolio(portfolio_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- portfolios->getItemsForPortfolio($portfolio_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.portfolios.get_items_for_portfolio(portfolio_gid: 'portfolio_gid', param: "value", param: "value", options: {pretty: true}) /portfolios/{portfolio_gid}/addItem: parameters: - $ref: '#/components/parameters/portfolio_path_gid' - $ref: '#/components/parameters/pretty' post: summary: Add a portfolio item description: >- Add an item to a portfolio. Returns an empty data block. tags: - Portfolios operationId: addItemForPortfolio requestBody: description: Information about the item being inserted. required: true content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/PortfolioAddItemRequest' responses: 200: description: Successfully added the item to the portfolio. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/EmptyResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.portfolios.addItemForPortfolio(portfolioGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.portfolios.addItemForPortfolio(portfolioGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.PortfoliosApi(); let body = new Asana.PortfolioGidAddItemBody.constructFromObject({data: {param1: "value1", param2: "value2",}}); // PortfolioGidAddItemBody | Information about the item being inserted. let portfolio_gid = "12345"; // String | Globally unique identifier for the portfolio. apiInstance.addItemForPortfolio(bodyportfolio_gid, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.PortfoliosApi(api_client) body = asana.PortfolioGidAddItemBody({"param1": "value1", "param2": "value2",}) # PortfolioGidAddItemBody | Information about the item being inserted. portfolio_gid = '12345' # str | Globally unique identifier for the portfolio. try: # Add a portfolio item api_response = api_instance.add_item_for_portfolio(body, portfolio_gid) pprint(api_response) except ApiException as e: print("Exception when calling PortfoliosApi->add_item_for_portfolio: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.portfolios.add_item_for_portfolio(portfolio_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- portfolios->addItemForPortfolio($portfolio_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.portfolios.add_item_for_portfolio(portfolio_gid: 'portfolio_gid', field: "value", field: "value", options: {pretty: true}) /portfolios/{portfolio_gid}/removeItem: parameters: - $ref: '#/components/parameters/portfolio_path_gid' - $ref: '#/components/parameters/pretty' post: summary: Remove a portfolio item description: >- Remove an item from a portfolio. Returns an empty data block. tags: - Portfolios operationId: removeItemForPortfolio requestBody: description: Information about the item being removed. required: true content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/PortfolioRemoveItemRequest' responses: 200: description: Successfully removed the item from the portfolio. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/EmptyResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.portfolios.removeItemForPortfolio(portfolioGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.portfolios.removeItemForPortfolio(portfolioGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.PortfoliosApi(); let body = new Asana.PortfolioGidRemoveItemBody.constructFromObject({data: {param1: "value1", param2: "value2",}}); // PortfolioGidRemoveItemBody | Information about the item being removed. let portfolio_gid = "12345"; // String | Globally unique identifier for the portfolio. apiInstance.removeItemForPortfolio(bodyportfolio_gid, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.PortfoliosApi(api_client) body = asana.PortfolioGidRemoveItemBody({"param1": "value1", "param2": "value2",}) # PortfolioGidRemoveItemBody | Information about the item being removed. portfolio_gid = '12345' # str | Globally unique identifier for the portfolio. try: # Remove a portfolio item api_response = api_instance.remove_item_for_portfolio(body, portfolio_gid) pprint(api_response) except ApiException as e: print("Exception when calling PortfoliosApi->remove_item_for_portfolio: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.portfolios.remove_item_for_portfolio(portfolio_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- portfolios->removeItemForPortfolio($portfolio_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.portfolios.remove_item_for_portfolio(portfolio_gid: 'portfolio_gid', field: "value", field: "value", options: {pretty: true}) /portfolios/{portfolio_gid}/addCustomFieldSetting: parameters: - $ref: '#/components/parameters/portfolio_path_gid' - $ref: '#/components/parameters/pretty' post: summary: Add a custom field to a portfolio description: >- Custom fields are associated with portfolios by way of custom field settings. This method creates a setting for the portfolio. tags: - Portfolios operationId: addCustomFieldSettingForPortfolio requestBody: description: Information about the custom field setting. required: true content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/AddCustomFieldSettingRequest' responses: 200: description: Successfully added the custom field to the portfolio. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/CustomFieldSettingResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); CustomFieldSetting result = client.portfolios.addCustomFieldSettingForPortfolio(portfolioGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.portfolios.addCustomFieldSettingForPortfolio(portfolioGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.PortfoliosApi(); let body = new Asana.PortfolioGidAddCustomFieldSettingBody.constructFromObject({data: {param1: "value1", param2: "value2",}}); // PortfolioGidAddCustomFieldSettingBody | Information about the custom field setting. let portfolio_gid = "12345"; // String | Globally unique identifier for the portfolio. apiInstance.addCustomFieldSettingForPortfolio(bodyportfolio_gid, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.PortfoliosApi(api_client) body = asana.PortfolioGidAddCustomFieldSettingBody({"param1": "value1", "param2": "value2",}) # PortfolioGidAddCustomFieldSettingBody | Information about the custom field setting. portfolio_gid = '12345' # str | Globally unique identifier for the portfolio. try: # Add a custom field to a portfolio api_response = api_instance.add_custom_field_setting_for_portfolio(body, portfolio_gid) pprint(api_response) except ApiException as e: print("Exception when calling PortfoliosApi->add_custom_field_setting_for_portfolio: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.portfolios.add_custom_field_setting_for_portfolio(portfolio_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- portfolios->addCustomFieldSettingForPortfolio($portfolio_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.portfolios.add_custom_field_setting_for_portfolio(portfolio_gid: 'portfolio_gid', field: "value", field: "value", options: {pretty: true}) /portfolios/{portfolio_gid}/removeCustomFieldSetting: parameters: - $ref: '#/components/parameters/portfolio_path_gid' - $ref: '#/components/parameters/pretty' post: summary: Remove a custom field from a portfolio description: >- Removes a custom field setting from a portfolio. tags: - Portfolios operationId: removeCustomFieldSettingForPortfolio requestBody: description: Information about the custom field setting being removed. required: true content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/RemoveCustomFieldSettingRequest' responses: 200: description: Successfully removed the custom field from the portfolio. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/EmptyResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.portfolios.removeCustomFieldSettingForPortfolio(portfolioGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.portfolios.removeCustomFieldSettingForPortfolio(portfolioGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.PortfoliosApi(); let body = new Asana.PortfolioGidRemoveCustomFieldSettingBody.constructFromObject({data: {param1: "value1", param2: "value2",}}); // PortfolioGidRemoveCustomFieldSettingBody | Information about the custom field setting being removed. let portfolio_gid = "12345"; // String | Globally unique identifier for the portfolio. apiInstance.removeCustomFieldSettingForPortfolio(bodyportfolio_gid, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.PortfoliosApi(api_client) body = asana.PortfolioGidRemoveCustomFieldSettingBody({"param1": "value1", "param2": "value2",}) # PortfolioGidRemoveCustomFieldSettingBody | Information about the custom field setting being removed. portfolio_gid = '12345' # str | Globally unique identifier for the portfolio. try: # Remove a custom field from a portfolio api_response = api_instance.remove_custom_field_setting_for_portfolio(body, portfolio_gid) pprint(api_response) except ApiException as e: print("Exception when calling PortfoliosApi->remove_custom_field_setting_for_portfolio: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.portfolios.remove_custom_field_setting_for_portfolio(portfolio_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- portfolios->removeCustomFieldSettingForPortfolio($portfolio_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.portfolios.remove_custom_field_setting_for_portfolio(portfolio_gid: 'portfolio_gid', field: "value", field: "value", options: {pretty: true}) /portfolios/{portfolio_gid}/addMembers: parameters: - $ref: '#/components/parameters/portfolio_path_gid' - $ref: '#/components/parameters/pretty' post: summary: Add users to a portfolio description: >- Adds the specified list of users as members of the portfolio. Returns the updated portfolio record. tags: - Portfolios operationId: addMembersForPortfolio parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - color - created_at - created_by - created_by.name - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - due_on - members - members.name - name - owner - owner.name - permalink_url - project_templates - project_templates.name - public - start_on - workspace - workspace.name schema: type: array items: type: string enum: - color - created_at - created_by - created_by.name - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - due_on - members - members.name - name - owner - owner.name - permalink_url - project_templates - project_templates.name - public - start_on - workspace - workspace.name style: form explode: false requestBody: description: Information about the members being added. required: true content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/AddMembersRequest' responses: 200: description: Successfully added members to the portfolio. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/PortfolioResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); Portfolio result = client.portfolios.addMembersForPortfolio(portfolioGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.portfolios.addMembersForPortfolio(portfolioGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.PortfoliosApi(); let body = new Asana.PortfolioGidAddMembersBody.constructFromObject({data: {param1: "value1", param2: "value2",}}); // PortfolioGidAddMembersBody | Information about the members being added. let portfolio_gid = "12345"; // String | Globally unique identifier for the portfolio. let opts = { 'opt_fields': ["color","created_at","created_by","created_by.name","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.project","custom_field_settings.project.name","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.is_formula_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","due_on","members","members.name","name","owner","owner.name","permalink_url","project_templates","project_templates.name","public","start_on","workspace","workspace.name"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.addMembersForPortfolio(bodyportfolio_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.PortfoliosApi(api_client) body = asana.PortfolioGidAddMembersBody({"param1": "value1", "param2": "value2",}) # PortfolioGidAddMembersBody | Information about the members being added. portfolio_gid = '12345' # str | Globally unique identifier for the portfolio. opt_fields = ["color","created_at","created_by","created_by.name","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.project","custom_field_settings.project.name","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.is_formula_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","due_on","members","members.name","name","owner","owner.name","permalink_url","project_templates","project_templates.name","public","start_on","workspace","workspace.name"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Add users to a portfolio api_response = api_instance.add_members_for_portfolio(body, portfolio_gid, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling PortfoliosApi->add_members_for_portfolio: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.portfolios.add_members_for_portfolio(portfolio_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- portfolios->addMembersForPortfolio($portfolio_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.portfolios.add_members_for_portfolio(portfolio_gid: 'portfolio_gid', field: "value", field: "value", options: {pretty: true}) /portfolios/{portfolio_gid}/removeMembers: parameters: - $ref: '#/components/parameters/portfolio_path_gid' - $ref: '#/components/parameters/pretty' post: summary: Remove users from a portfolio description: >- Removes the specified list of users from members of the portfolio. Returns the updated portfolio record. tags: - Portfolios operationId: removeMembersForPortfolio parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - color - created_at - created_by - created_by.name - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - due_on - members - members.name - name - owner - owner.name - permalink_url - project_templates - project_templates.name - public - start_on - workspace - workspace.name schema: type: array items: type: string enum: - color - created_at - created_by - created_by.name - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - due_on - members - members.name - name - owner - owner.name - permalink_url - project_templates - project_templates.name - public - start_on - workspace - workspace.name style: form explode: false requestBody: description: Information about the members being removed. required: true content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/RemoveMembersRequest' responses: 200: description: Successfully removed the members from the portfolio. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/PortfolioResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); Portfolio result = client.portfolios.removeMembersForPortfolio(portfolioGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.portfolios.removeMembersForPortfolio(portfolioGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.PortfoliosApi(); let body = new Asana.PortfolioGidRemoveMembersBody.constructFromObject({data: {param1: "value1", param2: "value2",}}); // PortfolioGidRemoveMembersBody | Information about the members being removed. let portfolio_gid = "12345"; // String | Globally unique identifier for the portfolio. let opts = { 'opt_fields': ["color","created_at","created_by","created_by.name","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.project","custom_field_settings.project.name","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.is_formula_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","due_on","members","members.name","name","owner","owner.name","permalink_url","project_templates","project_templates.name","public","start_on","workspace","workspace.name"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.removeMembersForPortfolio(bodyportfolio_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.PortfoliosApi(api_client) body = asana.PortfolioGidRemoveMembersBody({"param1": "value1", "param2": "value2",}) # PortfolioGidRemoveMembersBody | Information about the members being removed. portfolio_gid = '12345' # str | Globally unique identifier for the portfolio. opt_fields = ["color","created_at","created_by","created_by.name","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.project","custom_field_settings.project.name","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.is_formula_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","due_on","members","members.name","name","owner","owner.name","permalink_url","project_templates","project_templates.name","public","start_on","workspace","workspace.name"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Remove users from a portfolio api_response = api_instance.remove_members_for_portfolio(body, portfolio_gid, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling PortfoliosApi->remove_members_for_portfolio: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.portfolios.remove_members_for_portfolio(portfolio_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- portfolios->removeMembersForPortfolio($portfolio_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.portfolios.remove_members_for_portfolio(portfolio_gid: 'portfolio_gid', field: "value", field: "value", options: {pretty: true}) /project_briefs/{project_brief_gid}: parameters: - $ref: '#/components/parameters/project_brief_path_gid' - $ref: '#/components/parameters/pretty' get: summary: Get a project brief description: Get the full record for a project brief. tags: - Project briefs operationId: getProjectBrief parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - html_text - permalink_url - project - project.name - text - title schema: type: array items: type: string enum: - html_text - permalink_url - project - project.name - text - title style: form explode: false responses: 200: description: Successfully retrieved the record for a project brief. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ProjectBriefResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 402: $ref: '#/components/responses/PaymentRequired' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 424: $ref: '#/components/responses/TooManyRequests' 500: $ref: '#/components/responses/InternalServerError' 501: $ref: '#/components/responses/BadGateway' 503: $ref: '#/components/responses/ServiceUnavailable' 504: $ref: '#/components/responses/GatewayTimeout' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.projectbriefs.getProjectBrief(projectBriefGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projectbriefs.getProjectBrief(projectBriefGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.ProjectBriefsApi(); let project_brief_gid = "12345"; // String | Globally unique identifier for the project brief. let opts = { 'opt_fields': ["html_text","permalink_url","project","project.name","text","title"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getProjectBrief(project_brief_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.ProjectBriefsApi(api_client) project_brief_gid = '12345' # str | Globally unique identifier for the project brief. opt_fields = ["html_text","permalink_url","project","project.name","text","title"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get a project brief api_response = api_instance.get_project_brief(project_brief_gid, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectBriefsApi->get_project_brief: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.project_briefs.get_project_brief(project_brief_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- projectbriefs->getProjectBrief($project_brief_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.project_briefs.get_project_brief(project_brief_gid: 'project_brief_gid', param: "value", param: "value", options: {pretty: true}) put: summary: Update a project brief description: |- An existing project brief can be updated by making a PUT request on the URL for that project brief. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged. Returns the complete updated project brief record. tags: - Project briefs operationId: updateProjectBrief parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - html_text - permalink_url - project - project.name - text - title schema: type: array items: type: string enum: - html_text - permalink_url - project - project.name - text - title style: form explode: false requestBody: description: The updated fields for the project brief. required: true content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ProjectBriefRequest' responses: 200: description: Successfully updated the project brief. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ProjectBriefResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.projectbriefs.updateProjectBrief(projectBriefGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projectbriefs.updateProjectBrief(projectBriefGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.ProjectBriefsApi(); let body = new Asana.ProjectBriefsProjectBriefGidBody.constructFromObject({data: {param1: "value1", param2: "value2",}}); // ProjectBriefsProjectBriefGidBody | The updated fields for the project brief. let project_brief_gid = "12345"; // String | Globally unique identifier for the project brief. let opts = { 'opt_fields': ["html_text","permalink_url","project","project.name","text","title"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.updateProjectBrief(bodyproject_brief_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.ProjectBriefsApi(api_client) body = asana.ProjectBriefsProjectBriefGidBody({"param1": "value1", "param2": "value2",}) # ProjectBriefsProjectBriefGidBody | The updated fields for the project brief. project_brief_gid = '12345' # str | Globally unique identifier for the project brief. opt_fields = ["html_text","permalink_url","project","project.name","text","title"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Update a project brief api_response = api_instance.update_project_brief(body, project_brief_gid, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectBriefsApi->update_project_brief: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.project_briefs.update_project_brief(project_brief_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- projectbriefs->updateProjectBrief($project_brief_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.project_briefs.update_project_brief(project_brief_gid: 'project_brief_gid', field: "value", field: "value", options: {pretty: true}) delete: summary: Delete a project brief description: |- Deletes a specific, existing project brief. Returns an empty data record. tags: - Project briefs operationId: deleteProjectBrief responses: 200: description: Successfully deleted the specified project brief. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/EmptyResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.projectbriefs.deleteProjectBrief(projectBriefGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projectbriefs.deleteProjectBrief(projectBriefGid) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.ProjectBriefsApi(); let project_brief_gid = "12345"; // String | Globally unique identifier for the project brief. apiInstance.deleteProjectBrief(project_brief_gid, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.ProjectBriefsApi(api_client) project_brief_gid = '12345' # str | Globally unique identifier for the project brief. try: # Delete a project brief api_response = api_instance.delete_project_brief(project_brief_gid) pprint(api_response) except ApiException as e: print("Exception when calling ProjectBriefsApi->delete_project_brief: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.project_briefs.delete_project_brief(project_brief_gid, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- projectbriefs->deleteProjectBrief($project_brief_gid, array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.project_briefs.delete_project_brief(project_brief_gid: 'project_brief_gid', options: {pretty: true}) /projects/{project_gid}/project_briefs: parameters: - $ref: '#/components/parameters/project_path_gid' - $ref: '#/components/parameters/pretty' post: summary: Create a project brief description: |- Creates a new project brief. Returns the full record of the newly created project brief. tags: - Project briefs operationId: createProjectBrief parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - html_text - permalink_url - project - project.name - text - title schema: type: array items: type: string enum: - html_text - permalink_url - project - project.name - text - title style: form explode: false requestBody: description: The project brief to create. required: true content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ProjectBriefRequest' responses: 201: description: Successfully created a new project brief. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ProjectBriefResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 402: $ref: '#/components/responses/PaymentRequired' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.projectbriefs.createProjectBrief(projectGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projectbriefs.createProjectBrief(projectGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.ProjectBriefsApi(); let body = new Asana.ProjectGidProjectBriefsBody.constructFromObject({data: {param1: "value1", param2: "value2",}}); // ProjectGidProjectBriefsBody | The project brief to create. let project_gid = "1331"; // String | Globally unique identifier for the project. let opts = { 'opt_fields': ["html_text","permalink_url","project","project.name","text","title"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.createProjectBrief(bodyproject_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.ProjectBriefsApi(api_client) body = asana.ProjectGidProjectBriefsBody({"param1": "value1", "param2": "value2",}) # ProjectGidProjectBriefsBody | The project brief to create. project_gid = '1331' # str | Globally unique identifier for the project. opt_fields = ["html_text","permalink_url","project","project.name","text","title"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Create a project brief api_response = api_instance.create_project_brief(body, project_gid, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectBriefsApi->create_project_brief: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.project_briefs.create_project_brief(project_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- projectbriefs->createProjectBrief($project_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.project_briefs.create_project_brief(project_gid: 'project_gid', field: "value", field: "value", options: {pretty: true}) /project_memberships/{project_membership_gid}: parameters: - $ref: '#/components/parameters/project_membership_path_gid' - $ref: '#/components/parameters/pretty' get: summary: Get a project membership description: >- Returns the complete project record for a single project membership. tags: - Project memberships operationId: getProjectMembership parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - access_level - member - member.name - parent - parent.name - project - project.name - user - user.name - write_access schema: type: array items: type: string enum: - access_level - member - member.name - parent - parent.name - project - project.name - user - user.name - write_access style: form explode: false responses: 200: description: >- Successfully retrieved the requested project membership. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ProjectMembershipNormalResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); ProjectMembership result = client.projectmemberships.getProjectMembership(projectMembershipGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projectmemberships.getProjectMembership(projectMembershipGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.ProjectMembershipsApi(); let project_membership_gid = "1331"; // String | let opts = { 'opt_fields': ["access_level","member","member.name","parent","parent.name","project","project.name","user","user.name","write_access"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getProjectMembership(project_membership_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.ProjectMembershipsApi(api_client) project_membership_gid = '1331' # str | opt_fields = ["access_level","member","member.name","parent","parent.name","project","project.name","user","user.name","write_access"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get a project membership api_response = api_instance.get_project_membership(project_membership_gid, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectMembershipsApi->get_project_membership: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.project_memberships.get_project_membership(project_membership_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- projectmemberships->getProjectMembership($project_membership_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.project_memberships.get_project_membership(project_membership_gid: 'project_membership_gid', param: "value", param: "value", options: {pretty: true}) /projects/{project_gid}/project_memberships: parameters: - $ref: '#/components/parameters/project_path_gid' - $ref: '#/components/parameters/user_query_param' - $ref: '#/components/parameters/pretty' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' get: summary: Get memberships from a project description: >- Returns the compact project membership records for the project. tags: - Project memberships operationId: getProjectMembershipsForProject parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - access_level - member - member.name - offset - parent - parent.name - path - uri schema: type: array items: type: string enum: - access_level - member - member.name - offset - parent - parent.name - path - uri style: form explode: false responses: 200: description: >- Successfully retrieved the requested project's memberships. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/ProjectMembershipCompact' next_page: $ref: '#/components/schemas/NextPage' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.projectmemberships.getProjectMembershipsForProject(projectGid, user) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projectmemberships.getProjectMembershipsForProject(projectGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.ProjectMembershipsApi(); let project_gid = "1331"; // String | Globally unique identifier for the project. let opts = { 'user': "me", // String | A string identifying a user. This can either be the string \"me\", an email, or the gid of a user. 'limit': 50, // Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", // String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'opt_fields': ["access_level","member","member.name","offset","parent","parent.name","path","uri"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getProjectMembershipsForProject(project_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.ProjectMembershipsApi(api_client) project_gid = '1331' # str | Globally unique identifier for the project. user = 'me' # str | A string identifying a user. This can either be the string \"me\", an email, or the gid of a user. (optional) limit = 50 # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. (optional) offset = 'eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9' # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' (optional) opt_fields = ["access_level","member","member.name","offset","parent","parent.name","path","uri"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get memberships from a project api_response = api_instance.get_project_memberships_for_project(project_gid, user=user, limit=limit, offset=offset, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectMembershipsApi->get_project_memberships_for_project: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.project_memberships.get_project_memberships_for_project(project_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- projectmemberships->getProjectMembershipsForProject($project_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.project_memberships.get_project_memberships_for_project(project_gid: 'project_gid', param: "value", param: "value", options: {pretty: true}) /project_statuses/{project_status_gid}: parameters: - $ref: '#/components/parameters/project_status_path_gid' - $ref: '#/components/parameters/pretty' get: summary: Get a project status description: |- *Deprecated: new integrations should prefer the `/status_updates/{status_gid}` route.* Returns the complete record for a single status update. tags: - Project statuses operationId: getProjectStatus parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - author - author.name - color - created_at - created_by - created_by.name - html_text - modified_at - text - title schema: type: array items: type: string enum: - author - author.name - color - created_at - created_by - created_by.name - html_text - modified_at - text - title style: form explode: false responses: 200: description: Successfully retrieved the specified project's status updates. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ProjectStatusResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); ProjectStatus result = client.projectstatuses.getProjectStatus(projectStatusGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projectstatuses.getProjectStatus(projectStatusGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.ProjectStatusesApi(); let project_status_gid = "321654"; // String | The project status update to get. let opts = { 'opt_fields': ["author","author.name","color","created_at","created_by","created_by.name","html_text","modified_at","text","title"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getProjectStatus(project_status_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.ProjectStatusesApi(api_client) project_status_gid = '321654' # str | The project status update to get. opt_fields = ["author","author.name","color","created_at","created_by","created_by.name","html_text","modified_at","text","title"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get a project status api_response = api_instance.get_project_status(project_status_gid, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectStatusesApi->get_project_status: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.project_statuses.get_project_status(project_status_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- projectstatuses->getProjectStatus($project_status_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.project_statuses.get_project_status(project_status_gid: 'project_status_gid', param: "value", param: "value", options: {pretty: true}) delete: summary: Delete a project status description: |- *Deprecated: new integrations should prefer the `/status_updates/{status_gid}` route.* Deletes a specific, existing project status update. Returns an empty data record. tags: - Project statuses operationId: deleteProjectStatus responses: 200: description: Successfully deleted the specified project status. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/EmptyResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.projectstatuses.deleteProjectStatus(projectStatusGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projectstatuses.deleteProjectStatus(projectStatusGid) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.ProjectStatusesApi(); let project_status_gid = "321654"; // String | The project status update to get. apiInstance.deleteProjectStatus(project_status_gid, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.ProjectStatusesApi(api_client) project_status_gid = '321654' # str | The project status update to get. try: # Delete a project status api_response = api_instance.delete_project_status(project_status_gid) pprint(api_response) except ApiException as e: print("Exception when calling ProjectStatusesApi->delete_project_status: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.project_statuses.delete_project_status(project_status_gid, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- projectstatuses->deleteProjectStatus($project_status_gid, array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.project_statuses.delete_project_status(project_status_gid: 'project_status_gid', options: {pretty: true}) /projects/{project_gid}/project_statuses: parameters: - $ref: '#/components/parameters/project_path_gid' - $ref: '#/components/parameters/pretty' get: summary: Get statuses from a project description: |- *Deprecated: new integrations should prefer the `/status_updates` route.* Returns the compact project status update records for all updates on the project. tags: - Project statuses operationId: getProjectStatusesForProject parameters: - $ref: '#/components/parameters/project_path_gid' - $ref: '#/components/parameters/pretty' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - author - author.name - color - created_at - created_by - created_by.name - html_text - modified_at - offset - path - text - title - uri schema: type: array items: type: string enum: - author - author.name - color - created_at - created_by - created_by.name - html_text - modified_at - offset - path - text - title - uri style: form explode: false responses: 200: description: Successfully retrieved the specified project's status updates. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/ProjectStatusCompact' next_page: $ref: '#/components/schemas/NextPage' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.projectstatuses.getProjectStatusesForProject(projectGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projectstatuses.getProjectStatusesForProject(projectGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.ProjectStatusesApi(); let project_gid = "1331"; // String | Globally unique identifier for the project. let opts = { 'limit': 50, // Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", // String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'opt_fields': ["author","author.name","color","created_at","created_by","created_by.name","html_text","modified_at","offset","path","text","title","uri"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getProjectStatusesForProject(project_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.ProjectStatusesApi(api_client) project_gid = '1331' # str | Globally unique identifier for the project. limit = 50 # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. (optional) offset = 'eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9' # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' (optional) opt_fields = ["author","author.name","color","created_at","created_by","created_by.name","html_text","modified_at","offset","path","text","title","uri"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get statuses from a project api_response = api_instance.get_project_statuses_for_project(project_gid, limit=limit, offset=offset, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectStatusesApi->get_project_statuses_for_project: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.project_statuses.get_project_statuses_for_project(project_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- projectstatuses->getProjectStatusesForProject($project_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.project_statuses.get_project_statuses_for_project(project_gid: 'project_gid', param: "value", param: "value", options: {pretty: true}) post: summary: Create a project status description: |- *Deprecated: new integrations should prefer the `/status_updates` route.* Creates a new status update on the project. Returns the full record of the newly created project status update. tags: - Project statuses operationId: createProjectStatusForProject parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - author - author.name - color - created_at - created_by - created_by.name - html_text - modified_at - text - title schema: type: array items: type: string enum: - author - author.name - color - created_at - created_by - created_by.name - html_text - modified_at - text - title style: form explode: false requestBody: description: The project status to create. required: true content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ProjectStatusRequest' responses: 201: description: Successfully created a new story. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ProjectStatusResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); ProjectStatus result = client.projectstatuses.createProjectStatusForProject(projectGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projectstatuses.createProjectStatusForProject(projectGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.ProjectStatusesApi(); let body = new Asana.ProjectGidProjectStatusesBody.constructFromObject({data: {param1: "value1", param2: "value2",}}); // ProjectGidProjectStatusesBody | The project status to create. let project_gid = "1331"; // String | Globally unique identifier for the project. let opts = { 'opt_fields': ["author","author.name","color","created_at","created_by","created_by.name","html_text","modified_at","text","title"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.createProjectStatusForProject(bodyproject_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.ProjectStatusesApi(api_client) body = asana.ProjectGidProjectStatusesBody({"param1": "value1", "param2": "value2",}) # ProjectGidProjectStatusesBody | The project status to create. project_gid = '1331' # str | Globally unique identifier for the project. opt_fields = ["author","author.name","color","created_at","created_by","created_by.name","html_text","modified_at","text","title"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Create a project status api_response = api_instance.create_project_status_for_project(body, project_gid, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectStatusesApi->create_project_status_for_project: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.project_statuses.create_project_status_for_project(project_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- projectstatuses->createProjectStatusForProject($project_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.project_statuses.create_project_status_for_project(project_gid: 'project_gid', field: "value", field: "value", options: {pretty: true}) /project_templates/{project_template_gid}: parameters: - $ref: '#/components/parameters/project_template_path_gid' - $ref: '#/components/parameters/pretty' get: summary: Get a project template description: Returns the complete project template record for a single project template. tags: - Project templates operationId: getProjectTemplate parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - color - description - html_description - name - owner - public - requested_dates - requested_dates.description - requested_dates.name - requested_roles - requested_roles.name - team - team.name schema: type: array items: type: string enum: - color - description - html_description - name - owner - public - requested_dates - requested_dates.description - requested_dates.name - requested_roles - requested_roles.name - team - team.name style: form explode: false responses: 200: description: Successfully retrieved the requested project template. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ProjectTemplateResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.projecttemplates.getProjectTemplate(projectTemplateGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projecttemplates.getProjectTemplate(projectTemplateGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.ProjectTemplatesApi(); let project_template_gid = "1331"; // String | Globally unique identifier for the project template. let opts = { 'opt_fields': ["color","description","html_description","name","owner","public","requested_dates","requested_dates.description","requested_dates.name","requested_roles","requested_roles.name","team","team.name"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getProjectTemplate(project_template_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.ProjectTemplatesApi(api_client) project_template_gid = '1331' # str | Globally unique identifier for the project template. opt_fields = ["color","description","html_description","name","owner","public","requested_dates","requested_dates.description","requested_dates.name","requested_roles","requested_roles.name","team","team.name"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get a project template api_response = api_instance.get_project_template(project_template_gid, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectTemplatesApi->get_project_template: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.project_templates.get_project_template(project_template_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- projecttemplates->getProjectTemplate($project_template_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.project_templates.get_project_template(project_template_gid: 'project_template_gid', param: "value", param: "value", options: {pretty: true}) delete: summary: Delete a project template description: |- A specific, existing project template can be deleted by making a DELETE request on the URL for that project template. Returns an empty data record. tags: - Project templates operationId: deleteProjectTemplate responses: 200: description: Successfully deleted the specified project template. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/EmptyResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 402: $ref: '#/components/responses/PaymentRequired' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.ProjectTemplatesApi(); let project_template_gid = "1331"; // String | Globally unique identifier for the project template. apiInstance.deleteProjectTemplate(project_template_gid, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.ProjectTemplatesApi(api_client) project_template_gid = '1331' # str | Globally unique identifier for the project template. try: # Delete a project template api_response = api_instance.delete_project_template(project_template_gid) pprint(api_response) except ApiException as e: print("Exception when calling ProjectTemplatesApi->delete_project_template: %s\n" % e) /project_templates: parameters: - $ref: '#/components/parameters/pretty' get: summary: Get multiple project templates description: >- Returns the compact project template records for all project templates in the given team or workspace. tags: - Project templates operationId: getProjectTemplates parameters: - $ref: '#/components/parameters/workspace_query_param' - $ref: '#/components/parameters/team_query_param' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - color - description - html_description - name - offset - owner - path - public - requested_dates - requested_dates.description - requested_dates.name - requested_roles - requested_roles.name - team - team.name - uri schema: type: array items: type: string enum: - color - description - html_description - name - offset - owner - path - public - requested_dates - requested_dates.description - requested_dates.name - requested_roles - requested_roles.name - team - team.name - uri style: form explode: false responses: 200: description: Successfully retrieved the requested team's or workspace's project templates. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/ProjectTemplateCompact' next_page: $ref: '#/components/schemas/NextPage' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.projecttemplates.getProjectTemplates(team, workspace) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projecttemplates.getProjectTemplates({param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.ProjectTemplatesApi(); let opts = { 'workspace': "12345", // String | The workspace to filter results on. 'team': "14916", // String | The team to filter projects on. 'limit': 50, // Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", // String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'opt_fields': ["color","description","html_description","name","offset","owner","path","public","requested_dates","requested_dates.description","requested_dates.name","requested_roles","requested_roles.name","team","team.name","uri"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getProjectTemplates(opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.ProjectTemplatesApi(api_client) workspace = '12345' # str | The workspace to filter results on. (optional) team = '14916' # str | The team to filter projects on. (optional) limit = 50 # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. (optional) offset = 'eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9' # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' (optional) opt_fields = ["color","description","html_description","name","offset","owner","path","public","requested_dates","requested_dates.description","requested_dates.name","requested_roles","requested_roles.name","team","team.name","uri"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get multiple project templates api_response = api_instance.get_project_templates(workspace=workspace, team=team, limit=limit, offset=offset, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectTemplatesApi->get_project_templates: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.project_templates.get_project_templates({'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- projecttemplates->getProjectTemplates(array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.project_templates.get_project_templates(param: "value", param: "value", options: {pretty: true}) /teams/{team_gid}/project_templates: parameters: - $ref: '#/components/parameters/team_path_gid' - $ref: '#/components/parameters/pretty' get: summary: Get a team's project templates description: >- Returns the compact project template records for all project templates in the team. tags: - Project templates operationId: getProjectTemplatesForTeam parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - color - description - html_description - name - offset - owner - path - public - requested_dates - requested_dates.description - requested_dates.name - requested_roles - requested_roles.name - team - team.name - uri schema: type: array items: type: string enum: - color - description - html_description - name - offset - owner - path - public - requested_dates - requested_dates.description - requested_dates.name - requested_roles - requested_roles.name - team - team.name - uri style: form explode: false responses: 200: description: Successfully retrieved the requested team's project templates. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/ProjectTemplateCompact' next_page: $ref: '#/components/schemas/NextPage' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.projecttemplates.getProjectTemplatesForTeam(teamGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projecttemplates.getProjectTemplatesForTeam(teamGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.ProjectTemplatesApi(); let team_gid = "159874"; // String | Globally unique identifier for the team. let opts = { 'limit': 50, // Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", // String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'opt_fields': ["color","description","html_description","name","offset","owner","path","public","requested_dates","requested_dates.description","requested_dates.name","requested_roles","requested_roles.name","team","team.name","uri"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getProjectTemplatesForTeam(team_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.ProjectTemplatesApi(api_client) team_gid = '159874' # str | Globally unique identifier for the team. limit = 50 # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. (optional) offset = 'eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9' # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' (optional) opt_fields = ["color","description","html_description","name","offset","owner","path","public","requested_dates","requested_dates.description","requested_dates.name","requested_roles","requested_roles.name","team","team.name","uri"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get a team's project templates api_response = api_instance.get_project_templates_for_team(team_gid, limit=limit, offset=offset, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectTemplatesApi->get_project_templates_for_team: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.project_templates.get_project_templates_for_team(team_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- projecttemplates->getProjectTemplatesForTeam($team_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.project_templates.get_project_templates_for_team(team_gid: 'team_gid', param: "value", param: "value", options: {pretty: true}) /project_templates/{project_template_gid}/instantiateProject: parameters: - $ref: '#/components/parameters/project_template_path_gid' - $ref: '#/components/parameters/pretty' post: summary: Instantiate a project from a project template description: >- Creates and returns a job that will asynchronously handle the project instantiation. To form this request, it is recommended to first make a request to [get a project template](/reference/getprojecttemplate). Then, from the response, copy the `gid` from the object in the `requested_dates` array. This `gid` should be used in `requested_dates` to instantiate a project. _Note: The body of this request will differ if your workspace is an organization. To determine if your workspace is an organization, use the [is_organization](/reference/workspaces) parameter._ tags: - Project templates operationId: instantiateProject parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - new_project - new_project.name - new_project_template - new_project_template.name - new_task - new_task.created_by - new_task.name - new_task.resource_subtype - new_task_template - new_task_template.name - resource_subtype - status schema: type: array items: type: string enum: - new_project - new_project.name - new_project_template - new_project_template.name - new_task - new_task.created_by - new_task.name - new_task.resource_subtype - new_task_template - new_task_template.name - resource_subtype - status style: form explode: false requestBody: description: >- Describes the inputs used for instantiating a project, such as the resulting project's name, which team it should be created in, and values for date variables. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ProjectTemplateInstantiateProjectRequest' responses: 201: description: Successfully created the job to handle project instantiation. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/JobResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); Job result = client.projecttemplates.instantiateProject(projectTemplateGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projecttemplates.instantiateProject(projectTemplateGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.ProjectTemplatesApi(); let project_template_gid = "1331"; // String | Globally unique identifier for the project template. let opts = { 'body': new Asana.ProjectTemplateGidInstantiateProjectBody.constructFromObject({data: {param1: "value1", param2: "value2",}}) // ProjectTemplateGidInstantiateProjectBody | Describes the inputs used for instantiating a project, such as the resulting project's name, which team it should be created in, and values for date variables. 'opt_fields': ["new_project","new_project.name","new_project_template","new_project_template.name","new_task","new_task.created_by","new_task.name","new_task.resource_subtype","resource_subtype","status"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.instantiateProject(project_template_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.ProjectTemplatesApi(api_client) project_template_gid = '1331' # str | Globally unique identifier for the project template. body = asana.ProjectTemplateGidInstantiateProjectBody({"param1": "value1", "param2": "value2",}) # ProjectTemplateGidInstantiateProjectBody | Describes the inputs used for instantiating a project, such as the resulting project's name, which team it should be created in, and values for date variables. (optional) opt_fields = ["new_project","new_project.name","new_project_template","new_project_template.name","new_task","new_task.created_by","new_task.name","new_task.resource_subtype","resource_subtype","status"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Instantiate a project from a project template api_response = api_instance.instantiate_project(project_template_gid, body=body, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectTemplatesApi->instantiate_project: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.project_templates.instantiate_project(project_template_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- projecttemplates->instantiateProject($project_template_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.project_templates.instantiate_project(project_template_gid: 'project_template_gid', field: "value", field: "value", options: {pretty: true}) /projects: parameters: - $ref: '#/components/parameters/pretty' get: summary: Get multiple projects description: >- Returns the compact project records for some filtered set of projects. Use one or more of the parameters provided to filter the projects returned. *Note: This endpoint may timeout for large domains. Try filtering by team!* tags: - Projects operationId: getProjects parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - name: workspace in: query description: >- The workspace or organization to filter projects on. schema: type: string example: '1331' - name: team in: query description: The team to filter projects on. schema: type: string example: '14916' - $ref: '#/components/parameters/archived_query_param' - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - archived - color - completed - completed_at - completed_by - completed_by.name - created_at - created_from_template - created_from_template.name - current_status - current_status.author - current_status.author.name - current_status.color - current_status.created_at - current_status.created_by - current_status.created_by.name - current_status.html_text - current_status.modified_at - current_status.text - current_status.title - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - default_access_level - default_view - due_date - due_on - followers - followers.name - html_notes - icon - members - members.name - minimum_access_level_for_customization - minimum_access_level_for_sharing - modified_at - name - notes - offset - owner - path - permalink_url - privacy_setting - project_brief - public - start_on - team - team.name - uri - workspace - workspace.name schema: type: array items: type: string enum: - archived - color - completed - completed_at - completed_by - completed_by.name - created_at - created_from_template - created_from_template.name - current_status - current_status.author - current_status.author.name - current_status.color - current_status.created_at - current_status.created_by - current_status.created_by.name - current_status.html_text - current_status.modified_at - current_status.text - current_status.title - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - default_access_level - default_view - due_date - due_on - followers - followers.name - html_notes - icon - members - members.name - minimum_access_level_for_customization - minimum_access_level_for_sharing - modified_at - name - notes - offset - owner - path - permalink_url - privacy_setting - project_brief - public - start_on - team - team.name - uri - workspace - workspace.name style: form explode: false responses: 200: description: Successfully retrieved projects. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/ProjectCompact' next_page: $ref: '#/components/schemas/NextPage' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.projects.getProjects(archived, team, workspace) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projects.getProjects({param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.ProjectsApi(); let opts = { 'limit': 50, // Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", // String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'workspace': "1331", // String | The workspace or organization to filter projects on. 'team': "14916", // String | The team to filter projects on. 'archived': false, // Boolean | Only return projects whose `archived` field takes on the value of this parameter. 'opt_fields': ["archived","color","completed","completed_at","completed_by","completed_by.name","created_at","created_from_template","created_from_template.name","current_status","current_status.author","current_status.author.name","current_status.color","current_status.created_at","current_status.created_by","current_status.created_by.name","current_status.html_text","current_status.modified_at","current_status.text","current_status.title","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.project","custom_field_settings.project.name","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.is_formula_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","default_access_level","default_view","due_date","due_on","followers","followers.name","html_notes","icon","members","members.name","minimum_access_level_for_customization","minimum_access_level_for_sharing","modified_at","name","notes","offset","owner","path","permalink_url","project_brief","public","start_on","team","team.name","uri","workspace","workspace.name"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getProjects(opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.ProjectsApi(api_client) limit = 50 # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. (optional) offset = 'eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9' # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' (optional) workspace = '1331' # str | The workspace or organization to filter projects on. (optional) team = '14916' # str | The team to filter projects on. (optional) archived = false # bool | Only return projects whose `archived` field takes on the value of this parameter. (optional) opt_fields = ["archived","color","completed","completed_at","completed_by","completed_by.name","created_at","created_from_template","created_from_template.name","current_status","current_status.author","current_status.author.name","current_status.color","current_status.created_at","current_status.created_by","current_status.created_by.name","current_status.html_text","current_status.modified_at","current_status.text","current_status.title","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.project","custom_field_settings.project.name","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.is_formula_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","default_access_level","default_view","due_date","due_on","followers","followers.name","html_notes","icon","members","members.name","minimum_access_level_for_customization","minimum_access_level_for_sharing","modified_at","name","notes","offset","owner","path","permalink_url","project_brief","public","start_on","team","team.name","uri","workspace","workspace.name"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get multiple projects api_response = api_instance.get_projects(limit=limit, offset=offset, workspace=workspace, team=team, archived=archived, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectsApi->get_projects: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.projects.get_projects({'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- projects->getProjects(array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.projects.get_projects(param: "value", param: "value", options: {pretty: true}) post: summary: Create a project description: |- Create a new project in a workspace or team. Every project is required to be created in a specific workspace or organization, and this cannot be changed once set. Note that you can use the `workspace` parameter regardless of whether or not it is an organization. If the workspace for your project is an organization, you must also supply a `team` to share the project with. Returns the full record of the newly created project. tags: - Projects operationId: createProject parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - archived - color - completed - completed_at - completed_by - completed_by.name - created_at - created_from_template - created_from_template.name - current_status - current_status.author - current_status.author.name - current_status.color - current_status.created_at - current_status.created_by - current_status.created_by.name - current_status.html_text - current_status.modified_at - current_status.text - current_status.title - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - default_access_level - default_view - due_date - due_on - followers - followers.name - html_notes - icon - members - members.name - minimum_access_level_for_customization - minimum_access_level_for_sharing - modified_at - name - notes - owner - permalink_url - privacy_setting - project_brief - public - start_on - team - team.name - workspace - workspace.name schema: type: array items: type: string enum: - archived - color - completed - completed_at - completed_by - completed_by.name - created_at - created_from_template - created_from_template.name - current_status - current_status.author - current_status.author.name - current_status.color - current_status.created_at - current_status.created_by - current_status.created_by.name - current_status.html_text - current_status.modified_at - current_status.text - current_status.title - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - default_access_level - default_view - due_date - due_on - followers - followers.name - html_notes - icon - members - members.name - minimum_access_level_for_customization - minimum_access_level_for_sharing - modified_at - name - notes - owner - permalink_url - privacy_setting - project_brief - public - start_on - team - team.name - workspace - workspace.name style: form explode: false requestBody: description: The project to create. required: true content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ProjectRequest' responses: 201: description: Successfully retrieved projects. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ProjectResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); Project result = client.projects.createProject() .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projects.createProject({field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.ProjectsApi(); let body = new Asana.ProjectsBody.constructFromObject({data: {param1: "value1", param2: "value2",}}); // ProjectsBody | The project to create. let opts = { 'opt_fields': ["archived","color","completed","completed_at","completed_by","completed_by.name","created_at","created_from_template","created_from_template.name","current_status","current_status.author","current_status.author.name","current_status.color","current_status.created_at","current_status.created_by","current_status.created_by.name","current_status.html_text","current_status.modified_at","current_status.text","current_status.title","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.project","custom_field_settings.project.name","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.is_formula_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","default_access_level","default_view","due_date","due_on","followers","followers.name","html_notes","icon","members","members.name","minimum_access_level_for_customization","minimum_access_level_for_sharing","modified_at","name","notes","owner","permalink_url","project_brief","public","start_on","team","team.name","workspace","workspace.name"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.createProject(body, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.ProjectsApi(api_client) body = asana.ProjectsBody({"param1": "value1", "param2": "value2",}) # ProjectsBody | The project to create. opt_fields = ["archived","color","completed","completed_at","completed_by","completed_by.name","created_at","created_from_template","created_from_template.name","current_status","current_status.author","current_status.author.name","current_status.color","current_status.created_at","current_status.created_by","current_status.created_by.name","current_status.html_text","current_status.modified_at","current_status.text","current_status.title","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.project","custom_field_settings.project.name","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.is_formula_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","default_access_level","default_view","due_date","due_on","followers","followers.name","html_notes","icon","members","members.name","minimum_access_level_for_customization","minimum_access_level_for_sharing","modified_at","name","notes","owner","permalink_url","project_brief","public","start_on","team","team.name","workspace","workspace.name"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Create a project api_response = api_instance.create_project(body, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectsApi->create_project: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.projects.create_project({'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- projects->createProject(array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.projects.create_project(field: "value", field: "value", options: {pretty: true}) /projects/{project_gid}: parameters: - $ref: '#/components/parameters/project_path_gid' - $ref: '#/components/parameters/pretty' get: summary: Get a project description: Returns the complete project record for a single project. tags: - Projects operationId: getProject parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - archived - color - completed - completed_at - completed_by - completed_by.name - created_at - created_from_template - created_from_template.name - current_status - current_status.author - current_status.author.name - current_status.color - current_status.created_at - current_status.created_by - current_status.created_by.name - current_status.html_text - current_status.modified_at - current_status.text - current_status.title - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - default_access_level - default_view - due_date - due_on - followers - followers.name - html_notes - icon - members - members.name - minimum_access_level_for_customization - minimum_access_level_for_sharing - modified_at - name - notes - owner - permalink_url - privacy_setting - project_brief - public - start_on - team - team.name - workspace - workspace.name schema: type: array items: type: string enum: - archived - color - completed - completed_at - completed_by - completed_by.name - created_at - created_from_template - created_from_template.name - current_status - current_status.author - current_status.author.name - current_status.color - current_status.created_at - current_status.created_by - current_status.created_by.name - current_status.html_text - current_status.modified_at - current_status.text - current_status.title - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - default_access_level - default_view - due_date - due_on - followers - followers.name - html_notes - icon - members - members.name - minimum_access_level_for_customization - minimum_access_level_for_sharing - modified_at - name - notes - owner - permalink_url - privacy_setting - project_brief - public - start_on - team - team.name - workspace - workspace.name style: form explode: false responses: 200: description: Successfully retrieved the requested project. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ProjectResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); Project result = client.projects.getProject(projectGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projects.getProject(projectGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.ProjectsApi(); let project_gid = "1331"; // String | Globally unique identifier for the project. let opts = { 'opt_fields': ["archived","color","completed","completed_at","completed_by","completed_by.name","created_at","created_from_template","created_from_template.name","current_status","current_status.author","current_status.author.name","current_status.color","current_status.created_at","current_status.created_by","current_status.created_by.name","current_status.html_text","current_status.modified_at","current_status.text","current_status.title","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.project","custom_field_settings.project.name","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.is_formula_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","default_access_level","default_view","due_date","due_on","followers","followers.name","html_notes","icon","members","members.name","minimum_access_level_for_customization","minimum_access_level_for_sharing","modified_at","name","notes","owner","permalink_url","project_brief","public","start_on","team","team.name","workspace","workspace.name"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.getProject(project_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.ProjectsApi(api_client) project_gid = '1331' # str | Globally unique identifier for the project. opt_fields = ["archived","color","completed","completed_at","completed_by","completed_by.name","created_at","created_from_template","created_from_template.name","current_status","current_status.author","current_status.author.name","current_status.color","current_status.created_at","current_status.created_by","current_status.created_by.name","current_status.html_text","current_status.modified_at","current_status.text","current_status.title","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.project","custom_field_settings.project.name","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.is_formula_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","default_access_level","default_view","due_date","due_on","followers","followers.name","html_notes","icon","members","members.name","minimum_access_level_for_customization","minimum_access_level_for_sharing","modified_at","name","notes","owner","permalink_url","project_brief","public","start_on","team","team.name","workspace","workspace.name"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Get a project api_response = api_instance.get_project(project_gid, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectsApi->get_project: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.projects.get_project(project_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- projects->getProject($project_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.projects.get_project(project_gid: 'project_gid', param: "value", param: "value", options: {pretty: true}) put: summary: Update a project description: |- A specific, existing project can be updated by making a PUT request on the URL for that project. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged. When using this method, it is best to specify only those fields you wish to change, or else you may overwrite changes made by another user since you last retrieved the task. Returns the complete updated project record. tags: - Projects operationId: updateProject parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - archived - color - completed - completed_at - completed_by - completed_by.name - created_at - created_from_template - created_from_template.name - current_status - current_status.author - current_status.author.name - current_status.color - current_status.created_at - current_status.created_by - current_status.created_by.name - current_status.html_text - current_status.modified_at - current_status.text - current_status.title - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - default_access_level - default_view - due_date - due_on - followers - followers.name - html_notes - icon - members - members.name - minimum_access_level_for_customization - minimum_access_level_for_sharing - modified_at - name - notes - owner - permalink_url - privacy_setting - project_brief - public - start_on - team - team.name - workspace - workspace.name schema: type: array items: type: string enum: - archived - color - completed - completed_at - completed_by - completed_by.name - created_at - created_from_template - created_from_template.name - current_status - current_status.author - current_status.author.name - current_status.color - current_status.created_at - current_status.created_by - current_status.created_by.name - current_status.html_text - current_status.modified_at - current_status.text - current_status.title - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - default_access_level - default_view - due_date - due_on - followers - followers.name - html_notes - icon - members - members.name - minimum_access_level_for_customization - minimum_access_level_for_sharing - modified_at - name - notes - owner - permalink_url - privacy_setting - project_brief - public - start_on - team - team.name - workspace - workspace.name style: form explode: false requestBody: description: The updated fields for the project. required: true content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ProjectUpdateRequest' responses: 200: description: Successfully updated the project. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ProjectResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); Project result = client.projects.updateProject(projectGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projects.updateProject(projectGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.ProjectsApi(); let body = new Asana.ProjectsProjectGidBody.constructFromObject({data: {param1: "value1", param2: "value2",}}); // ProjectsProjectGidBody | The updated fields for the project. let project_gid = "1331"; // String | Globally unique identifier for the project. let opts = { 'opt_fields': ["archived","color","completed","completed_at","completed_by","completed_by.name","created_at","created_from_template","created_from_template.name","current_status","current_status.author","current_status.author.name","current_status.color","current_status.created_at","current_status.created_by","current_status.created_by.name","current_status.html_text","current_status.modified_at","current_status.text","current_status.title","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.project","custom_field_settings.project.name","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.is_formula_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","default_access_level","default_view","due_date","due_on","followers","followers.name","html_notes","icon","members","members.name","minimum_access_level_for_customization","minimum_access_level_for_sharing","modified_at","name","notes","owner","permalink_url","project_brief","public","start_on","team","team.name","workspace","workspace.name"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. }; apiInstance.updateProject(bodyproject_gid, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.ProjectsApi(api_client) body = asana.ProjectsProjectGidBody({"param1": "value1", "param2": "value2",}) # ProjectsProjectGidBody | The updated fields for the project. project_gid = '1331' # str | Globally unique identifier for the project. opt_fields = ["archived","color","completed","completed_at","completed_by","completed_by.name","created_at","created_from_template","created_from_template.name","current_status","current_status.author","current_status.author.name","current_status.color","current_status.created_at","current_status.created_by","current_status.created_by.name","current_status.html_text","current_status.modified_at","current_status.text","current_status.title","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.project","custom_field_settings.project.name","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.is_formula_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","default_access_level","default_view","due_date","due_on","followers","followers.name","html_notes","icon","members","members.name","minimum_access_level_for_customization","minimum_access_level_for_sharing","modified_at","name","notes","owner","permalink_url","project_brief","public","start_on","team","team.name","workspace","workspace.name"] # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. (optional) try: # Update a project api_response = api_instance.update_project(body, project_gid, opt_fields=opt_fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectsApi->update_project: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.projects.update_project(project_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- projects->updateProject($project_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.projects.update_project(project_gid: 'project_gid', field: "value", field: "value", options: {pretty: true}) delete: summary: Delete a project description: |- A specific, existing project can be deleted by making a DELETE request on the URL for that project. Returns an empty data record. tags: - Projects operationId: deleteProject responses: 200: description: Successfully deleted the specified project. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/EmptyResponse' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 500: $ref: '#/components/responses/InternalServerError' x-readme: code-samples: - language: java install: >- com.asanaasana1.0.0 code: >- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.projects.deleteProject(projectGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: >- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projects.deleteProject(projectGid) .then((result) => { console.log(result); }); - language: node install: npm install asana@2.0.6 code: |- const Asana = require('asana'); let defaultClient = Asana.ApiClient.instance; // Configure OAuth2 access token for authorization: oauth2 let oauth2 = defaultClient.authentications['oauth2']; oauth2.accessToken = ''; let apiInstance = new Asana.ProjectsApi(); let project_gid = "1331"; // String | Globally unique identifier for the project. apiInstance.deleteProject(project_gid, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2)); } }); name: node-beta - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: oauth2 configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class api_instance = asana.ProjectsApi(api_client) project_gid = '1331' # str | Globally unique identifier for the project. try: # Delete a project api_response = api_instance.delete_project(project_gid) pprint(api_response) except ApiException as e: print("Exception when calling ProjectsApi->delete_project: %s\n" % e) - language: python install: pip install asana==3.2.1 code: >- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.projects.delete_project(project_gid, opt_pretty=True) name: python-old - language: php install: composer require asana/asana code: >- projects->deleteProject($project_gid, array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: >- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.projects.delete_project(project_gid: 'project_gid', options: {pretty: true}) /projects/{project_gid}/duplicate: parameters: - $ref: '#/components/parameters/project_path_gid' - $ref: '#/components/parameters/pretty' post: summary: Duplicate a project description: >- Creates and returns a job that will asynchronously handle the duplication. tags: - Projects operationId: duplicateProject parameters: - name: opt_fields in: query description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. required: false example: - new_project - new_project.name - new_project_template - new_project_template.name - new_task - new_task.created_by - new_task.name - new_task.resource_subtype - new_task_template - new_task_template.name - resource_subtype - status schema: type: array items: type: string enum: - new_project - new_project.name