Asana | Documentation

The Asana component is an application component that allows users to do anything available on Asana. It can carry out the following tasks:

Crud Goal
Crud Task
Crud Project
Crud Portfolio

#Release Stage

Alpha

#Configuration

The component definition and tasks are defined in the definition.json and tasks.json files respectively.

#Setup

In order to communicate with Asana, the following connection details need to be provided. You may specify them directly in a pipeline recipe as key-value pairs within the component's setup block, or you can create a Connection from the Integration Settings page and reference the whole setup as setup: ${connection.<my-connection-id>}.

Field	Field ID	Type	Note
Token (required)	`token`	string	Fill in your Asana Personal Access Token (PAT). You can generate one from developer console

#Supported Tasks

#Crud Goal

Create, Update, Delete, Read and Duplicate goal in Asana

Input	ID	Type	Description
Task ID (required)	`task`	string	`TASK_CRUD_GOAL`
Action	`action`	object	action

The action Object

Action

action must fulfill one of the following schemas:

`Get`

Get Goal

Field	Field ID	Type	Note
Action	`action`	string	Must be `"get"`
Goal ID	`goal-gid`	string	Globally unique identifier (GID) for the goal. You can find the GID of a goal from the URL of the goal in Asana. For example, if the URL of the goal is https://app.asana.com/0/goal/1234567890, then the GID is 1234567890.

`Update`

Update Goal

Field	Field ID	Type	Note
Action	`action`	string	Must be `"update"`
Due Date	`due-on`	string	The date on which the goal is due. In the format YYYY-MM-DD.
Goal ID	`goal-gid`	string	Globally unique identifier (GID) for the goal. You can find the GID of a goal from the URL of the goal in Asana. For example, if the URL of the goal is https://app.asana.com/0/goal/1234567890, then the GID is 1234567890.
Liked	`liked`	boolean	Whether the goal is liked by the user.
Goal Name	`name`	string	The name of the goal.
Goal Note	`notes`	string	The notes of the goal.
Start Date	`start-on`	string	The date on which the goal starts. In the format YYYY-MM-DD.
Status	`status`	string	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. Enum values `green` `yellow` `red` `missed` `achieved` `partial` `dropped`

`Delete`

Delete Goal.

Field	Field ID	Type	Note
Action	`action`	string	Must be `"delete"`
Goal ID	`goal-gid`	string	Globally unique identifier (GID) for the goal. You can find the GID of a goal from the URL of the goal in Asana. For example, if the URL of the goal is https://app.asana.com/0/goal/1234567890, then the GID is 1234567890.

`Create`

Create Goal

Field	Field ID	Type	Note
Action	`action`	string	Must be `"create"`
Due Date	`due-on`	string	The date on which the goal is due. In the format YYYY-MM-DD.
Liked	`liked`	boolean	Whether the goal is liked by the user.
Goal Name	`name`	string	The name of the goal.
Goal Note	`notes`	string	The notes of the goal.
Owner	`owner`	string	User GID of the Owner. You can find one by filling the workspace id in the Asana API Playground
Start Date	`start-on`	string	The date on which the goal starts. In the format YYYY-MM-DD.
Time Period	`time-period`	string	GID of the time period. You can find one by filling the workspace id in the Asana API Playground
Workspace	`workspace`	string	GID of the workspace. You can find one by filling the access token in the Asana API Playground

Output	ID	Type	Description
Goal ID (optional)	`gid`	string	Globally unique identifier (GID) for the goal.
Goal Name (optional)	`name`	string	The name of the goal.
Owner (optional)	`owner`	object	The owner of the goal.
Goal Note (optional)	`notes`	string	The notes of the goal.
Goal HTML Note (optional)	`html-notes`	string	The notes of the goal in HTML format.
Due Date (optional)	`due-on`	string	The date on which the goal is due. In the format YYYY-MM-DD.
Start Date (optional)	`start-on`	string	The date on which the goal starts. In the format YYYY-MM-DD.
Liked (optional)	`liked`	boolean	Whether the goal is liked by the user.
Likes (optional)	`likes`	array[object]	The users who likes the goal.

Output Objects in Crud Goal

Owner

Field	Field ID	Type	Note
Owner ID	`gid`	string	Globally unique identifier (GID) for the owner.
Owner Name	`name`	string	The name of the owner.

Likes

Field	Field ID	Type	Note
Like ID	`like-gid`	string	Globally unique identifier (GID) for the like.
User Name	`name`	string	The name of the user.
User ID	`user-gid`	string	Globally unique identifier (GID) for the user.

