The CData Sync App provides a straightforward way to continuously pipeline your Asana data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The Asana connector can be used from the CData Sync application to pull data from Asana and move it to any of the supported destinations.
The Sync App leverages the Asana API to enable bidirectional access to Asana work management entities.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
You can optionally set the following to refine the data returned from Asana.
Asana uses the OAuth or OAuthPKCE authentication standard.
AuthScheme must be set to OAuth in all user account flows.
Set AuthScheme to OAuthPKCE.
For more more information, see the Asana documentation for personal access tokens and service accounts.
These permissions are defined by access scopes, which determine what data your application can access and what actions it can perform.
This topic provides information about the required access scopes and endpoint domains for the Asana Sync App.
Scopes are a way to limit an application's access to a user's data. They define the specific actions that an application can perform on behalf of the user.
For example, a read-only scope might allow an application to view data, while a full access scope might allow it to modify data.
| Scope | Description |
| default | Asana does not provide the ability to limit read-only access. This is the default scope and the only scope available. |
Endpoint domains are the specific URLs that the application needs to communicate with in order to authenticate, retrieve records, and perform other essential operations.
Allowlisting these domains ensures that the network traffic between your application and the API is not blocked by firewalls or security settings.
Note: Most users do not need to make any special configurations. Allowlisting is typically only necessary for environments with strict security measures, such as restricted outbound network traffic.
| Domain | Always Required | Description |
| app.asana.com | TRUE | The domain of your Asana instance. |
This section details a selection of advanced features of the Asana Sync App.
The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .
Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
For further information, see Query Processing.
By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.
To specify another certificate, see the SSLServerCert connection property.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
This section shows the available API objects and provides more information on executing SQL to Asana APIs.
Views describes the available views. Views are statically defined to model Projects, Users, Workspaces, and more.
Stored Procedures are function-like interfaces to Asana. Stored procedures allow you to execute operations to Asana, including downloading documents and moving envelopes.
The Sync App models the data in Asana as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| Allocations | To Create, Update, Delete and Query the Allocations table. |
| Attachments | To Delete and Query from the Attachments in the tasks. |
| GoalMembership | To Create, Delete and Query memberships in the Goal. |
| Goals | To Create, Update, Delete and Query the Goals table. |
| PortfolioItems | To Create, delete, and Query Items in the Portfolio. |
| PortfolioMembership | To Create, Delete and Query memberships in the Portfolio. |
| Portfolios | To Create, update, delete, and query from Portfolios table. |
| ProjectMembership | To Create, Delete and Query memberships in the Project. |
| Projects | To Create, Update, Delete and Query the Projects table. |
| ProjectStatuses | To Create, Delete and Query from ProjectStatuses table. A project status is an update on the progress of a particular project, and is sent out to all project followers when created. |
| Sections | To Create, Update, Delete, and Query from Sections table. A section is a subdivision of a project that groups tasks together. |
| StatusUpdates | A status update is an update on the progress of a particular object, and is sent out to all followers when created. |
| Stories | To Create, Update, Delete and Query from stories table. 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. |
| SubTasks | To Create, update, delete, and query from SubTasks table. |
| Tags | To Create, Update and Query from Tags table. A tag is a label that can be attached to any task in Asana. It exists in a single workspace. |
| Tasks | To Create, Update, Delete and Query from Tasks table. |
| TaskTemplates | To Delete and Query the task templates. |
| TeamMembership | To represents a users connection to a team. |
| Teams | A team is used to group related projects and people together within an organization. Each project in an organization is associated with a team. |
| TimeTrackingEntries | Returns time tracking entries for a given task. |
| WorkspaceMembership | To Create, Delete and Query memberships in the Workspace. |
| Workspaces | To Update and Query from Workspaces table. A workspace is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace. |
To Create, Update, Delete and Query the Allocations table.
The Sync App uses the Asana API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM Allocations WHERE Id = '1127092449876457' SELECT * FROM Allocations WHERE Assignee = '1126938691750986' AND WorkspaceId = '1126938837961830' SELECT * FROM Allocations WHERE Parent = '1208149945266501'
StartDate, EndDate, Assignee and Parent are mandatory columns for inserting into the Allocations table. For example:
INSERT INTO Allocations (StartDate, EndDate, AssigneeId, ParentId, EffortType, EffortValue) VALUES ('2024-01-11', '2024-02-11', '1208125247305564', '1207717475644852', 'hours', 20)
The following is an example of how to update the Allocations table:
UPDATE Allocations SET StartDate = '2024-01-11', EndDate = '2024-02-11', Assignee = '1208125247305564', Parent = '1207717475644852', EffortType = 'hours', EffortValue = 20 WHERE Id = '12345'
The following is an example of how to delete from the Allocations table:
DELETE FROM Allocations WHERE Id = '1234'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the user. | |
| ResourceType | String | True |
The base type of this resource. | |
| StartDate | Date | False |
The localized day on which the allocation starts. | |
| EndDate | Date | False |
The localized day on which the allocation ends. | |
| EffortType | String | False |
The units used for tracking effort on an allocation, either The allowed values are hours, percent. | |
| EffortValue | Integer | False |
The numeric effort value on the allocation. | |
| Assignee | String | False |
Users.Id |
Globally unique identifier of the resource, as a string. |
| AssigneeName | String | True |
The name of allocation resource. | |
| CreatedById | String | True |
Globally unique identifier of the resource, as a string. | |
| CreatedByName | String | True |
Read-only except when same user as requester. The user's name. | |
| Parent | String | False |
Projects.Id |
Globally unique identifier of the resource, as a string. |
| ParentName | String | True |
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. | |
| ResourceSubType | String | True |
The subtype of the allocation. | |
| WorkspaceId | String | True |
Workspaces.Id |
Globally unique ID of the workspace. |
To Delete and Query from the Attachments in the tasks.
The Sync App will use the Asana API to process WHERE clause conditions built with the following column and operator. The TaskId or Id is required to make a request and the rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM Attachments WHERE Id = '1134618934491707' SELECT * FROM Attachments WHERE TaskId = '1128092964672854'
Following is an example of how to delete from Attachments table:
DELETE FROM Attachments WHERE Id = '1134618934491707'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the attachment. | |
| Name | String | True |
The name of the file. | |
| Host | String | True |
The service hosting the attachment. Valid values are asana, dropbox, gdrive and box. | |
| CreatedAt | Datetime | True |
The time at which this attachment was uploaded. | |
| ViewURL | String | True |
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. | |
| DownloadURL | String | True |
May be null if the attachment is hosted by box. If present, this URL may only be valid for 1 hour 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. | |
| TaskId | String | True |
Tasks.Id |
The task this attachment is attached to. |
| ResourceType | String | True |
The resource type of this resource. | |
| ResourceSubtype | String | True |
The service hosting the attachment. Valid values are asana, dropbox, gdrive, onedrive, box, vimeo, and external. | |
| PermanentURL | String | True |
PermanentURL | |
| Size | Integer | True |
The size of the attachment in bytes. Only present when the resource_subtype is asana. | |
| ConnectedToApp | Boolean | True |
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. |
To Create, Delete and Query memberships in the Goal.
The Sync App will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM GoalMembership SELECT * FROM GoalMembership WHERE Id = '1126938837961834' SELECT * FROM GoalMembership WHERE MemberId = '1126938837961830' SELECT * FROM GoalMembership WHERE GoalId = '1126938691750986'
GoalId and MemberId is a mandatory column for inserting into GoalMembership table. For example:
INSERT INTO GoalMembership (GoalId, MemberId) VALUES ('1161963899354167', '1126938837961830')
Following is an example of how to delete from GoalMembership table:
DELETE FROM GoalMembership WHERE Id = '1161963899354167'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique Id of the goal membership. | |
| GoalId | String | False |
Goals.Id |
Globally unique identifier for goal. |
| GoalName | String | True |
The name of the goal. | |
| GoalOwnerGid | String | True |
Globally unique identifier of the goal owner. | |
| GoalOwnerName | String | True |
The name of the goal owner. | |
| Role | String | True |
Describes if the member is a commenter or editor in goal. | |
| MemberId | String | False |
Globally unique identifier of the member of the goal. | |
| MemberName | String | True |
The name of the member. | |
| MemberResourceType | String | True |
The type of the member (team or user). | |
| ResourceSubtype | String | True |
The type of membership. | |
| ResourceType | String | True |
The base type of this resource. |
To Create, Update, Delete and Query the Goals table.
The Sync App will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM Goals SELECT * FROM Goals WHERE Id = '1126938837961834' SELECT * FROM Goals WHERE IsWorkspaceLevel = 'false' SELECT * FROM Goals WHERE TeamId = '122334345323466' AND WorkspaceId = '1126938837961830' SELECT * FROM Goals WHERE TimeId = '1243436322145547' SELECT * FROM Goals WHERE WorkspaceId = '1126938837961830'
UserId and Goals is a mandatory column for inserting into Goals table. For example:
INSERT INTO Goals (Name, DueOn, StartOn, IsWorkspaceLevel, liked, WorkspaceId, OwnerId, TimePeriodId) VALUES ('Sample Goal', '2023-10-31', '2023-09-15', 'false', 'false', '1203124527069362', '1203124437606434', '1203124434984659' )
Inserting multiple Followers into Goals table. For example:
INSERT INTO Goals (Name, WorkspaceId, OwnerId, Followers) VALUES ('Sample Goal', '1203124527069362', '1203124437606434', '1206414724399714,1207035318501516' )
Following is an example of how to update a Goals table:
UPDATE Goals SET DueOn ='2023-10-20' WHERE Id = '1128092864672888'
Following is an example of how to delete from Goals table:
DELETE FROM Goals WHERE Id = '1161963899354167'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
Globally unique Id of the goal. | |
| ResourceType | String | True |
The base type of this resource. | |
| Name | String | False |
The name of the goal. | |
| OwnerId | String | False |
Globally unique Id of the owner. | |
| OwnerName | String | True |
The name of the owner. | |
| OwnerResourceType | String | True |
The base type of this resource. | |
| DueOn | Date | False |
The localized day on which this goal is due. | |
| StartOn | Date | False |
The day on which work for this goal begins. | |
| CurrentStatusUpdateId | String | True |
Globally unique identifier of the resource, as a string. | |
| CurrentStatusUpdateResourceSubtype | String | True |
The base type of this resource. | |
| CurrentStatusUpdateResourceType | String | True |
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. | |
| CurrentStatusUpdateResourceTitle | String | True |
The title of the status update. | |
| Followers | String | False |
Array of users who are members of this goal. | |
| IsWorkspaceLevel | Boolean | False |
Whether the goal belongs to the workspace. | |
| Liked | Boolean | False |
True if the goal is liked by the authorized user, false if not. | |
| Likes | String | True |
Array of likes for users who have liked this goal. | |
| MetricId | String | True |
Globally unique identifier of the metric. | |
| MetricCurrencyCode | String | True |
ISO 4217 currency code to format this custom field. This will be null if the unit is not currency. | |
| MetricCurrentDisplayValue | String | True |
This string is the current value of a goal metric of type string. | |
| MetricCurrentNumberValue | Integer | True |
This number is the current value of a goal metric of type number. | |
| MetricInitialNumberValue | Integer | True |
This number is the start value of a goal metric of type number. | |
| MetricPrecision | Integer | True |
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. | |
| MetricProgressSource | String | True |
This field defines how the progress value of a goal metric is being calculated. | |
| MetricResourceSubtype | String | True |
The subtype of this resource. | |
| MetricResourceType | String | True |
The base type of this resource. | |
| MetricTargetNumberValue | Integer | True |
This number is the end value of a goal metric of type number. This number cannot equal initial_number_value. | |
| MetricUnit | String | True |
A supported unit of measure for the goal metric, or none. The allowed values are none, currency, percentage. | |
| Notes | String | False |
Free-form textual information associated with the goal. | |
| HtmlNotes | String | False |
The notes of the goal with formatting as HTML. | |
| NumLikes | Integer | True |
The number of users who have liked this goal. | |
| Status | String | False |
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. | |
| TeamId | String | False |
Teams.Id |
Globally unique identifier of the team. |
| TeamName | String | True |
The name of the team. | |
| TimePeriodId | String | False |
Globally unique identifier of the time period. | |
| TimePeriodDisplayName | String | True |
A string representing the cadence code and the fiscal year. | |
| TimePeriodStartOn | Date | True |
The localized end date of the time period. | |
| TimePeriodEndOn | Date | True |
The localized end date of the time period. | |
| TimePeriodPeriod | String | True |
The cadence and index of the time period. The value is one of: FY, H1, H2, Q1, Q2, Q3, or Q4. The allowed values are FY, H1, H2, Q1, Q2, Q3, Q4. | |
| WorkspaceId | String | False |
Workspaces.Id |
Globally unique identifier of the workspace. |
| WorkspaceName | String | True |
The name of the workspace. |
To Create, delete, and Query Items in the Portfolio.
The Sync App will use the Asana API to process WHERE clause conditions built with the following column and operator. The PortfolioId is required to make a request and rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM PortfolioItems WHERE PortfolioId = '1173026173301164'
ProjectId and PortfolioId is a mandatory column for inserting into PortfolioItems table. For example:
INSERT INTO PortfolioItems (ProjectId, PortfolioId) VALUES ('1173023668354420', '1173026173301164')
Following is an example of how to delete from PortfolioItems table:
DELETE FROM PortfolioItems WHERE ProjectId = '1173023668354420' AND PortfolioId = '1173026173301164'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the Portfolio Item. | |
| Name | String | True |
Name of the Item. | |
| PortfolioId [KEY] | String | True |
Portfolios.Id |
Globally unique ID of the portfolio. |
| OwnerId | String | True |
Globally unique ID of the Owner. | |
| StartOn | Date | True |
The day on which work for this project begins, or null if the project has no start date. | |
| DueOn | Date | True |
The day on which this project is due. This takes a date with format YYYY-MM-DD. | |
| ProjectId | String | True |
Projects.Id |
Globally unique ID of the Project. This column is a Pseudocolmn and its used for INSERT and UPDATE. |
To Create, Delete and Query memberships in the Portfolio.
The Sync App will use the Asana API to process WHERE clause conditions built with the following column and operator. The [WorkspaceId AND UserId] OR PortfolioId OR Id is required to make a request and rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM PortfolioMembership WHERE WorkspaceId = '1172686716695308' AND UserId = '1172686741877880' SELECT * FROM PortfolioMembership WHERE PortfolioId = '1172684730399265' SELECT * FROM PortfolioMembership WHERE Id = '1172684730399266'
PortfolioId and UserId is a mandatory column for inserting into PortfolioMembership table. For example:
INSERT INTO PortfolioMembership (PortfolioId, UserId) VALUES ('1172684730399265', '1172686741877880')
Following is an example of how to delete from PortfolioMembership table:
DELETE FROM PortfolioMembership WHERE PortfolioId = '1172684730399265' AND UserId = '1172686741877880'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the portfoolio membership. | |
| PortfolioId [KEY] | String | True |
Portfolios.Id |
The portfolio the user is a member of. |
| PortfolioName | String | True |
The name of the portfolio. | |
| UserId [KEY] | String | True |
Users.Id |
Globally unique ID of the user. |
| UserName | String | True |
The users name. | |
| ResourceType | String | True |
The resource type of this resource. | |
| WorkspaceId | String | True |
Workspaces.Id |
Globally unique ID of the workspace. This column is a Pseudocolmn and its used in SELECT Query. |
To Create, update, delete, and query from Portfolios table.
The Sync App will use the Asana API to process WHERE clause conditions built with the following column and operator. The [WorkspaceId AND OwnerId] OR Id is required to make a request and rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM Portfolios WHERE WorkspaceId = '1172686716695308' AND OwnerId = '1172686741877880' SELECT * FROM Portfolios WHERE Id = '1172684730399265'
WorkspaceId is a mandatory column for inserting into Portfolios table. For example:
INSERT INTO Portfolios (Name, Color, WorkspaceId) VALUES ('Test', 'dark-pink', '1172686716695308'
Following is an example of how to update a Portfolios table:
"UPDATE Portfolios SET Name = 'IT-Test' WHERE Id = '1173026173301164'
Following is an example of how to delete from Portfolios table:
DELETE FROM Portfolios WHERE Id = '1172684730399265'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the portfolio. | |
| Name | String | False |
Name of the portfolio. | |
| Color | String | False |
Color of the portfolio. The allowed values are 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. | |
| CreatedAt | Datetime | True |
The time at which this portfolio was created. | |
| CreatorId | String | True |
Globally unique ID of the user created this portfolio. | |
| CreatorName | String | True |
The users name. | |
| Members | String | False |
Array of users who are members of this portfolio. | |
| OwnerId | String | False |
Users.Id |
Globally unique ID of the Owner. API users can only get a list of portfolios that they themselves own. |
| OwnerName | String | True |
The Owners Name. | |
| ResourceType | String | True |
The base type of this resource. | |
| WorkspaceId | String | False |
Workspaces.Id |
The workspace or organization that the portfolio belongs to. |
| WorkspaceName | String | True |
Name of the workspace. | |
| ItemURL | String | True |
A url that points directly to the object within Asana. | |
| CurrentStatusUpdateId | String | True |
Globally unique identifier of the resource, as a string. | |
| CurrentStatusUpdateResourceType | String | True |
The base type of this resource. | |
| CurrentStatusUpdateTitle | String | True |
The title of the status update. | |
| CurrentStatusUpdateResourceSubtype | String | True |
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. | |
| StartOn | Date | True |
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. | |
| Public | Boolean | False |
True if the portfolio is public to its workspace members. | |
| ProjectTemplates | String | True |
Array of project templates that are in the portfolio |
To Create, Delete and Query memberships in the Project.
The Sync App will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM ProjectMembership WHERE Id = '1127092449876445' SELECT * FROM ProjectMembership WHERE ProjectId = '1127092449876444'
UserId and ProjectId is a mandatory column for inserting into ProjectMembership table. For example:
INSERT INTO ProjectMembership (UserId, ProjectId) VALUES ('1161963899354167', '1128092964672848')
Following is an example of how to delete from ProjectMembership table:
DELETE FROM ProjectMembership WHERE UserId = '1161963899354167' AND ProjectId = '1128092964672848'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the project membership. | |
| ProjectId [KEY] | String | False |
Projects.Id |
The project the user is a member of. |
| WriteAccess | String | True |
Whether the user has full access to the project or has comment-only access. | |
| UserId [KEY] | String | False |
Users.Id |
The user in the membership. |
| ResourceType | String | True |
The resource type of this resource. | |
| MemberResourceType | String | True |
The resource type of the member (team or user). | |
| ResourceSubtype | String | True |
Type of the membership. |
To Create, Update, Delete and Query the Projects table.
The Sync App will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM projects WHERE workspaceId = '1126938837961830' SELECT * FROM projects WHERE Id = '1128092864672888' SELECT * FROM projects WHERE TaskId = '1130092964672468' SELECT * FROM projects WHERE TeamId = '1129514033997890'
WorkspaceId or TeamId is a mandatory column for inserting into Projects table. For example:
INSERT INTO Projects (Name, Color, StartOn, WorkspaceId, DueOn, public, UserId) VALUES ('ProjectName', 'dark-pink', '2020-03-01', '1126938837961830', '2020-04-30', false, '1130062547672468')
Inserting multiple Followers into Projects table. For example:
INSERT INTO Projects (WorkspaceId, Followers) VALUES ('1126938837961830', '1206414724399714,1207035318501516' )
Following is an example of how to update a Projects table:
UPDATE Projects SET TeamId = '1129514033997890' WHERE Id = '1128092864672888'
Following is an example of how to delete from Projects table:
DELETE FROM Projects WHERE Id = '1128092864672888'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the project. | |
| Name | String | False |
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. | |
| Color | String | False |
Color of the project. Must be either null or one of: 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-yellow, light-orange, light-purple, light-warm-gray. The allowed values are 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, green, yellow, red. | |
| CreatedAt | Datetime | True |
The time at which this project was created. | |
| ModifiedAt | Datetime | True |
The time at which this project was last modified. | |
| StartOn | Date | False |
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 must be present in the request when setting or unsetting the start_on parameter. | |
| DueOn | Date | False |
The day on which this project is due. This takes a date with format YYYY-MM-DD. | |
| DefaultView | String | False |
The default view of a project. The allowed values are list, board, calendar, timeline. | |
| Followers | String | False |
Followers are a subset of members who receive all notifications for a project. | |
| Archived | Boolean | False |
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. | |
| UserId | String | False |
Users.Id |
The current owner of the project. |
| TeamId | String | False |
Teams.Id |
The team that this project is shared with. This field only exists for projects in organizations. |
| WorkspaceId | String | True |
Workspaces.Id |
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. |
| Public | Boolean | False |
True if the project is public to the organization. If false, do not share this project with other users in this organization without explicitly checking to see if they have access. For new integrations, please refer to PrivacySetting column. | |
| Notes | String | False |
More detailed, free-form textual information associated with the project. | |
| HTMLNotes | String | False |
The notes of the project with formatting as HTML. | |
| IsTemplate | Boolean | False |
Determines if the project is a template. | |
| Layout | String | True |
The layout (board or list view) of a project. | |
| Members | String | True |
Array of users who are members of this project. | |
| SectionMigrationStatus | String | True |
The section migration status of this project. | |
| PrivacySetting | String | False |
The privacy setting of the project. | |
| TaskId | String | True |
Tasks.Id |
Globally unique ID of the Task. |
| ItemURL | String | True |
A url that points directly to the object within Asana. | |
| CurrentStatusUpdateId | String | True |
Globally unique identifier of the resource, as a string. | |
| CurrentStatusUpdateResourceType | String | True |
The base type of this resource. | |
| CurrentStatusUpdateTitle | String | False |
The title of the status update. | |
| CurrentStatusUpdateResourceSubtype | String | True |
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. | |
| ResourceType | String | True |
The base type of this resource. | |
| DefaultAccessLevel | String | False |
The default access for users or teams who join or are added as members to the project. The allowed values are admin, editor, commenter, viewer. | |
| MinimumAccessLevelForCustomization | String | False |
The minimum access level needed for project members to modify this project's workflow and appearance. The allowed values are admin, editor. | |
| MinimumAccessLevelForSharing | String | False |
The minimum access level needed for project members to share the project and manage project memberships. The allowed values are admin, editor. | |
| Completed | Boolean | True |
True if the project is currently marked complete, false if not. | |
| CompletedAt | Datetime | True |
The time at which this project was completed, or null if the project is not completed. | |
| CompletedById | String | True |
Globally unique identifier of the resource, as a string. | |
| CompletedByResourceType | String | True |
The base type of this resource. | |
| CompletedByName | String | True |
Read-only except when same user as requester. The user�s name. | |
| Icon | String | True |
The icon for a project. | |
| ProjectBriefId | String | True |
The project brief associated with this project. | |
| ProjectBriefResourceType | String | True |
The project brief associated with this project. | |
| CreatedFromTemplateId | String | True |
Id of the project template from which this project was created. If the project was not created from a template, this field will be null. | |
| CreatedFromTemplateResourceType | String | True |
Resource type of the project template from which this project was created. If the project was not created from a template, this field will be null. | |
| CreatedFromTemplateName | String | True |
Name of the project template from which this project was created. If the project was not created from a template, this field will be null. |
To Create, Delete and Query from ProjectStatuses table. A project status is an update on the progress of a particular project, and is sent out to all project followers when created.
The Sync App will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM ProjectStatuses WHERE Id = '1127092449876445' SELECT * FROM ProjectStatuses WHERE ProjectId = '1127092449876444'
ProjectId is a mandatory column for inserting into ProjectStatuses table. For example:
INSERT INTO projectstatuses (Color, Title, Text, ProjectId) VALUES ('red', 'Status1', 'StatusNotes', '1127092449876444')
Following is an example of how to delete from ProjectStatuses table:
DELETE FROM ProjectStatuses WHERE Id = '1127092449876445'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the project status update. | |
| Color | String | True |
The color associated with the status update. The allowed values are green, yellow, red. | |
| Title | String | True |
The title of the project status update. | |
| Text | String | True |
The text content of the status update. | |
| CreatedAt | Datetime | True |
The time at which the status update was created. | |
| CreatedBy | String | True |
Users.Id |
The creator of the status update. |
| ProjectId | String | True |
Projects.Id |
Globally unique ID of the project. |
| ResourceType | String | True |
The resource type of this resource. The value for this resource is always project_status. | |
| HTMLText | String | True |
The notes of the project with formatting as HTML. |
To Create, Update, Delete, and Query from Sections table. A section is a subdivision of a project that groups tasks together.
The Sync App will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM Sections WHERE Id = '1127092449876457' SELECT * FROM Sections WHERE ProjectId = '1128092964672848'
ProjectId is a mandatory column for inserting into Sections table. For example:
INSERT INTO Sections (Name, ProjectId) VALUES ('SectionName', '1128092964672848')
Following is an example of how to update a Sections table:
UPDATE Sections SET Name = 'IT-Pending' WHERE Id = '1127092449876457'
Following is an example of how to delete from Sections table:
DELETE FROM Sections WHERE Id = '1127092449876457'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the section. | |
| Name | String | False |
The name of the section. | |
| CreatedAt | Datetime | True |
The time at which the section was created. | |
| ResourceType | String | True |
The resource type of this resource. | |
| ProjectId | String | False |
Projects.Id |
The section under the project. |
A status update is an update on the progress of a particular object, and is sent out to all followers when created.
The Sync App will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM StatusUpdates SELECT * FROM StatusUpdates WHERE Id = '1126938837961834' SELECT * FROM StatusUpdates WHERE ParentId = '1126938837961834'
Text, StatusType and ParentId are mandatory columns for inserting into StatusUpdates table. For example:
INSERT INTO StatusUpdates(ParentId,Title,Text,StatusType) VALUES('1203125557018928','asd','tewr','on_track')
Following is an example of how to delete from StatusUpdates table:
DELETE FROM StatusUpdates WHERE Id = '1161963899354167'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique identifier of the resource, as a string. | |
| AuthorId | String | True |
A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks. Globally unique identifier of the resource. | |
| AuthorName | String | True |
A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks. The user�s name. | |
| AuthorResourceType | String | True |
A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks. The base type of this resource. | |
| CreatedAt | Datetime | True |
The time at which this resource was created. | |
| CreatedById | String | True |
A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks. Globally unique identifier of the resource. | |
| CreatedByName | String | True |
A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks. The user�s name. | |
| CreatedByResourceType | String | True |
A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks. The base type of this resource. | |
| Liked | Boolean | True |
True if the status is liked by the authorized user, false if not. | |
| Likes | String | True |
Array of likes for users who have liked this status. | |
| ModifiedAt | Datetime | True |
The time at which this project status was last modified. | |
| NumLikes | Integer | True |
The number of users who have liked this status. | |
| ParentId | String | False |
Id of parent of the status update. | |
| ParentName | String | True |
Name of parent of the status update. | |
| ParentResourceType | String | True |
Resource type of parent of the status update. | |
| ResourceSubtype | String | True |
The subtype of this resource. | |
| ResourceType | String | True |
The base type of this resource. | |
| StatusType | String | False |
The type associated with the status update. The allowed values are on_track, at_risk, off_track, on_hold, complete, achieved, partial, missed, dropped. | |
| Text | String | False |
The text content of the status update. | |
| HTMLText | String | False |
The text content of the status update with formatting as HTML. | |
| Title | String | False |
The title of the status update. |
To Create, Update, Delete and Query from stories table. 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.
The Sync App will use the Asana API to process WHERE clause conditions built with the following column and operator. The TaskId or Id is required to make a request and rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM Stories WHERE Id = '1126938691750986' SELECT * FROM Stories WHERE TaskId = '1129514033997892'
TaskId is a mandatory column for inserting into Stories table. For example:
INSERT INTO Stories (Text, TaskId, IsPinned) VALUES ('InProgress', '1129514033997892', false)
Following is an example of how to update a Stories table:
UPDATE Stories SET Text = 'story line' WHERE Id = '1126938691750986'
Following is an example of how to delete from Stories table:
DELETE FROM Stories WHERE Id = '1126938691750986'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the story. | |
| Text | String | False |
Formatted text for the story or comment. | |
| CreatedAt | Datetime | True |
The time at which this story was created. | |
| creatorId | String | True |
Users.Id |
The user who created the story. |
| creatorName | String | False |
Users.Name |
The user who created the story. |
| Source | String | True |
The component of the Asana product the user used to create the story. | |
| TaskId | String | False |
Tasks.Id |
The story under the task. |
| Liked | Boolean | True |
True if the story is liked by the authorized user, false if not. | |
| IsPinned | Boolean | False |
This field is only present on comment and attachment stories. | |
| IsEdited | Boolean | True |
Whether the text of the story has been edited after creation. | |
| ResourceType | String | True |
The resource type of this resource. | |
| ResourceSubType | String | True |
The type of story. This provides fine-grained information about what triggered the story creation. | |
| HtmlText | String | True |
HTML formatted text for a comment. | |
| DuplicateTaskOf | String | True |
Tasks.Id |
The task is the basic object around which many operations in Asana are centered. |
| DependencyTaskId | String | True |
Tasks.Id |
The task is the basic object around which many operations in Asana are centered. |
| NumberofLikes | Integer | True |
The number of users who have liked this story. | |
| Likes | String | True |
Array of likes for users who have liked this story. | |
| StickerName | String | False |
The name of the sticker in this story. null if there is no sticker. The allowed values are 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. | |
| Type | String | True |
Story type (comment or system) | |
| Previews | String | True |
A collection of previews to be displayed in the story. This property only exists for comment stories. | |
| OldName | String | True |
OldName | |
| NewName | String | True |
NewName | |
| OldDatesStartOn | Date | True |
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. | |
| OldDatesDueAt | Datetime | True |
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. | |
| OldDatesDueOn | Date | True |
The localized day on which this goal is due. This takes a date with format YYYY-MM-DD. | |
| NewDatesStartOn | Date | True |
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. | |
| NewDatesDueAt | Datetime | True |
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. | |
| NewDatesDueOn | Date | True |
The localized day on which this goal is due. This takes a date with format YYYY-MM-DD. | |
| OldResourceSubtype | String | True |
OldResourceSubtype | |
| NewResourceSubtype | String | True |
NewResourceSubtype | |
| StoryId | String | True |
Globally unique identifier of the resource, as a string. | |
| StoryResourceType | String | True |
The base type of this resource. | |
| StoryCreatedAt | Datetime | True |
The time at which this resource was created. | |
| StoryCreatedById | String | True |
Globally unique identifier of the resource, as a string. | |
| StoryCreatedByResourceType | String | True |
The base type of this resource. | |
| StoryCreatedByName | String | True |
Read-only except when same user as requester. The user�s name. | |
| StoryResourceSubtype | String | True |
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. | |
| StoryText | String | True |
Human-readable text for the story or comment. This will not include the name of the creator. 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. | |
| AssigneeId | String | True |
Globally unique identifier of the resource, as a string. | |
| AssigneeResourceType | String | True |
The base type of this resource. | |
| AssigneeName | String | True |
Read-only except when same user as requester. The user�s name. | |
| FollowerId | String | True |
Globally unique identifier of the resource, as a string. | |
| FollowerResourceType | String | True |
The base type of this resource. | |
| FollowerName | String | True |
Read-only except when same user as requester. The user�s name. | |
| OldSectionId | String | True |
Globally unique identifier of the resource, as a string. | |
| OldSectionResourceType | String | True |
The base type of this resource. | |
| OldSectionName | String | True |
Read-only except when same user as requester. The user�s name. | |
| NewSectionId | String | True |
Globally unique identifier of the resource, as a string. | |
| NewSectionResourceType | String | True |
The base type of this resource. | |
| NewSectionName | String | True |
Read-only except when same user as requester. The user�s name. | |
| StoryTaskId | String | True |
Globally unique identifier of the resource, as a string. | |
| StoryTaskResourceType | String | True |
The base type of this resource. | |
| StoryTaskName | String | True |
The name of the task. | |
| TaskResourceSubtype | String | True |
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. | |
| TaskCreatedById | String | True |
Globally unique identifier of the resource. | |
| TaskCreatedByResourceType | String | True |
The type of resource. | |
| ProjectId | String | True |
Globally unique identifier of the resource, as a string. | |
| ProjectResourceType | String | True |
The base type of this resource. | |
| ProjectName | String | True |
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. | |
| TagId | String | True |
Globally unique identifier of the resource, as a string. | |
| TagResourceType | String | True |
The base type of this resource. | |
| TagName | String | True |
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. | |
| CustomField | String | True |
CustomField | |
| OldTextValue | String | True |
OldTextValue | |
| NewTextValue | String | True |
NewTextValue | |
| OldNumberValue | Integer | True |
OldNumberValue | |
| NewNumberValue | Integer | True |
NewNumberValue | |
| OldEnumValue | String | True |
OldEnumValue | |
| NewEnumValue | String | True |
NewEnumValue | |
| OldDateValue | String | True |
OldDateValue | |
| NewDateValue | String | True |
NewDateValue | |
| OldPeopleValue | String | True |
OldPeopleValue | |
| NewPeopleValue | String | True |
NewPeopleValue | |
| OldMultiEnumValues | String | True |
OldMultiEnumValues | |
| NewMultiEnumValues | String | True |
NewMultiEnumValues | |
| NewApprovalStatus | String | True |
The new value of approval status. | |
| OldApprovalStatus | String | True |
The old value of approval status. | |
| DuplicateOf | String | True |
DuplicateOf |
To Create, update, delete, and query from SubTasks table.
The Sync App will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed on server side and it is a required filter:
SELECT * FROM SubTasks WHERE ParentTaskId = '1127092449876457'
A simple SELECT query will only return the first level of subtasks.
SELECT * FROM SubTasks
There may be up to five levels of subtasks below a task. (Note, Asana does not recommend using sub-subtasks).
If additional levels of subtasks are needed, a subquery can be used:
SELECT * FROM SubTasks WHERE ParentTaskId IN (SELECT Id FROM SubTasks)
When executing a query without a ParentTaskId filter, due to the Asana API design, subtasks are only retrieved on a per task basis. The Sync App will first query the
workspace to retrieve a list of projects. A separate request will then be made for each project to retrieve all the applicable tasks. Another request will be made for
each task to retrieve any subtasks associated with the task. In theory, this is similar to executing the following query:
SELECT * FROM SubTasks WHERE ParentTaskId IN (SELECT Id FROM Tasks WHERE ProjectId IN (SELECT Id FROM Projects))Due to the number of required requests, performance may be impacted.
ParentTaskId is a mandatory column for inserting into Projects table. For example:
INSERT INTO SubTasks (ParentTaskId, Name, Assignee, AssigneeStatus, startOn, DueOn, Completed, ProjectId, Notes, ApprovalStatus, Followers) VALUES ('1167713816822372', 'subtask1', '1167715005778471', 'later', '2020-03-25', '2020-04-01', false, 1167713816822364, 'SubTask Notes', 'changes_requested', '1167715005778471')
Inserting multiple Followers into SubTasks table. For example:
INSERT INTO SubTasks (ParentTaskId, Followers) VALUES ('1167713816822372', '1206414724399714,1207035318501516' )
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the Subtask. | |
| ParentTaskId | String | True |
Globally unique ID of the task. | |
| Name | String | False |
Name of the Subtask. | |
| Assignee | String | False |
Users.Id |
User to which this subtask is assigned. |
| AssigneeStatus | String | False |
Scheduling status of this subtask for the user it is assigned to. The allowed values are today, upcoming, later, new, inbox. | |
| CreatedAt | Datetime | True |
The time at which this subtask was created. | |
| ModifiedAt | Datetime | True |
The time at which this subtask was last modified. | |
| startOn | Date | False |
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. | |
| DueAt | Datetime | False |
Date and time on which this subtask is due, or null if the subtask has no due time. | |
| DueOn | Date | False |
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. | |
| Completed | Boolean | False |
True if the subtask is currently marked complete, false if not. | |
| CompletedAt | Datetime | True |
The time at which this subtask was completed, or null if the subtask is incomplete. | |
| completed_by | String | True |
Users.Id |
The user who completed this task. |
| ProjectId | String | False |
Projects.Id |
Globally unique ID of the Project. |
| WorkspaceId | String | False |
Workspaces.Id |
Globally unique ID of the Workspace. |
| Notes | String | False |
More detailed, free-form textual information associated with the subtask. | |
| ApprovalStatus | String | False |
Reflects the approval status of this task. The allowed values are pending, approved, rejected, changes_requested. | |
| ResourceSubType | String | False |
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 allowed values are default_task, milestone, section, approval. | |
| HtmlNotes | String | False |
The notes of the text with formatting as HTML. | |
| Dependencies | String | True |
Array of resources referencing tasks that this task depends on. | |
| Memberships | String | True |
Array of projects this task is associated with and the section it is in. | |
| Dependents | String | True |
Array of resources referencing tasks that depend on this task. | |
| Liked | Boolean | False |
True if the task is liked by the authorized user, false if not. | |
| NumberofLikes | Integer | True |
The number of users who have liked this Task. | |
| LikedBy | String | True |
Array of likes for users who have liked this task. | |
| ResourceType | String | True |
The base type of this resource. | |
| IsRenderedAsSeparator | Boolean | True |
In some contexts tasks can be rendered as a visual separator. | |
| Followers | String | False |
Array of users following this task. | |
| Tags | String | False |
Array of tags associated with this task. | |
| CreatedById | String | True |
Globally unique identifier of the resource. | |
| CreatedByResourceType | String | True |
The type of resource. | |
| NumSubTasks | Integer | True |
NumSubTasks. | |
| StartAt | Datetime | True |
StartAt. | |
| ActualTimeMinutes | Integer | True |
ActualTimeMinutes. | |
| AssigneeSection | String | True |
AssigneeSection. |
To Create, Update and Query from Tags table. A tag is a label that can be attached to any task in Asana. It exists in a single workspace.
The Sync App will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM Tags WHERE Id = '1129517083601713' SELECT * FROM Tags WHERE WorkspaceId = '1126938837961830' SELECT * FROM Tags WHERE TaskId = '1128092964672854'
Workspaceid is a mandatory column for inserting into Tags table. For example:
INSERT INTO Tags (Name, Color, WorkspaceId, Notes) VALUES ('TestTag', 'dark-blue', '1126938837961830', 'sample notes')
Following is an example of how to update a Tags table:
UPDATE Tags SET Name = 'IT-1' WHERE Id = '1158271967831255'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the tag. | |
| Name | String | True |
Name of the tag. | |
| CreatedAt | Datetime | True |
The time at which this tag was created. | |
| Color | String | True |
Color of the tag. The allowed values are 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. | |
| Notes | String | False |
Notes of the tag. | |
| Followers | String | False |
Followers for the tag. | |
| WorkspaceId | String | True |
Workspaces.Id |
The workspace or organization this tag is associated with. |
| ResourceType | String | True |
The base type of this resource. | |
| TaskId | String | True |
Tasks.Id |
The task this tag is mapped with. |
To Create, Update, Delete and Query from Tasks table.
The Sync App will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM Tasks WHERE Id = '1127092449876457' SELECT * FROM Tasks WHERE ProjectId = '1128092964672848' SELECT * FROM Tasks WHERE Assignee = '1126938691750986' AND WorkspaceId = '1126938837961830' SELECT * FROM tasks WHERE TagId = '1129517083601713' SELECT * FROM tasks WHERE SectionId = '1127092449876457' SELECT * FROM tasks WHERE UserTaskListId = '1126938837961837' SELECT * FROM Tasks WHERE ProjectId = '1200222223676674' AND ModifiedAt > '2024-10-09 02:43:21.933' SELECT * FROM Tasks WHERE ProjectId = '1200222223676674' AND CompletedAt > '2024-10-31 17:10:28.268'
When executing a query without one of the above filters, due to the Asana API design, tasks must be retrieved per project. The Sync App will first query the
workspace to retrieve a list of projects. A separate request will then be made for each project to retrieve all the applicable tasks. In theory, this is similar
to executing the following query:
SELECT * FROM Tasks WHERE ProjectId IN (SELECT Id FROM Projects)Note : ModifiedAt and CompletedAt filters could be passed without ProjectId also. For example:
SELECT * FROM Tasks WHERE ModifiedAt > '2024-10-09 02:43:21.933' SELECT * FROM Tasks WHERE CompletedAt > '2024-10-31 17:10:28.268'Due to the number of required requests, performance may be impacted. Note, tasks may also be orphaned and not belong to a project. The Sync App will not be able to retrieve orphaned tasks.
ProjectId is a mandatory column for inserting into Tasks table. For example:
INSERT INTO Tasks (Name, Assignee, AssigneeStatus, startOn, DueOn, Completed, ProjectId, Notes, ApprovalStatus, Followers) VALUES ('Task1', '1167715005778471', 'later', '2020-03-25', '2020-04-01', false, 1167713816822364, 'TaskNotes', 'changes_requested', '1167715005778471')
Following is an example of how to update a Tasks table:
UPDATE Tasks SET Browser = 'ie' WHERE Id = '1167713816822371'
Following is an example of how to delete from Tasks table:
DELETE FROM Tasks WHERE Id = '1167713816822371'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the task. | |
| Name | String | False |
Name of the task. | |
| Assignee | String | False |
Users.Id |
User to which this task is assigned. |
| AssigneeStatus | String | False |
Scheduling status of this task for the user it is assigned to. The allowed values are today, upcoming, later, new, inbox. | |
| CreatedAt | Datetime | True |
The time at which this task was created. | |
| ModifiedAt | Datetime | True |
The time at which this task was last modified. | |
| startOn | Date | False |
Date and time on which this task is due, or null if the task has no due time. | |
| DueAt | Datetime | False |
Date and time on which this task is due, or null if the task has no due time. | |
| DueOn | Date | False |
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. | |
| Completed | Boolean | False |
True if the task is currently marked complete, false if not. | |
| CompletedAt | Datetime | True |
The time at which this task was completed, or null if the task is incomplete. | |
| CompletedBy | String | True |
Users.Id |
The user who completed this task. |
| ProjectId | String | False |
Projects.Id |
Projectid of this task is associated with. |
| Projects | String | False |
Projects of this task is associated with. | |
| WorkspaceId | String | False |
Workspaces.Id |
Globally unique ID of the Workspace. |
| Notes | String | False |
More detailed, free-form textual information associated with the task. | |
| NumberofSubTasks | Integer | True |
The number of subtasks on this task. | |
| ApprovalStatus | String | False |
Reflects the approval status of this task. The allowed values are pending, approved, rejected, changes_requested. | |
| ResourceSubType | String | False |
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 allowed values are default_task, milestone, section, approval. | |
| HtmlNotes | String | False |
The notes of the text with formatting as HTML. | |
| Memberships | String | True |
Array of projects this task is associated with and the section it is in. | |
| Dependencies | String | True |
Array of resources referencing tasks that this task depends on. | |
| Dependents | String | True |
Array of resources referencing tasks that depend on this task. | |
| Liked | Boolean | True |
True if the task is liked by the authorized user, false if not. | |
| NumberofLikes | Integer | True |
The number of users who have liked this Task. | |
| LikedBy | String | True |
Array of likes for users who have liked this task. | |
| ResourceType | String | True |
The base type of this resource. | |
| IsRenderedAsSeparator | Boolean | True |
In some contexts tasks can be rendered as a visual separator. | |
| Followers | String | False |
Array of users following this task. | |
| Tags | String | False |
Array of tags associated with this task. | |
| ActualTimeMinutes | Double | True |
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. Note: The time tracking feature is only available on the Asana Advanced or a higher subscription. | |
| Parent | String | True |
The parent of this task, or null if this is not a subtask. | |
| ItemURL | String | True |
A URL that points directly to the object within Asana. | |
| External | String | False |
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. | |
| AssigneeResourceType | String | True |
The base type of the Assignee resource. | |
| AssigneeName | String | True |
The Assignee user's name. | |
| AssigneeSection | String | False |
The assignee section is a subdivision of a project that groups tasks together in the assignee's 'My Tasks' list. 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. | |
| AssigneeSectionResourceType | String | True |
The base type of the AssigneeSection resource. | |
| AssigneeSectionName | String | True |
The name of the The name of the section. | |
| StartAt | Datetime | False |
Date and time on which work begins for the task, or null if the task has no start time. It should not be used together with startOn. | |
| CompletedByResourceType | String | True |
The base type of the CompletedBy resource. | |
| CompletedByName | String | True |
The CompletedBy user's name. | |
| WorkspaceResourceType | String | True |
The base type of the Workspace resource. | |
| WorkspaceName | String | True |
The name of the workspace. | |
| CreatedById | String | True |
Globally unique identifier of the resource. | |
| CreatedByResourceType | String | True |
The type of resource. | |
| SectionId | String | True |
Sections.Id |
PseudoColumn: Globally unique ID of the section. |
| UserTaskListId | String | True |
WorkspaceMembership.UserTaskListId |
PseudoColumn: A user task list represents the tasks assigned to a particular user. |
| TagId | String | True |
Tags.Id |
PseudoColumn: Globally unique ID of the tag. |
To Delete and Query the task templates.
The Sync App uses the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM TaskTemplates WHERE Id = '1127092449876457' SELECT * FROM TaskTemplates WHERE ProjectId = '1208149945266501'
The following is an example of how to delete from the TaskTemplates table:
DELETE FROM TaskTemplates WHERE Id = '1234'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the user. | |
| ResourceType | String | True |
The base type of this resource. | |
| Name | String | True |
Name of the task template. | |
| ProjectId | String | True |
Projects.Id |
Globally unique identifier of the resource, as a string. |
| ProjectName | String | True |
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. | |
| TemplateName | String | True |
Globally unique identifier of the resource, as a string. | |
| TemplateTaskResourceSubtype | String | True |
The subtype of the task that will be created from this template. | |
| TemplateDescription | String | True |
Description of the task that will be created from this template. | |
| TemplateHTMLDescription | String | True |
HTML description of the task that will be created from this template. | |
| TemplateMemberships | String | True |
Array of projects that the task created from this template will be added to. | |
| TemplateRelativeStartOn | Integer | True |
The number of days after the task has been instantiated on which that the task will start. | |
| TemplateRelativeDueOn | Integer | True |
The number of days after the task has been instantiated on which that the task will be due. | |
| TemplateDueTime | String | True |
The time of day that the task will be due. | |
| TemplateDependencies | String | True |
Array of task templates that the task created from this template will depend on. | |
| TemplateDependents | String | True |
Array of task templates that will depend on the task created from this template. | |
| TemplateFollowers | String | True |
Array of users that will be added as followers to the task created from this template. | |
| TemplateAttachments | String | True |
Array of attachments that will be added to the task created from this template. | |
| TemplateSubtasks | String | True |
Array of subtasks that will be added to the task created from this template. | |
| CreatedById | String | True |
Globally unique identifier of the resource, as a string. | |
| CreatedByName | String | True |
Read-only except when same user as requester. The user�s name. | |
| CreatedAt | Datetime | True |
The time at which this task template was created. |
To represents a users connection to a team.
The Sync App will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM TeamMembership WHERE UserId = '1126938691750986' AND WorkspaceId = '1126938837961830' SELECT * FROM TeamMembership WHERE TeamId = '1126938837961832' SELECT * FROM TeamMembership WHERE Id = '1126938837961832'
UserId and TeamId is a mandatory column for inserting into TeamMembership table. For example:
INSERT INTO TeamMembership (UserId, TeamId) VALUES ('1161963899354167', '1126938837961832')
Following is an example of how to delete from TeamMembership table:
DELETE FROM TeamMembership WHERE UserId = '1161963899354167' AND TeamId = '1126938837961832'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique identifier of the resource, as a string. | |
| userId [KEY] | String | True |
Users.Id |
Globally unique ID of the user. |
| userName | String | True |
The users name. | |
| TeamId [KEY] | String | True |
Teams.Id |
Globally unique ID of the team. |
| TeamName | String | True |
The name of the team. | |
| IsGuest | Boolean | True |
Describes if the user is a guest in the team. | |
| ResourceType | String | True |
The base type of this resource. | |
| IsLimitedAccess | Boolean | True |
Describes if the user has limited access to the team. | |
| IsAdmin | Boolean | True |
Describes if the user is a team admin. | |
| WorkspaceId | String | True |
Workspaces.Id |
Globally unique ID of the workspace. |
A team is used to group related projects and people together within an organization. Each project in an organization is associated with a team.
The Sync App will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM Teams WHERE Id = '1126938837961832' SELECT * FROM Teams WHERE WorkspaceId = '1126938837961830' SELECT * FROM Teams WHERE UserId = '1126938691750986' AND workspaceid = '1126938837961830'
INSERT INTO Teams (Name, Description, HTMLDescrption, WorkspaceId) VALUES ('Salessssk', 'sales developers should be members of this team.', '<body> <em>All</em> developers should be members of this team.</body>', '1126938837961830')
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the team. | |
| Name | String | False |
The name of the team. | |
| Description | String | False |
The description of the team. | |
| WorkspaceId | String | True |
Workspaces.Id |
The workspace or organization this team is associated with. |
| HTMLDescrption | String | False |
The description of the team with formatting as HTML. | |
| ResourceType | String | True |
The resource type of this resource. | |
| ItemURL | String | True |
A url that points directly to the object within Asana. | |
| Visibility | String | False |
The visibility of the team to users in the same organization. The allowed values are secret, request_to_join, public. | |
| TeamContentManagementAccessLevel | String | False |
Controls who can create and share content with the team. The allowed values are no_restriction, only_team_admins. | |
| EditTeamNameOrDescriptionAccessLevel | String | True |
Controls who can edit team name and description. The allowed values are all_team_members, only_team_admins. | |
| EditTeamVisibilityOrTrashTeamAccessLevel | String | True |
Controls who can edit team visibility and trash teams. The allowed values are all_team_members, only_team_admins. | |
| MemberInviteManagementAccessLevel | String | True |
Controls who can accept or deny member invites for a given team. The allowed values are all_team_members, only_team_admins. | |
| GuestInviteManagementAccessLevel | String | True |
Controls who can accept or deny guest invites for a given team. The allowed values are all_team_members, only_team_admins. | |
| JoinRequestManagementAccessLevel | String | True |
Controls who can accept or deny join team requests for a Membership by Request team. The allowed values are all_team_members, only_team_admins. | |
| TeamMemberRemovalAccessLevel | String | True |
Controls who can remove team members. The allowed values are all_team_members, only_team_admins. | |
| OrganizationResourceType | String | True |
The base type of this resource. | |
| OrganizationName | String | True |
The name of the workspace. | |
| UserId | String | True |
Users.Id |
Globally unique ID of the user. |
Returns time tracking entries for a given task.
The Sync App will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM TimeTrackingEntries WHERE Id = '1204862911885011' SELECT * FROM TimeTrackingEntries WHERE TaskId = '1203479447771600'
When executing a query without one of the above filters, due to the Asana API design, time tracking entries must be retrieved per task. The Sync App will first query the
workspace to retrieve a list of projects. A separate request will then be made for each project to retrieve all the applicable tasks. Then requests to get time tracking entries on each task will be made. In theory, this is similar
to executing the following query:
SELECT * FROM TimeTrackingEntries WHERE TaskId IN (SELECT Id FROM Tasks)
TaskId is a mandatory column for inserting into TimeTrackingEntries table. For example:
INSERT INTO TimeTrackingEntries (TaskId, DurationMinutes, EnteredOn) VALUES ('1203125557018947', 3600, '2024-01-01')
Following is an example of how to update a TimeTrackingEntries table:
UPDATE TimeTrackingEntries SET DurationMinutes = 4000, EnteredOn = '2023-01-01' WHERE Id = '1208387811113769'
Following is an example of how to delete from TimeTrackingEntries table:
DELETE FROM TimeTrackingEntries WHERE Id = '1208387811113769'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the team. | |
| ResourceType | String | True |
The base type of this resource. | |
| CreatedBy | String | True |
A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks. | |
| CreatedByResourceType | String | True |
The base type of the CreatedBy user resource. | |
| CreatedByName | String | True |
The user's name. | |
| DurationMinutes | Integer | False |
Time in minutes tracked by the entry. | |
| EnteredOn | Date | False |
The day that this entry is logged on. | |
| CreatedAt | Datetime | True |
The time at which this resource was created. | |
| TaskId | String | False |
The associated Task's object Id. The task is the basic object around which many operations in Asana are centered. | |
| TaskResourceType | String | True |
The base type of the Task resource. | |
| TaskName | String | True |
The name of the task. | |
| TaskResourceSubtype | String | True |
The subtype of the Task resource. |
To Create, Delete and Query memberships in the Workspace.
The Sync App will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkspaceMembership WHERE WorkspaceId = '1126938837961830' SELECT * FROM WorkspaceMembership WHERE UserId = '1126938691750986' SELECT * FROM WorkspaceMembership WHERE Id = '1126938837961834'
UserId and WorkspaceId is a mandatory column for inserting into WorkspaceMembership table. For example:
INSERT INTO WorkspaceMembership (UserId, WorkspaceId) VALUES ('1161963899354167', '1126938837961830')
Following is an example of how to delete from WorkspaceMembership table:
DELETE FROM WorkspaceMembership WHERE UserId = '1161963899354167' AND WorkspaceId = '1126938837961830'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the membership. | |
| userId [KEY] | String | True |
Users.Id |
Globally unique ID of the user. |
| userName | String | True |
The user`s name. | |
| WorkspaceId [KEY] | String | True |
Workspaces.Id |
Globally unique ID of the workspace. |
| WorkspaceName | String | True |
The Workspace name. | |
| IsActive | Boolean | True |
Reflects if this user still a member of the workspace. | |
| IsAdmin | Boolean | True |
Reflects if this user is an admin of the workspace. | |
| IsGuest | Boolean | True |
Reflects if this user is a guest of the workspace. | |
| UserTaskListId | String | True |
UserTaskList.Id |
A user task list represents the tasks assigned to a particular user. |
| ResourceType | String | True |
The base type of this resource. | |
| VacationStartDate | String | True |
The day on which the user's vacation in this workspace starts. | |
| VacationEndDate | String | True |
The day on which the user's vacation in this workspace ends. | |
| CreatedAt | Datetime | True |
The time at which this resource was created. |
To Update and Query from Workspaces table. A workspace is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace.
The Sync App will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM Workspaces WHERE Id = '1126938837961835' SELECT * FROM Workspaces WHERE UserId = '1126938691750986'
Following is an example of how to update a Workspaces table:
UPDATE Workspaces SET Name = 'IT-Eng' WHERE Id = '1126938837961835'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the workspace. | |
| Name | String | False |
The name of the workspace. | |
| ResourceType | String | True |
The resource type of this resource. | |
| IsOrganization | Boolean | True |
Whether the workspace is an organization. | |
| EmailDomains | String | True |
Whether the workspace is an organization. | |
| ItemURL | String | True |
A url that points directly to the object within Asana. | |
| UserId | String | True |
Users.Id |
Globally unique ID of the user. |
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| CustomFields | To view the Custom Fields in the project or workspace. |
| Events | To view the events in projects and tasks. |
| ProjectFollowers | To view the Project follower details. |
| ProjectTemplates | TO get ProjectTemplates in the Team or workspace. |
| TaskDependencies | To query all of the dependencies of a task. |
| TaskDependents | To query all of the dependents of a task. |
| TaskStatuses | Get task count of a project. |
| TimePeriods | To query time period records or full record for a single time period. |
| Users | To view the users details. |
| UserTaskList | Generated schema file. |
To view the Custom Fields in the project or workspace.
The Sync App uses the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side in the Sync App.
For example, the following query is processed server side:
SELECT * FROM CustomFields WHERE ProjectId = '1126938691750986'
| Name | Type | References | Description |
| Id | String | Globally unique identifier of the resource. | |
| Name | String | The name of the custom field. | |
| Description | String | The description of the custom field. | |
| Type | String | The type of the custom field. It must be one of the given values. | |
| ProjectId | String |
Projects.Id | Globally unique Id of the project. |
| ProjectName | String | Name of the project. | |
| IsImportant | Boolean | Name of the project. | |
| Format | String | The format of the custom field. | |
| TextValue | String | The value of a text custom field. | |
| NumberValue | Double | The value of a number custom field. | |
| Precision | Integer | Only relevant for custom fields of type 'Number'. This field specifies the number of digits after the decimal to round to. | |
| CurrencyCode | String | The currency code for this custom field. This will be null if the format is not currency. | |
| EnumOptions | String | Array of projects this task is associated with and the section it is in. | |
| CreatedBy | String | Globally unique user identifier. | |
| CreatedByName | String | The user's name. | |
| IsGlobaltoWorkspace | Boolean | A boolean flag that specifies whether this custom field is available to every container in the workspace. | |
| HasNotificationsEnabled | Boolean | A boolean flag that specifies whether a follower of a task with this field should receive inbox notifications about changes in this field. | |
| WorkspaceId | String |
Workspaces.Id | Globally unique ID of the workspace. |
To view the events in projects and tasks.
The Sync App will use the Asana API to process WHERE clause conditions built with the following column and operator. The resource id will be either Project or Task Id. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM Events WHERE ResourceId = '1128092964672854'
| Name | Type | References | Description |
| ResourceId [KEY] | String | The resource GID for the events were requested for. | |
| ResourceType | String | The resource type for the events were requested for. | |
| ResourceSubType | String | The resource sub type for the events were requested for. | |
| ResourceName | String | The resource name for the events were requested for. | |
| Parent | String | For added/removed events, the parent that resource was added to or removed from. null for other event types. | |
| CreatedAt | Datetime | The timestamp when the event occurred. | |
| UserId | String | The event may be triggered by a different user GID than the subscriber. | |
| UserFullname | String | The event may be triggered by a different user name than the subscriber. | |
| Action | String | The type of action taken that triggered the event. | |
| ChangeField | String | The name of the field that has changed in the resource. | |
| ChangeAction | String | 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. | |
| ChangeNewValue | String | 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. | |
| ChangeAddedValue | String | 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. | |
| ChangeRemovedValue | String | 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 webhook. |
To view the Project follower details.
| Name | Type | References | Description |
| ProjectId | String |
Projects.Id | Globally unique ID of the Project. |
| UserId | String |
Users.Id | Globally unique ID of the user. |
| UserName | String | The user`s name. | |
| ResourceType | String | The resource type of this resource. | |
| WorkspaceId | String |
Workspaces.Id | The workspace this Project is associated with. |
TO get ProjectTemplates in the Team or workspace.
| Name | Type | References | Description |
| Id [KEY] | String | Globally unique identifier of the resource, as a string. | |
| Color | String | Color of the project template. | |
| Description | String | Free-form textual information associated with the project template. | |
| Html_description | String | The description of the project template with formatting as HTML. | |
| Name | String | Name of the project template. | |
| OwnerId | String |
Users.Id | A user object. Globally unique identifier of the resource, as a string. |
| OwnerName | String | A user object. The base type of this resource. | |
| OwnerResourceType | String | A user object. Read-only except when same user as requester. The name of the User. | |
| IsPublic | Boolean | True if the project template is public to its team. | |
| RequestedDates | String | Array of date variables in this project template. Calendar dates must be provided for these variables when instantiating a project. | |
| ResourceType | String | The base type of this resource. | |
| TeamId | String |
Teams.Id | A team is used to group related projects and people together within an organization. Globally unique identifier of the resource, as a string. |
| TeamName | String | A team is used to group related projects and people together within an organization. The name of the team. | |
| TeamResourceType | String | A team is used to group related projects and people together within an organization. The base type of this resource. | |
| RequestedRoles | String | 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. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| WorkspaceId | String | The workspace Id to filter results on. |
To query all of the dependencies of a task.
The Sync App uses the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM TaskDependencies WHERE TaskId = '1208618397035168'
| Name | Type | References | Description |
| Id [KEY] | String | Globally unique ID of the task. | |
| Name | String | Name of the task. | |
| Assignee | String |
Users.Id | User to which this task is assigned. |
| AssigneeStatus | String | Scheduling status of this task for the user it is assigned to.
The allowed values are today, upcoming, later, new, inbox. | |
| CreatedAt | Datetime | The time at which this task was created. | |
| ModifiedAt | Datetime | The time at which this task was last modified. | |
| startOn | Date | Date and time on which this task is due, or null if the task has no due time. | |
| DueAt | Datetime | Date and time on which this task is due, or null if the task has no due time. | |
| DueOn | Date | 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. | |
| Completed | Boolean | True if the task is currently marked complete, false if not. | |
| CompletedAt | Datetime | The time at which this task was completed, or null if the task is incomplete. | |
| CompletedBy | String |
Users.Id | The user who completed this task. |
| Projects | String | Projects of this task is associated with. | |
| WorkspaceId | String |
Workspaces.Id | Globally unique ID of the Workspace. |
| Notes | String | More detailed, free-form textual information associated with the task. | |
| NumberofSubTasks | Integer | The number of subtasks on this task. | |
| ApprovalStatus | String | Reflects the approval status of this task.
The allowed values are pending, approved, rejected, changes_requested. | |
| ResourceSubType | 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.
The allowed values are default_task, milestone, section, approval. | |
| HtmlNotes | String | The notes of the text with formatting as HTML. | |
| Memberships | String | Array of projects this task is associated with and the section it is in. | |
| Dependencies | String | Array of resources referencing tasks that this task depends on. | |
| Dependents | String | Array of resources referencing tasks that depend on this task. | |
| Liked | Boolean | True if the task is liked by the authorized user, false if not. | |
| NumberofLikes | Integer | The number of users who have liked this Task. | |
| LikedBy | String | Array of likes for users who have liked this task. | |
| ResourceType | String | The base type of this resource. | |
| IsRenderedAsSeparator | Boolean | In some contexts tasks can be rendered as a visual separator. | |
| Followers | String | Array of users following this task. | |
| Tags | String | Array of tags associated with this task. | |
| ActualTimeMinutes | Double | 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. Note: The time tracking feature is only available on the Asana Advanced or a higher subscription. | |
| Parent | String | The parent of this task, or null if this is not a subtask. | |
| ItemURL | String | A URL that points directly to the object within Asana. | |
| External | String | 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. | |
| AssigneeResourceType | String | The base type of the Assignee resource. | |
| AssigneeName | String | The Assignee user's name. | |
| AssigneeSection | String | The assignee section is a subdivision of a project that groups tasks together in the assignee's 'My Tasks' list. 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. | |
| AssigneeSectionResourceType | String | The base type of the AssigneeSection resource. | |
| AssigneeSectionName | String | The name of the The name of the section. | |
| StartAt | Datetime | Date and time on which work begins for the task, or null if the task has no start time. It should not be used together with startOn. | |
| CompletedByResourceType | String | The base type of the CompletedBy resource. | |
| CompletedByName | String | The CompletedBy user's name. | |
| WorkspaceResourceType | String | The base type of the Workspace resource. | |
| WorkspaceName | String | The name of the workspace. | |
| CreatedById | String | Globally unique identifier of the resource. | |
| CreatedByResourceType | String | The type of resource. | |
| TaskId | String |
Tasks.Id | The task to operate on. |
To query all of the dependents of a task.
The Sync App uses the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM TaskDependents WHERE TaskId = '1208618397035168'
| Name | Type | References | Description |
| Id [KEY] | String | Globally unique ID of the task. | |
| Name | String | Name of the task. | |
| Assignee | String |
Users.Id | User to which this task is assigned. |
| AssigneeStatus | String | Scheduling status of this task for the user it is assigned to.
The allowed values are today, upcoming, later, new, inbox. | |
| CreatedAt | Datetime | The time at which this task was created. | |
| ModifiedAt | Datetime | The time at which this task was last modified. | |
| StartOn | Date | Date and time on which this task is due, or null if the task has no due time. | |
| DueAt | Datetime | Date and time on which this task is due, or null if the task has no due time. | |
| DueOn | Date | 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. | |
| Completed | Boolean | True if the task is currently marked complete, false if not. | |
| CompletedAt | Datetime | The time at which this task was completed, or null if the task is incomplete. | |
| CompletedBy | String |
Users.Id | The user who completed this task. |
| Projects | String | Projects of this task is associated with. | |
| WorkspaceId | String |
Workspaces.Id | Globally unique ID of the Workspace. |
| Notes | String | More detailed, free-form textual information associated with the task. | |
| NumberofSubTasks | Integer | The number of subtasks on this task. | |
| ApprovalStatus | String | Reflects the approval status of this task.
The allowed values are pending, approved, rejected, changes_requested. | |
| ResourceSubType | 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.
The allowed values are default_task, milestone, section, approval. | |
| HtmlNotes | String | The notes of the text with formatting as HTML. | |
| Memberships | String | Array of projects this task is associated with and the section it is in. | |
| Dependencies | String | Array of resources referencing tasks that this task depends on. | |
| Dependents | String | Array of resources referencing tasks that depend on this task. | |
| Liked | Boolean | True if the task is liked by the authorized user, false if not. | |
| NumberofLikes | Integer | The number of users who have liked this Task. | |
| LikedBy | String | Array of likes for users who have liked this task. | |
| ResourceType | String | The base type of this resource. | |
| IsRenderedAsSeparator | Boolean | In some contexts tasks can be rendered as a visual separator. | |
| Followers | String | Array of users following this task. | |
| Tags | String | Array of tags associated with this task. | |
| ActualTimeMinutes | Double | 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. Note: The time tracking feature is only available on the Asana Advanced or a higher subscription. | |
| Parent | String | The parent of this task, or null if this is not a subtask. | |
| ItemURL | String | A URL that points directly to the object within Asana. | |
| External | String | 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. | |
| AssigneeResourceType | String | The base type of the Assignee resource. | |
| AssigneeName | String | The Assignee user's name. | |
| AssigneeSection | String | The assignee section is a subdivision of a project that groups tasks together in the assignee's 'My Tasks' list. 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. | |
| AssigneeSectionResourceType | String | The base type of the AssigneeSection resource. | |
| AssigneeSectionName | String | The name of the The name of the section. | |
| StartAt | Datetime | Date and time on which work begins for the task, or null if the task has no start time. It should not be used together with startOn. | |
| CompletedByResourceType | String | The base type of the CompletedBy resource. | |
| CompletedByName | String | The CompletedBy user's name. | |
| WorkspaceResourceType | String | The base type of the Workspace resource. | |
| WorkspaceName | String | The name of the workspace. | |
| CreatedById | String | Globally unique identifier of the resource. | |
| CreatedByResourceType | String | The type of resource. | |
| TaskId | String |
Tasks.Id | The task to operate on. |
Get task count of a project.
The Sync App will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM TaskStatuses WHERE ProjectId = '1136437449978157'
| Name | Type | References | Description |
| ProjectId | String |
Projects.Id | Globally unique ID of the project. |
| NumberofTasks | Integer | The number of tasks in a project. | |
| CompletedTasks | Integer | The number of completed tasks in a project. | |
| IncompleteTasks | Integer | The number of incomplete tasks in a project. | |
| NumberofMilestones | Integer | The number of milestones in a project. | |
| CompletedMilestones | Integer | The number of completed milestones in a project. | |
| InCompleteMilestones | Integer | The number of incomplete milestones in a project. |
To query time period records or full record for a single time period.
The Sync App uses the Asana API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Sync App.
For example, the following queries are processed server-side:
SELECT * FROM TimePeriods where Id = '1200585294122707' SELECT * FROM TimePeriods where WorkspaceId = '1126938837961835'
| Name | Type | References | Description |
| Id [KEY] | String | Globally unique ID of the user. | |
| ResourceType | String | The base type of this resource. | |
| EndOn | String | The localized end date of the time period in YYYY-MM-DD format. | |
| StartOn | String | The localized start date of the time period in YYYY-MM-DD format. | |
| Period | String | The cadence and index of the time period. The value is one of: FY, H1, H2, Q1, Q2, Q3, or Q4. | |
| DisplayName | String | A string representing the cadence code and the fiscal year. | |
| ParentId | String | Globally unique ID of the user. | |
| ParentResourceType | String | The base type of this resource. | |
| ParentEndOn | String | The localized end date of the time period in YYYY-MM-DD format. | |
| ParentStartOn | String | The localized start date of the time period in YYYY-MM-DD format. | |
| ParentPeriod | String | The cadence and index of the time period. The value is one of: FY, H1, H2, Q1, Q2, Q3, or Q4. | |
| ParentDisplayName | String | A string representing the cadence code and the fiscal year. | |
| WorkspaceId | String |
Workspaces.Id | Globally unique ID of the workspace. |
To view the users details.
The Sync App will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM Users WHERE Id = '1126938691750986' SELECT * FROM Users WHERE WorkspaceId = '1126938837961835' SELECT * FROM Users WHERE TeamId = '1129514033997892'
| Name | Type | References | Description |
| Id [KEY] | String | Globally unique ID of the user. | |
| Name | String | The user`s name. | |
| String | The user`s email address. | ||
| ResourceType | String | The resource type of this resource. | |
| WorkspaceId | String |
Workspaces.Id | The User access in workspaces. |
| TeamId | String |
Teams.Id | Globally unique ID of the team. |
Generated schema file.
The Sync App will use the Asana API to process WHERE clause conditions built with the following column and operator. The [UserId and workspaceId] or Id is required to make a request and the rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM UserTaskList WHERE Id = '1126938837961837' SELECT * FROM UserTaskList WHERE UserId = '1126938691750986' AND workspaceId = '1126938837961830'
| Name | Type | References | Description |
| Id [KEY] | String |
WorkspaceMembership.UserTaskListId | Globally unique ID of the user task list. |
| Name | String | The name of the user task list. | |
| UserId | String |
Users.Id | The owner of the user task list. |
| workspaceId | String |
Workspaces.Id | The workspace in which the user task list is located. |
| ResourceType | String | The resource type of this resource. |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| AuthScheme | The type of authentication to use when connecting to Asana. |
| Property | Description |
| ProjectId | The globally unique identifier (gid) associated with your Asana Project. |
| WorkspaceId | The globally unique identifier (gid) associated with your Asana Workspace. |
| IncludeCustomFields | Custom fields may be added to the Tasks, SubTasks, and PortfolioItems tables. |
| Property | Description |
| OAuthClientId | Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. |
| OAuthClientSecret | Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Property | Description |
| MaxRows | Specifies the maximum rows returned for queries without aggregation or GROUP BY. |
| Other | Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| AuthScheme | The type of authentication to use when connecting to Asana. |
The type of authentication to use when connecting to Asana.
Current authentication methods supported for new apps:
This section provides a complete list of the Connection properties you can configure in the connection string for this provider.
| Property | Description |
| ProjectId | The globally unique identifier (gid) associated with your Asana Project. |
| WorkspaceId | The globally unique identifier (gid) associated with your Asana Workspace. |
| IncludeCustomFields | Custom fields may be added to the Tasks, SubTasks, and PortfolioItems tables. |
The globally unique identifier (gid) associated with your Asana Project.
Requests will return the data mapped under this project.
The globally unique identifier (gid) associated with your Asana Workspace.
Requests will return the projects mapped under this WorkspaceId.
Custom fields may be added to the Tasks, SubTasks, and PortfolioItems tables.
If set to TRUE, custom fields may be added to the Tasks, SubTasks, and PortfolioItems tables. The WorkspaceId should also be specified. Custom fields are related to a specific Workspace. If no WorkspaceId is specified, the first available WorkspaceId will be used.
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthClientId | Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. |
| OAuthClientSecret | Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server. |
Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.
Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
| Description | Example |
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\cert.cer |
| The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
| The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
The following table provides port number information for each of the supported protocols.
| Protocol | Default Port | Description |
| TUNNEL | 80 | The port where the Sync App opens a connection to Asana. Traffic flows back and forth via the proxy at this location. |
| SOCKS4 | 1080 | The port where the Sync App opens a connection to Asana. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted. |
| SOCKS5 | 1080 | The port where the Sync App sends data to Asana. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the TCP port to be used for a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Identifies the user ID of the account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the password of the user account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).
This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
The hostname or IP address of the proxy server that you want to route HTTP traffic through.
The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.
The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.
For other proxy types, see FirewallType.
Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
The authentication type can be one of the following:
For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
The username of a user account registered with the proxy server specified in the ProxyServer connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyUser |
| BASIC | The user name of a user registered with the proxy server. |
| DIGEST | The user name of a user registered with the proxy server. |
| NEGOTIATE | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NTLM | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NONE | Do not set the ProxyPassword connection property. |
The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.
The password associated with the user specified in the ProxyUser connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyPassword |
| BASIC | The password associated with the proxy server user specified in ProxyUser. |
| DIGEST | The password associated with the proxy server user specified in ProxyUser. |
| NEGOTIATE | The password associated with the Windows user account specified in ProxyUser. |
| NTLM | The password associated with the Windows user account specified in ProxyUser. |
| NONE | Do not set the ProxyPassword connection property. |
For SOCKS 5 authentication or tunneling, see FirewallType.
The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.
The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :
| AUTO | Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note that the Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.
For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.
The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.
For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is %APPDATA%\\CData\\Asana Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:
| Platform | %APPDATA% |
| Windows | The value of the APPDATA environment variable |
| Linux | ~/.config |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.
If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.
If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| MaxRows | Specifies the maximum rows returned for queries without aggregation or GROUP BY. |
| Other | Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file. |
Specifies the maximum rows returned for queries without aggregation or GROUP BY.
This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.
When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.
Note: It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.
Specify multiple properties in a semicolon-separated list.
| DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
| ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
This property allows you to define which pseudocolumns the Sync App exposes as table columns.
To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"
To include all pseudocolumns for all tables use: "*=*"
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.
The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.
Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view. For example:
{
"MyView": {
"query": "SELECT * FROM projects WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.
Refer to User Defined Views for more information.