#Crud Task

Create, Update, Delete, Read and Duplicate Task in Asana

Input	ID	Type	Description
Task ID (required)	`task`	string	`TASK_CRUD_TASK`
Action	`action`	object	Action

The action Object

Action

action must fulfill one of the following schemas:

`Get`

Get Task

Field	Field ID	Type	Note
Action	`action`	string	Must be `"get"`
Task ID	`task-gid`	string	Globally unique identifier (GID) for the task.

`Update`

Update Task

Field	Field ID	Type	Note
Action	`action`	string	Must be `"update"`
Approval Status	`approval-status`	string	The approval status of the task. If you set completed to true, this field will be set to approved. Enum values `pending` `approved` `rejected` `changes_requested`
Assignee	`assignee`	string	GID of the assignee.
Completed	`completed`	boolean	Whether the task is currently marked complete.
Liked	`liked`	boolean	Whether the task is liked by the user.
Name of the task	`name`	string	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.
Notes of the task	`notes`	string	Free-form textual information associated with the task (i.e. its description).
Parent Task	`parent`	string	GID of the parent task.
Resource Subtype	`resource-subtype`	string	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. Enum values `default_task` `milestone` `section` `approval` `custom`
Task ID	`task-gid`	string	Globally unique identifier (GID) for the task.

`Delete`

Delete Task

Field	Field ID	Type	Note
Action	`action`	string	Must be `"delete"`
Task ID	`task-gid`	string	Globally unique identifier (GID) for the task.

`Create`

Create Task

Field	Field ID	Type	Note
Action	`action`	string	Must be `"create"`
Approval Status	`approval-status`	string	The approval status of the task. If you set completed to true, this field will be set to approved. Enum values `pending` `approved` `rejected` `changes_requested`
Assignee	`assignee`	string	GID of the assignee.
Completed	`completed`	boolean	Whether the task is currently marked complete.
Due Date & Time	`due-at`	string	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.
Liked	`liked`	boolean	Whether the task is liked by the user.
Task Name	`name`	string	The name of the task.
Task Notes	`notes`	string	The notes of the task.
Parent Task	`parent`	string	GID of the parent task.
Resource Subtype	`resource-subtype`	string	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. Enum values `default_task` `milestone` `section` `approval` `custom`
Start Date & Time	`start-at`	string	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.
Workspace	`workspace`	string	GID of the workspace. You can find one by filling the access token in the Asana API Playground

`Duplicate`

Duplicate Task

Field	Field ID	Type	Note
Action	`action`	string	Must be `"duplicate"`
Name	`name`	string	Name of the new task. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.
Task ID	`task-gid`	string	Globally unique identifier (GID) for the task.

`Set Parent`

Set Parent Task

Field	Field ID	Type	Note
Action	`action`	string	Must be `"set parent"`
Parent Task	`parent`	string	GID of the parent task.
Task ID	`task-gid`	string	Globally unique identifier (GID) for the task.

`Edit Tag`

Edit Tag

Field	Field ID	Type	Note
Action	`action`	string	Must be `"edit tag"`
Edit option	`edit-option`	string	Edit option. You can choose to add or remove the tag. Enum values `add` `remove`
Tag ID	`tag-gid`	string	Globally unique identifier (GID) for the tag.
Task ID	`task-gid`	string	Globally unique identifier (GID) for the task.

`Edit Follower`

Edit Follower

Field	Field ID	Type	Note
Action	`action`	string	Must be `"edit follower"`
Edit option	`edit-option`	string	Edit option. You can choose to add or remove the follower. Enum values `add` `remove`
Followers	`followers`	string	This can either be the string "me", an email, or the gid of a user. For multiple followers, separate them with commas.
Task ID	`task-gid`	string	Globally unique identifier (GID) for the task.

`Edit Project`

Edit Project

Field	Field ID	Type	Note
Action	`action`	string	Must be `"edit project"`
Edit option	`edit-option`	string	Edit option. You can choose to add or remove the project. Enum values `add` `remove`
Project ID	`project-gid`	string	Globally unique identifier (GID) for the project.
Task ID	`task-gid`	string	Globally unique identifier (GID) for the task.

Output	ID	Type	Description
Task ID (optional)	`gid`	string	Globally unique identifier (GID) for the task.
Task Name (optional)	`name`	string	The name of the task.
Task Notes (optional)	`notes`	string	The notes of the task.
Task Notes in HTML format (optional)	`html-notes`	string	The notes of the task in HTML format.
Due Date (optional)	`due-on`	string	The date on which the task is due. In the format YYYY-MM-DD.
Projects (optional)	`projects`	array[object]	The projects of the task.
Start Date (optional)	`start-on`	string	The date on which the task starts. In the format YYYY-MM-DD.
Liked (optional)	`liked`	boolean	Whether the task is liked by the user.
Likes (optional)	`likes`	array[object]	The users who likes the task.
Approval Status (optional)	`approval-status`	string	The approval status of the task. If you set completed to true, this field will be set to approved.
Resource Subtype (optional)	`resource-subtype`	string	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.
Completed (optional)	`completed`	boolean	Whether the task is currently marked complete.
Assignee (optional)	`assignee`	string	GID of the assignee.
Parent Task (optional)	`parent`	string	GID of the parent task.

Output Objects in Crud Task

Projects

Field	Field ID	Type	Note
Project ID	`gid`	string	Globally unique identifier (GID) for the project.
Project Name	`name`	string	The name of the project.

Likes

Field	Field ID	Type	Note
Like ID	`like-gid`	string	Globally unique identifier (GID) for the like.
User Name	`name`	string	The name of the user.
User ID	`user-gid`	string	Globally unique identifier (GID) for the user.

#Crud Project

Create, Update, Delete, Read and Duplicate project in Asana

Input	ID	Type	Description
Task ID (required)	`task`	string	`TASK_CRUD_PROJECT`
Action	`action`	object	action

The action Object

Action

action must fulfill one of the following schemas:

`Get`

Get Project.

Field	Field ID	Type	Note
Action	`action`	string	Must be `"get"`
Project ID	`project-gid`	string	Globally unique identifier (GID) for the project.

`Update`

Update Project

Field	Field ID	Type	Note
Action	`action`	string	Must be `"update"`
Archived	`archived`	boolean	Whether the project is archived.
Update Color	`color`	string	The color of the project. Enum values `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`
Due Date	`due-on`	string	The date on which the project is due. In the format YYYY-MM-DD.
Project Name	`name`	string	The name of the project.
Project Note	`notes`	string	The notes of the project.
Update Privacy Setting	`privacy-setting`	string	The privacy setting of the project. Enum values `public to workspace` `private to team` `private`
Project ID	`project-gid`	string	Globally unique identifier (GID) for the project.
Start Date	`start-on`	string	The date on which the project starts. In the format YYYY-MM-DD.

`Delete`

Delete Project

Field	Field ID	Type	Note
Action	`action`	string	Must be `"delete"`
Project ID	`project-gid`	string	Globally unique identifier (GID) for the project.

`Create`

Create Project

Field	Field ID	Type	Note
Action	`action`	string	Must be `"create"`
Update Color	`color`	string	The color of the project. Enum values `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`
Due Date	`due-on`	string	The date on which the project is due. In the format YYYY-MM-DD.
Project Name	`name`	string	The name of the project.
Project Note	`notes`	string	The notes of the project.
Update Privacy Setting	`privacy-setting`	string	The privacy setting of the project. Enum values `public to workspace` `private to team` `private`
Start Date	`start-on`	string	The date on which the project starts. In the format YYYY-MM-DD.
Team ID	`team`	string	Globally unique identifier (GID) for the team of the new project.
Workspace ID	`workspace`	string	Globally unique identifier (GID) for the workspace. You can find one by filling the access token in the Asana API Playground

`Duplicate`

Duplicate Project

Field	Field ID	Type	Note
Action	`action`	string	Must be `"duplicate"`
Due Date	`due-on`	string	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. In the format YYYY-MM-DD.
New Project Name	`name`	string	The name of the new project.
Project ID	`project-gid`	string	Globally unique identifier (GID) for the project. You can find the GID of a goal from the URL of the project in Asana. For example, if the URL of the project is https://app.asana.com/0/goal/1234567890, then the GID is 1234567890.
Should Skip Weekends (For auto-shifted dates)	`should-skip-weekends`	boolean	Determines if the auto-shifted dates should skip weekends.
Start Date	`start-on`	string	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. In the format YYYY-MM-DD.
Team ID	`team`	string	Globally unique identifier (GID) for 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.

Output	ID	Type	Description
Project ID (optional)	`gid`	string	Globally unique identifier (GID) for the project.
Project Name (optional)	`name`	string	The name of the project.
Owner (optional)	`owner`	object	The owner of the project.
Project Note (optional)	`notes`	string	The notes of the project.
Project HTML Note (optional)	`html-notes`	string	The notes of the project in HTML format.
Due Date (optional)	`due-on`	string	The date on which the project is due. In the format YYYY-MM-DD.
Start Date (optional)	`start-on`	string	The date on which the project starts. In the format YYYY-MM-DD.
Completed (optional)	`completed`	boolean	Whether the project is completed.
Color (optional)	`color`	string	The color of the project.
Privacy Setting (optional)	`privacy-setting`	string	The privacy setting of the project.
Archived (optional)	`archived`	boolean	Whether the project is archived.
Completed By (optional)	`completed-by`	object	The user who completed the project.
Current Status (optional)	`current-status`	array[object]	The current status of the project.
Custom Fields (optional)	`custom-fields`	array[object]	The custom fields of the project.
Custom Field Settings (optional)	`custom-field-settings`	array[object]	The custom field settings of the project.
Modified At (optional)	`modified-at`	string	The time at which the project was last modified.

Output Objects in Crud Project

Owner

Field	Field ID	Type	Note
Owner ID	`gid`	string	Globally unique identifier (GID) for the owner.
Owner Name	`name`	string	The name of the owner.

Completed by

Field	Field ID	Type	Note
User ID	`gid`	string	Globally unique identifier (GID) for the user.
User Name	`name`	string	The name of the user.

#Crud Portfolio

Create, Update, Delete and Read portfolio in Asana

Input	ID	Type	Description
Task ID (required)	`task`	string	`TASK_CRUD_PORTFOLIO`
Action	`action`	object	action

The action Object

Action

action must fulfill one of the following schemas:

`Get`

Get Portfolio

Field	Field ID	Type	Note
Action	`action`	string	Must be `"get"`
Portfolio ID	`portfolio-gid`	string	Globally unique identifier (GID) for the portfolio.

`Update`

Update Portfolio

Field	Field ID	Type	Note
Action	`action`	string	Must be `"update"`
Update Color	`color`	string	The color of the portfolio. Enum values `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`
Portfolio Name	`name`	string	The name of the portfolio.
Portfolio ID	`portfolio-gid`	string	Globally unique identifier (GID) for the portfolio.
Public	`public`	boolean	Whether the portfolio is public.
Workspace	`workspace`	string	The workspace of the portfolio. Please fill in the Globally unique identifier (GID) for the workspace.

`Delete`

Delete Portfolio

Field	Field ID	Type	Note
Action	`action`	string	Must be `"delete"`
Portfolio ID	`portfolio-gid`	string	Globally unique identifier (GID) for the portfolio.

`Create`

Create Portfolio

Field	Field ID	Type	Note
Action	`action`	string	Must be `"create"`
Color	`color`	string	The color of the portfolio. Enum values `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`
Portfolio Name	`name`	string	The name of the portfolio.
Public	`public`	boolean	Whether the portfolio is public.
Workspace	`workspace`	string	The workspace of the portfolio. Please fill in the Globally unique identifier (GID) for the workspace.

Output	ID	Type	Description
Portfolio ID (optional)	`gid`	string	Globally unique identifier (GID) for the portfolio.
Portfolio Name (optional)	`name`	string	The name of the portfolio.
Owner (optional)	`owner`	object	The owner of the portfolio.
Due Date (optional)	`due-on`	string	The date on which the portfolio is due. In the format YYYY-MM-DD.
Start Date (optional)	`start-on`	string	The date on which the portfolio starts. In the format YYYY-MM-DD.
Color (optional)	`color`	string	The color of the portfolio.
Public (optional)	`public`	boolean	Whether the portfolio is public.
Created By (optional)	`created-by`	object	The user who created the portfolio.
Current Status (optional)	`current-status`	array[object]	The current status of the portfolio.
Custom Fields (optional)	`custom-fields`	array[object]	The custom fields of the portfolio.
Custom Field Settings (optional)	`custom-field-settings`	array[object]	The custom field settings of the portfolio.

Output Objects in Crud Portfolio

Owner

Field	Field ID	Type	Note
Owner ID	`gid`	string	Globally unique identifier (GID) for the owner.
Owner Name	`name`	string	The name of the owner.

Created by

Field	Field ID	Type	Note
User ID	`gid`	string	Globally unique identifier (GID) for the user.
User Name	`name`	string	The name of the user.