Asana Connection Details
Introduction
Connector Version
This documentation is based on version 25.0.9368 of the connector.
Get Started
Asana Version Support
The connector leverages the Asana API to enable bidirectional access to Asana work management entities.
Establish a Connection
Connect to Asana
You can optionally set the following to refine the data returned from Asana.
- WorkspaceId: The globally unique identifier (gid) associated with your Asana Workspace to only return projects from the specified Workspace. To get your Workspace Id, navigate to
https://app.asana.com/api/1.0/workspaceswhile logged into Asana. This displays a JSON object containing your Workspace name and Id. - ProjectId: The globally unique identifier (gid) associated with your Asana Project to only return data mapped under the specified Project. Project Ids can be found in the URL of your project's
Overviewpage. This will be the numbers directly after/0/.
Authenticate to Asana
Asana uses the OAuth or OAuthPKCE authentication standard.
User Accounts (OAuth)
AuthScheme must be set to OAuth in all user account flows.
Desktop Applications
An embedded OAuth application is provided that simplifies OAuth desktop Authentication. Alternatively, you can create a custom OAuth application. See Creating a Custom OAuth App for information about creating custom applications and reasons for doing so.
Get and Refresh the OAuth Access Token
After setting the following, you are ready to connect:
- InitiateOAuth:
GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken. - OAuthClientId (custom applications only): The client ID assigned when you registered your app.
- OAuthClientSecret (custom applications only): The client secret assigned when you registered your app.
- CallbackURL (custom application only): The redirect URI defined when you registered your app. For example:
https://localhost:3333
When you connect, the connector opens Asana's OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:
- The connector obtains an access token from Asana and uses it to request data.
- The OAuth values are saved in the location specified in OAuthSettingsLocation, to be persisted across connections.
The connector refreshes the access token automatically when it expires.
OAuth PKCE
Set AuthScheme to OAuthPKCE.
Desktop Applications
An embedded OAuth application is provided that simplifies OAuth desktop Authentication. Alternatively, you can create a custom OAuth application. See Creating a Custom OAuth App for information about creating custom applications and reasons for doing so.
Get and Refresh the OAuth Access Token
After setting the following, you are ready to connect:
- InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
- OAuthClientId (custom applications only): Set this to the client ID assigned when you registered your app.
- OAuthClientSecret (custom applications only): Set this to the client secret assigned when you registered your app. Specifying this value is optional if a value was not generated during the OAuth custom application creation process.
- CallbackURL (custom application only): Set this to the redirect URI defined when you registered your app. For example:
http://localhost:3333
When you connect, the connector opens Asana's OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:
- The connector obtains an access token from Asana and uses it to request data.
- The OAuth values are saved in the location specified in OAuthSettingsLocation, to be persisted across connections.
The connector refreshes the access token automatically when it expires.
Service Accounts
To authenticate with a Server Account (Enterprise only), use a Personal Access Token by setting these connection properties:
- InitiateOAuth:
OFF. - OAuthAccessToken: Your access token value.
For more more information, see the Asana documentation for personal access tokens and service accounts.
OAuth Scopes and Endpoints
Required Scopes and Endpoint Domains for Asana
When integrating with Asana, your application needs specific permissions to interact with the API.
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 connector.
Understand Scopes
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.
Required Scopes for Asana
| Scope | Description |
|---|---|
default |
Asana does not provide the ability to limit read-only access. This is the default scope and the only scope available. |
Understand Endpoint Domains
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.
Required Endpoint Domains for Asana
| Domain | Always Required | Description |
|---|---|---|
| app.asana.com | TRUE | The domain of your Asana instance. |
Create a Custom OAuth App
To obtain an OAuthClientId, OAuthClientSecret, and CallbackURL, you first need to create an app linked to your Asana account.
To create an app linked to your Asana account:
- Log in to your Asana account.
- Navigate to
My profile Settings>Apps>Manage Developer Appsorhttps://app.asana.com/0/developer-console. - Under
My apps, selectNew app. Specify the app name, then selectCreate app. - Once your app created, set
Redirect URLtohttp://localhost:33333(or a different available port of your choice), then selectadd.
Once you are done with creating a new app, it will be displayed on your screen. From there, you can click View Client ID to reveal your newly created app's OAuthClientId and OAuthClientSecret.
Important Notes
Configuration Files and Their Paths
- All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.
Advanced Features
This section details a selection of advanced features of the Asana connector.
User Defined Views
The connector 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.
SSL Configuration
Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats. For further information, see the SSLServerCert property under "Connection String Options".
Proxy
To configure the connector using private agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.
Query Processing
The connector offloads as much of the SELECT statement processing as possible to Asana and then processes the rest of the query in memory (client-side).
For further information, see Query Processing.
Log
For an overview of configuration settings that can be used to refine logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.
User Defined Views
The Asana connector supports the use of user defined views: user-defined virtual tables whose contents are decided by a preconfigured query. User defined views are useful in situations where you cannot directly control the query being issued to the driver; for example, when using the driver from Jitterbit.
Use a user defined view to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.
There are two ways to create user defined views:
- Create a JSON-formatted configuration file defining the views you want.
- DDL statements.
Define Views Using a Configuration File
User defined views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.
This user defined view configuration file is formatted so that each root element defines the name of a view, and includes a child element, called query, which contains the custom 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)"
}
}
Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"
Define Views Using DDL Statements
The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.
Create a View
To create a new view using DDL statements, provide the view name and query as follows:
CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;
If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.
Alter a View
To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:
ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';
The view is then updated in the JSON configuration file.
Drop a View
To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.
DROP LOCAL VIEW [MyViewName]
This removes the view from the JSON configuration file. It can no longer be queried.
Schema for User Defined Views
In order to avoid a view's name clashing with an actual entity in the data model, user defined views are exposed in the UserViews schema by default. To change the name of the schema used for UserViews, reset the UserViewsSchemaName property.
Work with User Defined Views
For example, a SQL statement with a user defined view called UserViews.RCustomers only lists customers in Raleigh:
SELECT * FROM Customers WHERE City = 'Raleigh';
An example of a query to the driver:
SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';
Resulting in the effective query to the source:
SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';
That is a very simple example of a query to a user defined view that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.
SSL Configuration
Customize the SSL Configuration
By default, the connector 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.
Data Model
Overview
This section shows the available API objects and provides more information on executing SQL to Asana APIs.
Key Features
- The connector models Asana entities as relational views, allowing you to write SQL to query Asana data.
- Stored procedures allow you to execute operations to Asana, including retrieving the access token and keeping it refreshed in OAuth 2.0.
- Live connectivity to these objects means any changes to your Asana account are immediately reflected when using the connector.
- IncludeCustomFields connection property allows you to retrieve custom fields for Tasks view. Set this property to True, to enable this feature.
Views
Views describes the available views. Views are statically defined to model Projects, Users, Workspaces, and more.
Stored Procedures
Stored Procedures are function-like interfaces to Asana. Stored procedures allow you to execute operations to Asana, including downloading documents and moving envelopes.
Tables
The connector models the data in Asana as a list of tables in a relational database that can be queried using standard SQL statements.
Asana Connector Tables
| 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. |
Allocations
To Create, Update, Delete and Query the Allocations table.
Table Specific Information
Select
The connector 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 connector.
Idsupports the '=' comparison.Assigneesupports the '=' comparison. Note : Always include WorkspaceId when specifying Assignee, either in the query or the connection string.Parentsupports the '=' comparison.
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'
Insert
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)
Update
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'
Delete
The following is an example of how to delete from the Allocations table:
DELETE FROM Allocations WHERE ID = '1234'
Columns
| 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. |
Attachments
To Delete and Query from the Attachments in the tasks.
Table Specific Information
Select
The connector 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 connector.
Idsupports the '=' comparison.TaskIdsupports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM Attachments WHERE Id = '1134618934491707'
SELECT * FROM Attachments WHERE TaskId = '1128092964672854'
Delete
Following is an example of how to delete from Attachments table:
DELETE FROM Attachments WHERE ID = '1134618934491707'
Columns
| 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. |
GoalMembership
To Create, Delete and Query memberships in the Goal.
Table Specific Information
Select
The connector 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 connector.
Idsupports the '=' comparison.GoalIdsupports the '=' comparison.MemberIdsupports the '=' comparison.
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'
Insert
GoalId and MemberId is a mandatory column for inserting into GoalMembership table. For example:
INSERT INTO GoalMembership (GoalId, MemberId) VALUES ('1161963899354167', '1126938837961830')
Delete
Following is an example of how to delete from GoalMembership table:
DELETE FROM GoalMembership WHERE ID = '1161963899354167'
Columns
| 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. |
Goals
To Create, Update, Delete, and Query the Goals table.
Table Specific Information
Select
The connector 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 connector.
Idsupports the '=' comparison.IsWorkspaceLevelsupports the '=' comparison.TeamIdsupports the '=' comparison.TimeIdsupports the '=' comparison.WorkspaceIdsupports the '=' comparison.PortfolioIdsupports the '=' comparison.ProjectIdsupports the '=' comparison.
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'
SELECT * FROM Goals WHERE PortfolioId = '1205440033794767'
SELECT * FROM Goals WHERE ProjectId = '1203125557018928'
Insert
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' )
Update
Following is an example of how to update a Goals table:
UPDATE Goals SET DueOn ='2023-10-20' WHERE ID = '1128092864672888'
Delete
Following is an example of how to delete from Goals table:
DELETE FROM Goals WHERE ID = '1161963899354167'
Columns
| 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. |
Pseudo-Columns
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 |
|---|---|---|
PortfolioId |
String |
Globally unique identifier for supporting portfolio. |
ProjectId |
String |
Globally unique identifier for supporting project. |
PortfolioItems
To Create, delete, and Query Items in the Portfolio.
Table Specific Information
Select
The connector 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 connector.
PortfolioIdsupports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM PortfolioItems WHERE PortfolioId = '1173026173301164'
Insert
ProjectId and PortfolioId is a mandatory column for inserting into PortfolioItems table. For example:
INSERT INTO PortfolioItems (ProjectId, PortfolioId) VALUES ('1173023668354420', '1173026173301164')
Delete
Following is an example of how to delete from PortfolioItems table:
DELETE FROM PortfolioItems WHERE ProjectId = '1173023668354420' AND PortfolioId = '1173026173301164'
Columns
| 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. |
PortfolioMembership
To Create, Delete and Query memberships in the Portfolio.
Table Specific Information
Select
The connector 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 connector.
Idsupports the '=' comparison.WorkspaceIdsupports the '=' comparison.UserIdsupports the '=' comparison.PortfolioIdsupports the '=' comparison.
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'
Insert
PortfolioId and UserId is a mandatory column for inserting into PortfolioMembership table. For example:
INSERT INTO PortfolioMembership (PortfolioId, UserId) VALUES ('1172684730399265', '1172686741877880')
Delete
Following is an example of how to delete from PortfolioMembership table:
DELETE FROM PortfolioMembership WHERE PortfolioId = '1172684730399265' AND UserId = '1172686741877880'
Columns
| 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. |
AccessLevel |
String |
True | Whether the member has admin, editor, or viewer access to the portfolio. Portfolios do not support commenter access yet. |
Portfolios
To Create, update, delete, and query from Portfolios table.
Table Specific Information
Select
The connector 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 connector.
Idsupports the '=' comparison.WorkspaceIdsupports the '=' comparison.OwnerIdsupports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM Portfolios WHERE WorkspaceId = '1172686716695308' AND OwnerId = '1172686741877880'
SELECT * FROM Portfolios WHERE Id = '1172684730399265'
Insert
WorkspaceId is a mandatory column for inserting into Portfolios table. For example:
INSERT INTO Portfolios (Name, Color, WorkspaceId) VALUES ('Test', 'dark-pink', '1172686716695308'
Update
Following is an example of how to update a Portfolios table:
"UPDATE Portfolios SET Name = 'IT-Test' WHERE ID = '1173026173301164'
Delete
Following is an example of how to delete from Portfolios table:
DELETE FROM Portfolios WHERE ID = '1172684730399265'
Columns
| 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 | |
DefaultAccessLevel |
String |
True | The default access level when inviting new members to the portfolio | |
Archived |
Boolean |
False | True if the portfolio is archived, false if not. Archived portfolios do not show in the UI by default and may be treated differently for queries. |
ProjectMembership
To Create, Delete and Query memberships in the Project.
Table Specific Information
Select
The connector 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 connector.
Idsupports the '=' comparison.ProjectIdsupports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM ProjectMembership WHERE Id = '1127092449876445'
SELECT * FROM ProjectMembership WHERE ProjectId = '1127092449876444'
Insert
MemberId and ProjectId is a mandatory column for inserting into ProjectMembership table. For example:
INSERT INTO ProjectMembership (MemberId, ProjectId) VALUES ('1161963899354167', '1128092964672848')
Note : MemberId should be ID of a user for insert.
Delete
Following is an example of how to delete from ProjectMembership table:
DELETE FROM ProjectMembership WHERE MemberId = '1161963899354167' AND ProjectId = '1128092964672848'
Note : MemberId should be ID of a user for delete.
Columns
| 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. | |
MemberId [KEY] |
String |
False | The ID of user or team 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. |
Projects
To Create, Update, Delete and Query the Projects table.
Table Specific Information
Select
The connector 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 connector.
Idsupports the '=' comparison.workspaceIdsupports the '=' comparison.TaskIdsupports the '=' comparison.TeamIdsupports the '=' comparison.
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'
In case of UseTypeaheadSearch property set to true, only Name and WorkspaceId columns would be filterable server side with Name supporting '=, LIKE' comparison when LIKE used only in the following ways:
SELECT * FROM Projects WHERE Name = 'abc'
SELECT * FROM Projects WHERE Name LIKE 'abc'
SELECT * FROM Projects WHERE Name LIKE 'abc%'
SELECT * FROM Projects WHERE Name LIKE 'abc%' AND WorkspaceId = '1126938837961830'
Insert
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' )
Update
Following is an example of how to update a Projects table:
UPDATE Projects SET TeamId = '1129514033997890' WHERE ID = '1128092864672888'
Delete
Following is an example of how to delete from Projects table:
DELETE FROM Projects WHERE ID = '1128092864672888'
Columns
| 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 |
True | 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. | |
Members |
String |
True | Array of users who are members of this project. | |
PrivacySetting |
String |
False | The privacy setting of the project. The allowed values are public_to_workspace, private_to_team, private. | |
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. |
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.
Table Specific Information
Select
The connector 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 connector.
Idsupports the '=' comparison.ProjectIdsupports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM ProjectStatuses WHERE Id = '1127092449876445'
SELECT * FROM ProjectStatuses WHERE ProjectId = '1127092449876444'
Insert
ProjectId is a mandatory column for inserting into ProjectStatuses table. For example:
INSERT INTO projectstatuses (Color, Title, Text, ProjectId) VALUES ('red', 'Status1', 'StatusNotes', '1127092449876444')
Delete
Following is an example of how to delete from ProjectStatuses table:
DELETE FROM ProjectStatuses WHERE ID = '1127092449876445'
Columns
| 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. |
Sections
To Create, Update, Delete, and Query from Sections table. A section is a subdivision of a project that groups tasks together.
Table Specific Information
Select
The connector 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 connector.
Idsupports the '=' comparison.ProjectIdsupports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM Sections WHERE Id = '1127092449876457'
SELECT * FROM Sections WHERE ProjectId = '1128092964672848'
Insert
ProjectId is a mandatory column for inserting into Sections table. For example:
INSERT INTO Sections (Name, ProjectId) VALUES ('SectionName', '1128092964672848')
Update
Following is an example of how to update a Sections table:
UPDATE Sections SET Name = 'IT-Pending' WHERE ID = '1127092449876457'
Delete
Following is an example of how to delete from Sections table:
DELETE FROM Sections WHERE ID = '1127092449876457'
Columns
| 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. |
StatusUpdates
A status update is an update on the progress of a particular object, and is sent out to all followers when created.
Table Specific Information
Select
The connector 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 connector.
Idsupports the '=' comparison.ParentIdsupports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM StatusUpdates
SELECT * FROM StatusUpdates WHERE Id = '1126938837961834'
SELECT * FROM StatusUpdates WHERE ParentId = '1126938837961834'
Insert
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')
Delete
Following is an example of how to delete from StatusUpdates table:
DELETE FROM StatusUpdates WHERE ID = '1161963899354167'
Columns
| 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. |
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.
Table Specific Information
Select
The connector 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 connector.
Idsupports the '=' comparison.TaskIdsupports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM Stories WHERE Id = '1126938691750986'
SELECT * FROM Stories WHERE TaskId = '1129514033997892'
Insert
TaskId is a mandatory column for inserting into Stories table. For example:
INSERT INTO Stories (Text, TaskId, IsPinned) VALUES ('InProgress', '1129514033997892', false)
Update
Following is an example of how to update a Stories table:
UPDATE Stories SET Text = 'story line' WHERE ID = '1126938691750986'
Delete
Following is an example of how to delete from Stories table:
DELETE FROM Stories WHERE ID = '1126938691750986'
Columns
| 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 |
SubTasks
To Create, update, delete, and query from SubTasks table.
Table Specific Information
Select
The connector 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 connector.
ParentTaskIdsupports the '=' comparison.
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 connector 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.
Insert
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' )
Columns
| Name | Type | ReadOnly | References | Description |
|---|---|---|---|---|
Id [KEY] |
String |
True | Globally unique ID of the Subtask. | |
ParentTaskId |
String |
True | Tasks.Id | 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. |
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.
Table Specific Information
Select
The connector 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 connector.
Idsupports the '=' comparison.WorkspaceIdsupports the '=' comparison.TaskIdsupports the '=' comparison.
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'
Insert
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')
Update
Following is an example of how to update a Tags table:
UPDATE Tags SET Name = 'IT-1' WHERE ID = '1158271967831255'
Columns
| 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. |
Tasks
To Create, Update, Delete and Query from Tasks table.
Table Specific Information
Select
The connector 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 connector.
Idsupports the '=' comparison.ProjectIdsupports the '=' comparison.Assigneesupports the '=' comparison.
Note
Assignee must be provided with WorkspaceId, either in the query or in the connection string.
TagIdsupports the '=' comparison.SectionIdsupports the '=' comparison.UserTaskListIdsupports the '=' comparison.ModifiedAtsupports the '>, >=' comparison.CompletedAtsupports the '>, >=' comparison.
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 connector 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 connector will not be able to retrieve orphaned tasks.
If the UseTypeaheadSearch connection property is set to true, only the Name and WorkspaceId columns are filterable server-side. The Name column supports '=' and 'LIKE' comparisons, but only when 'LIKE' is used in one of the following forms:
SELECT * FROM Tasks WHERE Name = 'abc'
SELECT * FROM Tasks WHERE Name LIKE 'abc'
SELECT * FROM Tasks WHERE Name LIKE 'abc%'
SELECT * FROM Tasks WHERE Name LIKE 'abc%' AND WorkspaceId = '1126938837961830'
Insert
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')
Update
The following is an example of how to update the Tasks table:
UPDATE Tasks SET Browser = 'ie' WHERE ID = '1167713816822371'
Delete
The following is an example of how to delete from the Tasks table:
DELETE FROM Tasks WHERE ID = '1167713816822371'
Columns
| 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. | |
RecurrenceType |
String |
True | The type of recurrence. | |
RecurrenceData |
String |
True | The data of recurrence. | |
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. |
TaskTemplates
To Delete and Query the task templates.
Table Specific Information
Select
The connector 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 connector.
Idsupports the '=' comparison.ProjectIdsupports the '=' comparison.
For example, the following queries are processed server-side:
SELECT * FROM TaskTemplates WHERE Id = '1127092449876457'
SELECT * FROM TaskTemplates WHERE ProjectId = '1208149945266501'
Delete
The following is an example of how to delete from the TaskTemplates table:
DELETE FROM TaskTemplates WHERE ID = '1234'
Columns
| 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 |
Time |
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. |
TeamMembership
To represents a users connection to a team.
Table Specific Information
Select
The connector 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 connector.
Idsupports the '=' comparison.UserIdsupports the '=' comparison.WorkspaceIdsupports the '=' comparison.TeamIdsupports the '=' comparison.
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'
Insert
UserId and TeamId is a mandatory column for inserting into TeamMembership table. For example:
INSERT INTO TeamMembership (UserId, TeamId) VALUES ('1161963899354167', '1126938837961832')
Delete
Following is an example of how to delete from TeamMembership table:
DELETE FROM TeamMembership WHERE UserId = '1161963899354167' AND TeamId = '1126938837961832'
Columns
| 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. |
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.
Table Specific Information
Select
The connector 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 connector.
Idsupports the '=' comparison.WorkspaceIdsupports the '=' comparison.UserIdsupports the '=' comparison.
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
WorkspaceId is a mandatory column for inserting into Teams table.In the WorkspaceId only the organisation ID can be used to create teams. Teams can not be created for workspaces which are not part of a organisation. For example:
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')
Columns
| 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. |
Endorsed |
Boolean |
False | Whether the team has been endorsed |
TimeTrackingEntries
Returns time tracking entries for a given task.
Table Specific Information
Select
The connector 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 connector.
Idsupports the '=' comparison.TaskIdsupports the '=' comparison.
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 connector 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)
Insert
TaskId is a mandatory column for inserting into TimeTrackingEntries table. For example:
INSERT INTO TimeTrackingEntries (TaskId, DurationMinutes, EnteredOn) VALUES ('1203125557018947', 3600, '2024-01-01')
Update
Following is an example of how to update a TimeTrackingEntries table:
UPDATE TimeTrackingEntries SET DurationMinutes = 4000, EnteredOn = '2023-01-01' WHERE ID = '1208387811113769'
Delete
Following is an example of how to delete from TimeTrackingEntries table:
DELETE FROM TimeTrackingEntries WHERE ID = '1208387811113769'
Columns
| 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. |
WorkspaceMembership
To Create, Delete and Query memberships in the Workspace.
Table Specific Information
Select
The connector 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 connector.
Idsupports the '=' comparison.UserIdsupports the '=' comparison.WorkspaceIdsupports the '=' comparison.
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'
Insert
UserId and WorkspaceId is a mandatory column for inserting into WorkspaceMembership table. For example:
INSERT INTO WorkspaceMembership (UserId, WorkspaceId) VALUES ('1161963899354167', '1126938837961830')
Delete
Following is an example of how to delete from WorkspaceMembership table:
DELETE FROM WorkspaceMembership WHERE UserId = '1161963899354167' AND WorkspaceId = '1126938837961830'
Columns
| 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. | |
IsViewOnly |
Boolean |
True | Reflects if this user has view only license 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.
Table Specific Information
Select
The connector 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 connector.
Idsupports the '=' comparison.UserIdsupports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM Workspaces WHERE Id = '1126938837961835'
SELECT * FROM Workspaces WHERE UserId = '1126938691750986'
Update
Following is an example of how to update a Workspaces table:
UPDATE Workspaces SET Name = 'IT-Eng' WHERE ID = '1126938837961835'
Columns
| 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
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.
Asana Connector Views
| Name | Description |
|---|---|
CustomFields |
To view the Custom Fields in the project or workspace. |
Events |
To view the events in projects and tasks. |
PremiumWorkspaceTasks |
To search tasks in premium workspaces. |
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. |
CustomFields
To view the Custom Fields in the project or workspace.
Table Specific Information
Select
The connector 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 connector.
ProjectIdsupports the '=' comparison.
For example, the following query is processed server side:
SELECT * FROM CustomFields WHERE ProjectId = '1126938691750986'
Columns
| 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. | |
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. |
Events
To view the events in projects and tasks.
Table Specific Information
Select
The connector 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 connector.
ResourceIdsupports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM Events WHERE ResourceId = '1128092964672854'
Columns
| 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. |
PremiumWorkspaceTasks
To search tasks in premium workspaces.
Table Specific Information
Select
This table fetches all the tasks belonging to a premium workspace. It would also fetch orphaned tasks which do not belong to any project. Without WorkspaceId, the table will first fetch all the workspaces, and then fetch the data only for premium workspaces.
The connector 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 connector.
Assigneesupports the '=,IN' comparison.ModifiedAtsupports the '=,<,<=,>,>=' comparison.StartOnsupports the '=,<,<=,>,>=' comparison.DueAtsupports the '=,<,<=,>,>=' comparison.DueOnsupports the '=,<,<=,>,>=' comparison.Completedsupports the '=' comparison.CompletedAtsupports the '=,<,<=,>,>=' comparison.ProjectIdsupports the '=' comparison.WorkspaceIdsupports the '=' comparison.CreatedByIdsupports the '=' comparison.SectionIdsupports the '=' comparison.TagIdsupports the '=' comparison.FollowerIdsupports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM PremiumWorkspaceTasks
SELECT * FROM Tasks WHERE WorkspaceId = '1126938837961830'
SELECT * FROM PremiumWorkspaceTasks WHERE ProjectId = '1128092964672848'
SELECT * FROM PremiumWorkspaceTasks WHERE Assignee IN ('1206041702093338', '1134886242100800')
SELECT * FROM PremiumWorkspaceTasks WHERE TagId = '1129517083601713'
SELECT * FROM PremiumWorkspaceTasks WHERE SectionId = '1127092449876457'
SELECT * FROM PremiumWorkspaceTasks WHERE ModifiedAt > '2024-10-09 02:43:21.933'
SELECT * FROM PremiumWorkspaceTasks WHERE ProjectId = '1200222223676674' AND CompletedAt >= '2024-10-31 17:10:28.268'
Columns
| 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. |
ProjectId |
String |
Projects.Id | Projectid of this task is associated with. |
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. | |
SectionId |
String |
Sections.Id | PseudoColumn: Globally unique ID of the section. |
TagId |
String |
Tags.Id | PseudoColumn: Globally unique ID of the tag. |
FollowerId |
String |
PseudoColumn: Globally unique ID of the follower. |
ProjectFollowers
To view the Project follower details.
Columns
| 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. |
ProjectTemplates
TO get ProjectTemplates in the Team or workspace.
Table Specific Information
Select
The connector 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 connector.
Idsupports the '=' comparison.TeamIdsupports the '=' comparison.WorkspaceIdsupports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM ProjectTemplates where Id = '1208187943633195'
SELECT * FROM ProjectTemplates where TeamId = '1207673648001734'
SELECT * FROM ProjectTemplates WHERE WorkspaceId = '1208200246477352'
In case of UseTypeaheadSearch property set to true, only Name and WorkspaceId columns would be filterable server side with Name supporting '=, LIKE' comparison when LIKE used only in the following ways:
SELECT * FROM ProjectTemplates WHERE Name = 'abc'
SELECT * FROM ProjectTemplates WHERE Name LIKE 'abc'
SELECT * FROM ProjectTemplates WHERE Name LIKE 'abc%'
SELECT * FROM ProjectTemplates WHERE Name LIKE 'abc%' AND WorkspaceId = '1208200246477352'
Columns
| 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-Columns
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 |
TaskDependencies
To query all of the dependencies of a task.
Table Specific Information
Select
The connector 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 connector.
TaskIdsupports the '=' comparison.
For example, the following queries are processed server-side:
SELECT * FROM TaskDependencies WHERE TaskId = '1208618397035168'
Columns
| 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 [KEY] |
String |
Tasks.Id | The task to operate on. |
TaskDependents
To query all of the dependents of a task.
Table Specific Information
Select
The connector 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 connector.
TaskIdsupports the '=' comparison.
For example, the following queries are processed server-side:
SELECT * FROM TaskDependents WHERE TaskId = '1208618397035168'
Columns
| 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 [KEY] |
String |
Tasks.Id | The task to operate on. |
TaskStatuses
Get task count of a project.
Table Specific Information
Select
The connector 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 connector.
ProjectIdsupports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM TaskStatuses WHERE ProjectId = '1136437449978157'
Columns
| 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. |
TimePeriods
To query time period records or full record for a single time period.
Table Specific Information
Select
The connector 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 connector.
Idsupports the '=' comparison.WorkspaceIdsupports the '=' comparison.
For example, the following queries are processed server-side:
SELECT * FROM TimePeriods where Id = '1200585294122707'
SELECT * FROM TimePeriods where WorkspaceId = '1126938837961835'
Columns
| 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. |
Users
To view the users details.
Table Specific Information
Select
The connector 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 connector.
Idsupports the '=' comparison.WorkspaceIdsupports the '=' comparison.TeamIdsupports the '=' comparison.
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'
In case of UseTypeaheadSearch property set to true, only Name and WorkspaceId columns would be filterable server side with Name supporting '=, LIKE' comparison when LIKE used only in the following ways:
SELECT * FROM Users WHERE Name = 'abc'
SELECT * FROM Users WHERE Name LIKE 'abc'
SELECT * FROM Users WHERE Name LIKE 'abc%'
SELECT * FROM Users WHERE Name LIKE 'abc%' AND WorkspaceId = '1126938837961830'
Columns
| Name | Type | References | Description |
|---|---|---|---|
Id [KEY] |
String |
Globally unique ID of the user. | |
Name |
String |
The user`s name. | |
Email |
String |
The user`s email address. | |
ResourceType |
String |
The resource type of this resource. | |
WorkspaceId [KEY] |
String |
Workspaces.Id | The User access in workspaces. |
TeamId |
String |
Teams.Id | Globally unique ID of the team. |
Workspaces |
String |
The User access in workspaces. |
UserTaskList
Generated schema file.
Table Specific Information
Select
The connector 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 connector.
Idsupports the '=' comparison.UserIdsupports the '=' comparison.workspaceIdsupports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM UserTaskList WHERE Id = '1126938837961837'
SELECT * FROM UserTaskList WHERE UserId = '1126938691750986' AND workspaceId = '1126938837961830'
Columns
| 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. |
Stored Procedures
Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT/INSERT/UPDATE/DELETE operations with Asana.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Asana, along with an indication of whether the procedure succeeded or failed.
Asana Connector Stored Procedures
| Name | Description |
|---|---|
AddDependenciesToTask |
To set of tasks as dependencies of this task, if they are not already dependencies. A task can have at most 15 dependencies. |
AddDependentsToTask |
To Set or Unlink dependents to the task. |
AddFollowers |
To add followers to the tasks or projects. |
AddProjectToTask |
Add a project to a task. |
AddTagsToTask |
To Set or Unlink dependents to the task. |
AddTaskToSection |
Add a task to a specific, existing section. This will remove the task from other sections of the project. |
DownloadAttachment |
To Download an Attachment. |
DuplicateProject |
To create a duplicate copy of the project. |
DuplicateTask |
To Set or Unlink dependencies to the task. |
GetOAuthAccessToken |
Gets an authentication token from Asana. |
GetOAuthAuthorizationURL |
Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the OAuthAccessToken from this URL. |
InstantiateTaskFromTemplate |
Creates a task from the task template. |
MoveSectionsinProject |
To reorder the section in the project. |
RefreshOAuthAccessToken |
Refreshes the OAuth access token used for authentication with Asana. |
RemoveDependenciesFromTask |
To Set or Unlink dependencies to the task. |
RemoveDependentsFromTask |
To Set or Unlink dependents to the task. |
RemoveFollowers |
To remove followers from the tasks or projects. |
RemoveProjectsFromTask |
Remove a project from a task. |
RemoveTagsFromTask |
To Set or Unlink dependents to the task. |
SetParentofTask |
To Set the parent of a task. |
UploadAttachment |
Uploads an Attachment to Asana. |
AddDependenciesToTask
To set of tasks as dependencies of this task, if they are not already dependencies. A task can have at most 15 dependencies.
Input
| Name | Type | Required | Description |
|---|---|---|---|
TaskId |
String |
True | The Tasks ID to operate on. |
Dependencies |
String |
True | Task ids to add dependencies. For more than One task ID please separate with comma(, ). |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Status |
String |
The status of the operation. |
AddDependentsToTask
To Set or Unlink dependents to the task.
Input
| Name | Type | Required | Description |
|---|---|---|---|
TaskId |
String |
True | The Tasks ID to operate on. |
DependentTaskId |
String |
True | Task ids to add or remove as dependents. For more than One task ID please separate with comma(, ). |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Status |
String |
The status of the operation. |
AddFollowers
To add followers to the tasks or projects.
Input
| Name | Type | Required | Description |
|---|---|---|---|
Id |
String |
True | The Tasks ID or Project ID to operate on. |
User |
String |
True | Users.Id OR Users.EMail to Add. |
TableName |
String |
True | To add the followers in. The allowed values are projects, tasks. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Status |
String |
The status of the operation. |
AddProjectToTask
Add a project to a task.
Input
| Name | Type | Required | Description |
|---|---|---|---|
TaskId |
String |
True | The Tasks ID to operate on. |
ProjectId |
String |
True | The project ID to add the task. |
SectionId |
String |
False | A section ID in the project to insert the task into. The task will be inserted at the bottom of the section. |
AddAfter |
String |
False | A task ID in the project to insert the task after, or null to insert at the beginning of the list. |
AddBefore |
String |
False | A task ID in the project to insert the task before, or null to insert at the end of the list. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Status |
String |
The status of the operation. |
AddTagsToTask
To Set or Unlink dependents to the task.
Input
| Name | Type | Required | Description |
|---|---|---|---|
TaskId |
String |
True | The Tasks ID to operate on. |
TagId |
String |
True | Tags ID to add in the task. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Status |
String |
The status of the operation. |
AddTaskToSection
Add a task to a specific, existing section. This will remove the task from other sections of the project.
Input
| Name | Type | Required | Description |
|---|---|---|---|
SectionId |
String |
True | A section ID in the project to move the task into. |
TaskId |
String |
True | The task ID to add to this section. |
AddAfter |
String |
False | An existing task ID within this section before which the added task should be inserted. Cannot be provided together with insert_after. |
AddBefore |
String |
False | An existing task ID within this section after which the added task should be inserted. Cannot be provided together with insert_before. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Status |
String |
The status of the operation. |
DownloadAttachment
To Download an Attachment.
Input
| Name | Type | Required | Description |
|---|---|---|---|
AttachmentId |
String |
False | Attachment ID to download. |
TaskId |
String |
False | Task ID to download all the attachments in the Task. |
DownloadLocation |
String |
False | Download location. |
Encoding |
String |
False | The FileData input encoding type. The allowed values are NONE, BASE64. The default value is BASE64. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Status |
String |
The status of the operation. |
FileData |
String |
The file data output. |
DuplicateProject
To create a duplicate copy of the project.
Input
| Name | Type | Required | Description |
|---|---|---|---|
ProjectId |
String |
True | Globally unique identifier for the project. |
NewProjectName |
String |
True | The name of the new project. |
Include |
String |
True | The fields that will be duplicated to the new task. The accepted values are members, notes, task_notes, task_assignee, task_subtasks, task_attachments, task_dates, task_dependencies, task_followers, task_tags, task_projects. For more than One values, please separate with comma(, ). |
TeamId |
String |
False | Sets the team of the new project. If team is not defined, the new project will be in the same team as the the original project. |
DueOn |
Date |
False | Sets the last due date in the duplicated project to the given date. The rest of the due dates will be offset by the same amount as the due dates in the original project. This takes a date with format YYYY-MM-DD. |
StartOn |
Date |
False | Sets the first start date in the duplicated project to the given date. The rest of the start dates will be offset by the same amount as the start dates in the original project. This takes a date with format YYYY-MM-DD. |
SkipWeekends |
Boolean |
False | Determines if the auto-shifted dates should skip weekends. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Status |
String |
The status of the operation. |
DuplicateTask
To Set or Unlink dependencies to the task.
Input
| Name | Type | Required | Description |
|---|---|---|---|
TaskId |
String |
True | The Task ID to operate on. |
NewTaskName |
String |
True | The name of the new task. |
Include |
String |
True | The fields that will be duplicated to the new task. The accepted values are notes, assignee, subtasks, attachments, tags, followers, projects, dates, dependencies, parent. For more than One values please separate with comma(, ). |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Status |
String |
The status of the operation. |
GetOAuthAccessToken
Gets an authentication token from Asana.
Input
| Name | Type | Required | Description |
|---|---|---|---|
AuthMode |
String |
False | The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app. The allowed values are APP, WEB. The default value is APP. |
CallbackUrl |
String |
False | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL you have specified in the Asana app settings. Only needed when the Authmode parameter is Web. |
Verifier |
String |
False | The verifier returned from Asana after the user has authorized your app to have access to their data. This value will be returned as a parameter to the callback URL. |
State |
String |
False | Encodes state of the app, which will be returned verbatim in the response and can be used to match the response up to a given request. |
Scope |
String |
False | A space-delimited set of one or more scopes to get the user's permission to access. If no scopes are specified, the default OAuth scope will be used—provided the app was originally registered with Full permissions. The supported scopes are 'attachments:delete attachments:read attachments:write custom_fields:read custom_fields:write goals:read portfolios:read portfolios:write project_templates:read projects:delete projects:read projects:write stories:read stories:write tags:read tags:write task_templates:read tasks:delete tasks:read tasks:write teams:read workspace.typeahead:read users:read webhooks:delete webhooks:read webhooks:write workspaces:read'. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
OAuthAccessToken |
String |
The access token used for communication with Asana. |
OAuthRefreshToken |
String |
The OAuth refresh token. This is the same as the access token in the case of Asana. |
ExpiresIn |
String |
The remaining lifetime on the access token. A -1 denotes that it will not expire. |
GetOAuthAuthorizationURL
Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the OAuthAccessToken from this URL.
Input
| Name | Type | Required | Description |
|---|---|---|---|
CallbackUrl |
String |
False | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL in the Asana app settings. |
State |
String |
False | Encodes state of the app, which will be returned verbatim in the response and can be used to match the response up to a given request. |
Scope |
String |
False | A space-delimited set of one or more scopes to get the user's permission to access. If no scopes are specified, the default OAuth scope will be used—provided the app was originally registered with Full permissions. The supported scopes are 'attachments:delete attachments:read attachments:write custom_fields:read custom_fields:write goals:read portfolios:read portfolios:write project_templates:read projects:delete projects:read projects:write stories:read stories:write tags:read tags:write task_templates:read tasks:delete tasks:read tasks:write teams:read workspace.typeahead:read users:read webhooks:delete webhooks:read webhooks:write workspaces:read'. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
URL |
String |
The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app. |
InstantiateTaskFromTemplate
Creates a task from the task template.
Input
| Name | Type | Required | Description |
|---|---|---|---|
TaskTemplateId |
String |
True | Globally unique identifier for the task template. |
Name |
String |
True | The name of the new task. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Status |
String |
The status of the operation. |
TaskId |
String |
ID of the new task created. |
TaskName |
String |
Name of the new task created. |
MoveSectionsinProject
To reorder the section in the project.
Input
| Name | Type | Required | Description |
|---|---|---|---|
ProjectId |
String |
True | The project in which to reorder the given section. |
SectionId |
String |
True | The section to reorder. |
BeforeSection |
String |
False | Insert the given section immediately before the section specified by this parameter. |
AfterSection |
String |
False | Insert the given section immediately after the section specified by this parameter. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Status |
String |
The status of the operation. |
RefreshOAuthAccessToken
Refreshes the OAuth access token used for authentication with Asana.
Input
| Name | Type | Required | Description |
|---|---|---|---|
OAuthRefreshToken |
String |
True | Set this to the token value that expired. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
OAuthAccessToken |
String |
The authentication token returned from Asana. This can be used in subsequent calls to other operations for this particular service. |
OAuthRefreshToken |
String |
This is the same as the access token. |
ExpiresIn |
String |
The remaining lifetime on the access token. |
RemoveDependenciesFromTask
To Set or Unlink dependencies to the task.
Input
| Name | Type | Required | Description |
|---|---|---|---|
TaskId |
String |
True | The Tasks ID to operate on. |
DependentTaskId |
String |
False | Dependencies column should be used instead of this. |
Dependencies |
String |
False | Task ids to add or remove as dependencies. For more than One task ID please separate with comma(, ). |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Status |
String |
The status of the operation. |
RemoveDependentsFromTask
To Set or Unlink dependents to the task.
Input
| Name | Type | Required | Description |
|---|---|---|---|
TaskId |
String |
True | The Tasks ID to operate on. |
DependentTaskId |
String |
True | Task ids to add or remove as dependents. For more than One task ID please separate with comma(, ). |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Status |
String |
The status of the operation. |
RemoveFollowers
To remove followers from the tasks or projects.
Input
| Name | Type | Required | Description |
|---|---|---|---|
Id |
String |
True | The Tasks ID or Project ID to operate on. |
User |
String |
True | Users.Id OR Users.EMail to remove. |
TableName |
String |
True | To remove the followers in. The allowed values are projects, tasks. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Status |
String |
The status of the operation. |
RemoveProjectsFromTask
Remove a project from a task.
Input
| Name | Type | Required | Description |
|---|---|---|---|
TaskId |
String |
True | The Tasks ID to operate on. |
ProjectId |
String |
True | The project ID to add or remove the task to. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Status |
String |
The status of the operation. |
RemoveTagsFromTask
To Set or Unlink dependents to the task.
Input
| Name | Type | Required | Description |
|---|---|---|---|
TaskId |
String |
True | The Tasks ID to operate on. |
TagId |
String |
True | Tags ID to remove from the task. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Status |
String |
The status of the operation. |
SetParentofTask
To Set the parent of a task.
Input
| Name | Type | Required | Description |
|---|---|---|---|
TaskId |
String |
True | The TaskId to update. |
ParentTaskId |
String |
True | The new parent of the task, or null for no parent.. |
AddBefore |
String |
False | A subtask of the parent to insert the task after, or null to insert at the beginning of the list. |
AddAfter |
String |
False | A subtask of the parent to insert the task before, or null to insert at the end of the list. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Status |
String |
The status of the operation. |
UploadAttachment
Uploads an Attachment to Asana.
Input
| Name | Type | Required | Description |
|---|---|---|---|
TaskId |
String |
True | Specify Task ID to upload the attachment. |
FilePath |
String |
False | Specify the location of the attachment to upload. |
Name |
String |
False | The title for the Attachment, including the extension. This value will be used, if Content is not null. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
AttachmentId |
String |
Globally unique ID of the attachment. |
FileName |
String |
The name of the file. |
Status |
String |
The status of the operation. |
System Tables
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
Schema Tables
The following tables return database metadata for Asana:
- sys_catalogs: Lists the available databases.
- sys_schemas: Lists the available schemas.
- sys_tables: Lists the available tables and views.
- sys_tablecolumns: Describes the columns of the available tables and views.
- sys_procedures: Describes the available stored procedures.
- sys_procedureparameters: Describes stored procedure parameters.
- sys_keycolumns: Describes the primary and foreign keys.
- sys_indexes: Describes the available indexes.
Data Source Tables
The following tables return information about how to connect to and query the data source:
- sys_connection_props: Returns information on the available connection properties.
- sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.
Query Information Tables
The following table returns query statistics for data modification queries, including batch operations:
- sys_identity: Returns information about batch operations or single updates.
sys_catalogs
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
Columns
| Name | Type | Description |
|---|---|---|
CatalogName |
String |
The database name. |
sys_schemas
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
Columns
| Name | Type | Description |
|---|---|---|
CatalogName |
String |
The database name. |
SchemaName |
String |
The schema name. |
sys_tables
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
Columns
| Name | Type | Description |
|---|---|---|
CatalogName |
String |
The database containing the table or view. |
SchemaName |
String |
The schema containing the table or view. |
TableName |
String |
The name of the table or view. |
TableType |
String |
The table type (table or view). |
Description |
String |
A description of the table or view. |
IsUpdateable |
Boolean |
Whether the table can be updated. |
sys_tablecolumns
Describes the columns of the available tables and views.
The following query returns the columns and data types for the projects table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='projects'
Columns
| Name | Type | Description |
|---|---|---|
CatalogName |
String |
The name of the database containing the table or view. |
SchemaName |
String |
The schema containing the table or view. |
TableName |
String |
The name of the table or view containing the column. |
ColumnName |
String |
The column name. |
DataTypeName |
String |
The data type name. |
DataType |
Int32 |
An integer indicating the data type. This value is determined at run time based on the environment. |
Length |
Int32 |
The storage size of the column. |
DisplaySize |
Int32 |
The designated column's normal maximum width in characters. |
NumericPrecision |
Int32 |
The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
NumericScale |
Int32 |
The column scale or number of digits to the right of the decimal point. |
IsNullable |
Boolean |
Whether the column can contain null. |
Description |
String |
A brief description of the column. |
Ordinal |
Int32 |
The sequence number of the column. |
IsAutoIncrement |
String |
Whether the column value is assigned in fixed increments. |
IsGeneratedColumn |
String |
Whether the column is generated. |
IsHidden |
Boolean |
Whether the column is hidden. |
IsArray |
Boolean |
Whether the column is an array. |
IsReadOnly |
Boolean |
Whether the column is read-only. |
IsKey |
Boolean |
Indicates whether a field returned from sys_tablecolumns is the primary key of the table. |
ColumnType |
String |
The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN. |
sys_procedures
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
Columns
| Name | Type | Description |
|---|---|---|
CatalogName |
String |
The database containing the stored procedure. |
SchemaName |
String |
The schema containing the stored procedure. |
ProcedureName |
String |
The name of the stored procedure. |
Description |
String |
A description of the stored procedure. |
ProcedureType |
String |
The type of the procedure, such as PROCEDURE or FUNCTION. |
sys_procedureparameters
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the UploadAttachment stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'UploadAttachment' AND Direction = 1 OR Direction = 2
To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'UploadAttachment' AND IncludeResultColumns='True'
Columns
| Name | Type | Description |
|---|---|---|
CatalogName |
String |
The name of the database containing the stored procedure. |
SchemaName |
String |
The name of the schema containing the stored procedure. |
ProcedureName |
String |
The name of the stored procedure containing the parameter. |
ColumnName |
String |
The name of the stored procedure parameter. |
Direction |
Int32 |
An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
DataType |
Int32 |
An integer indicating the data type. This value is determined at run time based on the environment. |
DataTypeName |
String |
The name of the data type. |
NumericPrecision |
Int32 |
The maximum precision for numeric data. The column length in characters for character and date-time data. |
Length |
Int32 |
The number of characters allowed for character data. The number of digits allowed for numeric data. |
NumericScale |
Int32 |
The number of digits to the right of the decimal point in numeric data. |
IsNullable |
Boolean |
Whether the parameter can contain null. |
IsRequired |
Boolean |
Whether the parameter is required for execution of the procedure. |
IsArray |
Boolean |
Whether the parameter is an array. |
Description |
String |
The description of the parameter. |
Ordinal |
Int32 |
The index of the parameter. |
Values |
String |
The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated. |
SupportsStreams |
Boolean |
Whether the parameter represents a file that you can pass as either a file path or a stream. |
IsPath |
Boolean |
Whether the parameter is a target path for a schema creation operation. |
Default |
String |
The value used for this parameter when no value is specified. |
SpecificName |
String |
A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here. |
IsProvided |
Boolean |
Whether the procedure is added/implemented by , as opposed to being a native Asana procedure. |
Pseudo-Columns
| Name | Type | Description |
|---|---|---|
IncludeResultColumns |
Boolean |
Whether the output should include columns from the result set in addition to parameters. Defaults to False. |
sys_keycolumns
Describes the primary and foreign keys.
The following query retrieves the primary key for the projects table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='projects'
Columns
| Name | Type | Description |
|---|---|---|
CatalogName |
String |
The name of the database containing the key. |
SchemaName |
String |
The name of the schema containing the key. |
TableName |
String |
The name of the table containing the key. |
ColumnName |
String |
The name of the key column. |
IsKey |
Boolean |
Whether the column is a primary key in the table referenced in the TableName field. |
IsForeignKey |
Boolean |
Whether the column is a foreign key referenced in the TableName field. |
PrimaryKeyName |
String |
The name of the primary key. |
ForeignKeyName |
String |
The name of the foreign key. |
ReferencedCatalogName |
String |
The database containing the primary key. |
ReferencedSchemaName |
String |
The schema containing the primary key. |
ReferencedTableName |
String |
The table containing the primary key. |
ReferencedColumnName |
String |
The column name of the primary key. |
sys_foreignkeys
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Columns
| Name | Type | Description |
|---|---|---|
CatalogName |
String |
The name of the database containing the key. |
SchemaName |
String |
The name of the schema containing the key. |
TableName |
String |
The name of the table containing the key. |
ColumnName |
String |
The name of the key column. |
PrimaryKeyName |
String |
The name of the primary key. |
ForeignKeyName |
String |
The name of the foreign key. |
ReferencedCatalogName |
String |
The database containing the primary key. |
ReferencedSchemaName |
String |
The schema containing the primary key. |
ReferencedTableName |
String |
The table containing the primary key. |
ReferencedColumnName |
String |
The column name of the primary key. |
ForeignKeyType |
String |
Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
sys_primarykeys
Describes the primary keys.
The following query retrieves the primary keys from all tables and views:
SELECT * FROM sys_primarykeys
Columns
| Name | Type | Description |
|---|---|---|
CatalogName |
String |
The name of the database containing the key. |
SchemaName |
String |
The name of the schema containing the key. |
TableName |
String |
The name of the table containing the key. |
ColumnName |
String |
The name of the key column. |
KeySeq |
String |
The sequence number of the primary key. |
KeyName |
String |
The name of the primary key. |
sys_indexes
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
Columns
| Name | Type | Description |
|---|---|---|
CatalogName |
String |
The name of the database containing the index. |
SchemaName |
String |
The name of the schema containing the index. |
TableName |
String |
The name of the table containing the index. |
IndexName |
String |
The index name. |
ColumnName |
String |
The name of the column associated with the index. |
IsUnique |
Boolean |
True if the index is unique. False otherwise. |
IsPrimary |
Boolean |
True if the index is a primary key. False otherwise. |
Type |
Int16 |
An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
SortOrder |
String |
The sort order: A for ascending or D for descending. |
OrdinalPosition |
Int16 |
The sequence number of the column in the index. |
sys_connection_props
Returns information on the available connection properties and those set in the connection string.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
Columns
| Name | Type | Description |
|---|---|---|
Name |
String |
The name of the connection property. |
ShortDescription |
String |
A brief description. |
Type |
String |
The data type of the connection property. |
Default |
String |
The default value if one is not explicitly set. |
Values |
String |
A comma-separated list of possible values. A validation error is thrown if another value is specified. |
Value |
String |
The value you set or a preconfigured default. |
Required |
Boolean |
Whether the property is required to connect. |
Category |
String |
The category of the connection property. |
IsSessionProperty |
String |
Whether the property is a session property, used to save information about the current connection. |
Sensitivity |
String |
The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
PropertyName |
String |
A camel-cased truncated form of the connection property name. |
Ordinal |
Int32 |
The index of the parameter. |
CatOrdinal |
Int32 |
The index of the parameter category. |
Hierarchy |
String |
Shows dependent properties associated that need to be set alongside this one. |
Visible |
Boolean |
Informs whether the property is visible in the connection UI. |
ETC |
String |
Various miscellaneous information about the property. |
sys_sqlinfo
Describes the SELECT query processing that the connector can offload to the data source.
Discovering the Data Source's SELECT Capabilities
Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
| Name | Description | Possible Values |
|---|---|---|
AGGREGATE_FUNCTIONS |
Supported aggregation functions. | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
COUNT |
Whether COUNT function is supported. | YES, NO |
IDENTIFIER_QUOTE_OPEN_CHAR |
The opening character used to escape an identifier. | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR |
The closing character used to escape an identifier. | ] |
SUPPORTED_OPERATORS |
A list of supported SQL operators. | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
GROUP_BY |
Whether GROUP BY is supported, and, if so, the degree of support. | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
STRING_FUNCTIONS |
Supported string functions. | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
NUMERIC_FUNCTIONS |
Supported numeric functions. | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
TIMEDATE_FUNCTIONS |
Supported date/time functions. | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
REPLICATION_SKIP_TABLES |
Indicates tables skipped during replication. | |
REPLICATION_TIMECHECK_COLUMNS |
A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
IDENTIFIER_PATTERN |
String value indicating what string is valid for an identifier. | |
SUPPORT_TRANSACTION |
Indicates if the provider supports transactions such as commit and rollback. | YES, NO |
DIALECT |
Indicates the SQL dialect to use. | |
KEY_PROPERTIES |
Indicates the properties which identify the uniform database. | |
SUPPORTS_MULTIPLE_SCHEMAS |
Indicates if multiple schemas may exist for the provider. | YES, NO |
SUPPORTS_MULTIPLE_CATALOGS |
Indicates if multiple catalogs may exist for the provider. | YES, NO |
DATASYNCVERSION |
The Data Sync version needed to access this driver. | Standard, Starter, Professional, Enterprise |
DATASYNCCATEGORY |
The Data Sync category of this driver. | Source, Destination, Cloud Destination |
SUPPORTSENHANCEDSQL |
Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE, FALSE |
SUPPORTS_BATCH_OPERATIONS |
Whether batch operations are supported. | YES, NO |
SQL_CAP |
All supported SQL capabilities for this driver. | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
PREFERRED_CACHE_OPTIONS |
A string value specifies the preferred cacheOptions. | |
ENABLE_EF_ADVANCED_QUERY |
Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES, NO |
PSEUDO_COLUMNS |
A string array indicating the available pseudo columns. | |
MERGE_ALWAYS |
If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE, FALSE |
REPLICATION_MIN_DATE_QUERY |
A select query to return the replicate start datetime. | |
REPLICATION_MIN_FUNCTION |
Allows a provider to specify the formula name to use for executing a server side min. | |
REPLICATION_START_DATE |
Allows a provider to specify a replicate startdate. | |
REPLICATION_MAX_DATE_QUERY |
A select query to return the replicate end datetime. | |
REPLICATION_MAX_FUNCTION |
Allows a provider to specify the formula name to use for executing a server side max. | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE |
A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
CHECKCACHE_USE_PARENTID |
Indicates whether the CheckCache statement should be done against the parent key column. | TRUE, FALSE |
CREATE_SCHEMA_PROCEDURES |
Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
Columns
| Name | Type | Description |
|---|---|---|
NAME |
String |
A component of SQL syntax, or a capability that can be processed on the server. |
VALUE |
String |
Detail on the supported SQL or SQL syntax. |
sys_identity
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
Columns
| Name | Type | Description |
|---|---|---|
Id |
String |
The database-generated ID returned from a data modification operation. |
Batch |
String |
An identifier for the batch. 1 for a single operation. |
Operation |
String |
The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
Message |
String |
SUCCESS or an error message if the update in the batch failed. |
sys_information
Describes the available system information.
The following query retrieves all columns:
SELECT * FROM sys_information
Columns
| Name | Type | Description |
|---|---|---|
Product |
String |
The name of the product. |
Version |
String |
The version number of the product. |
Datasource |
String |
The name of the datasource the product connects to. |
NodeId |
String |
The unique identifier of the machine where the product is installed. |
HelpURL |
String |
The URL to the product's help documentation. |
License |
String |
The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.) |
Location |
String |
The file path location where the product's library is stored. |
Environment |
String |
The version of the environment or rumtine the product is currently running under. |
DataSyncVersion |
String |
The tier of Sync required to use this connector. |
DataSyncCategory |
String |
The category of Sync functionality (e.g., Source, Destination). |
Advanced Configurations Properties
The advanced configurations 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. Click the links for further details.
| 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 |
|---|---|
InitiateOAuth |
Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. |
OAuthClientId |
Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
OAuthClientSecret |
Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. |
OAuthAccessToken |
Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange. |
OAuthSettingsLocation |
Specifies the location of the settings file where OAuth values are saved. Storing OAuth settings in a central location avoids the need for users to enter OAuth connection properties manually each time they log in. It also enables credentials to be shared across connections or processes. |
CallbackURL |
Identifies the URL users return to after authenticating to Asana via OAuth. (Custom OAuth applications only.). |
Scope |
Specifies the scope of the authenticating user's access to the application. Generally specified at the time the custom OAuth application is created (if necessary), so that the authenticating user can obtain the the level of access appropriate to their credentials. |
OAuthVerifier |
Specifies a verifier code returned from the OAuthAuthorizationURL . Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set. |
OAuthRefreshToken |
Specifies the OAuth refresh token used to request a new access token after the original has expired. |
OAuthExpiresIn |
Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working. |
OAuthTokenTimestamp |
Displays a Unix epoch timestamp in milliseconds that shows how long ago the current Access Token was created. |
| Property | Description |
|---|---|
SSLServerCert |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| 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. |
UseTypeaheadSearch |
Typeahead endpoint will be utilized to fetch the results for Projects, Tasks, Users and ProjectTemplates tables. |
Authentication
This section provides a complete list of authentication properties you can configure.
| Property | Description |
|---|---|
AuthScheme |
The type of authentication to use when connecting to Asana. |
AuthScheme
The type of authentication to use when connecting to Asana.
Possible Values
OAuth, OAuthPKCE
Data Type
string
Default Value
OAuth
Remarks
Current authentication methods supported for new apps:
- OAuth: Authenticates you using OAuth with a client ID and secret.
- OAuthPKCE: Authenticates you using OAuth with a client ID and secret and code challenge.
Connection
This section provides a complete list of connection properties you can configure.
| 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. |
ProjectId
The globally unique identifier (gid) associated with your Asana Project.
Data Type
string
Default Value
""
Remarks
Requests will return the data mapped under this project.
WorkspaceId
The globally unique identifier (gid) associated with your Asana Workspace.
Data Type
string
Default Value
""
Remarks
Requests will return the projects mapped under this WorkspaceId.
IncludeCustomFields
Custom fields may be added to the Tasks, SubTasks, and PortfolioItems tables.
Data Type
bool
Default Value
false
Remarks
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.
OAuth
This section provides a complete list of OAuth properties you can configure.
| Property | Description |
|---|---|
InitiateOAuth |
Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. |
OAuthClientId |
Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
OAuthClientSecret |
Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. |
OAuthAccessToken |
Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange. |
OAuthSettingsLocation |
Specifies the location of the settings file where OAuth values are saved. Storing OAuth settings in a central location avoids the need for users to enter OAuth connection properties manually each time they log in. It also enables credentials to be shared across connections or processes. |
CallbackURL |
Identifies the URL users return to after authenticating to Asana via OAuth. (Custom OAuth applications only.). |
Scope |
Specifies the scope of the authenticating user's access to the application. Generally specified at the time the custom OAuth application is created (if necessary), so that the authenticating user can obtain the the level of access appropriate to their credentials. |
OAuthVerifier |
Specifies a verifier code returned from the OAuthAuthorizationURL . Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set. |
OAuthRefreshToken |
Specifies the OAuth refresh token used to request a new access token after the original has expired. |
OAuthExpiresIn |
Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working. |
OAuthTokenTimestamp |
Displays a Unix epoch timestamp in milliseconds that shows how long ago the current Access Token was created. |
InitiateOAuth
Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.
Possible Values
OFF, REFRESH, GETANDREFRESH
Data Type
string
Default Value
OFF
Remarks
OAuth is an authorization framework that enables applications to obtain limited access to user accounts on an HTTP service. The OAuth flow defines the method to be used for logging in users, exchanging their credentials for an OAuth access token to be used for authentication, and providing limited access to applications.
Asana supports the following options for initiating OAuth access:
OFF: No automatic OAuth flow initiation. The OAuth flow is handled entirely by the user, who will take action to obtain their OAuthAccessToken. Note that with this setting the user must refresh the token manually and reconnect with an updated OAuthAccessToken property when the current token expires.GETANDREFRESH: The OAuth flow is handled entirely by the connector. If a token already exists, it is refreshed when necessary. If no token currently exists, it will be obtained by prompting the user to login.REFRESH: The user handles obtaining the OAuth Access Token and sets up the sequence for refreshing the OAuth Access Token. (The user is never prompted to log in to authenticate. After the user logs in, the connector handles the refresh of the OAuth Access Token.
OAuthClientId
Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
Data Type
string
Default Value
""
Remarks
This property is required when using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration. It is also required if an embedded OAuth application is not available for the driver. When an embedded OAuth application is available, this value may already be provided by the connector and not require manual entry.
This value is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.
OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can typically find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.
While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.
OAuthClientSecret
Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server.
Data Type
string
Default Value
""
Remarks
This property is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.
The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication will fail, and the server may return an invalid_client or unauthorized_client error.
OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application. It may be referred to as the client secret, application secret, or consumer secret.
This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments. Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.
OAuthAccessToken
Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.
Data Type
string
Default Value
""
Remarks
The OAuthAccessToken is a temporary credential that authorizes access to protected resources. It is typically returned by the identity provider after the user or client application completes an OAuth authentication flow. This property is most commonly used in automated workflows or custom OAuth implementations where you want to manage token handling outside of the driver.
The OAuth access token has a server-dependent timeout, limiting user access. This is set using the OAuthExpiresIn property. However, it can be reissued between requests to keep access alive as long as the user keeps working.
If InitiateOAuth is set to REFRESH, we recommend that you also set both OAuthExpiresIn and OAuthTokenTimestamp. The connector uses these properties to determine when the token expires so it can refresh most efficiently. If OAuthExpiresIn and OAuthTokenTimestamp are not specified, the connector refreshes the token immediately.
Access tokens should be treated as sensitive credentials and stored securely. Avoid exposing them in logs, scripts, or configuration files that are not access-controlled.
OAuthSettingsLocation
Specifies the location of the settings file where OAuth values are saved. Storing OAuth settings in a central location avoids the need for users to enter OAuth connection properties manually each time they log in. It also enables credentials to be shared across connections or processes.
Data Type
string
Default Value
%APPDATA%\Asana Data Provider\OAuthSettings.txt
Remarks
You can store OAuth values in a central file for shared access to those values, in either of the following ways:
- Set InitiateOAuth to either
GETANDREFRESHorREFRESHand specify a filepath to the OAuth settings file. - Use memory storage to load the credentials into static memory.
The following sections provide more detail on each of these methods.
Specifying the OAuthSettingsLocation Filepath
The default OAuth setting location is %APPDATA%\Asana Data Provider\OAuthSettings.txt, with %APPDATA% set to the user's configuration directory.
Default values vary, depending on the user's operating system.
Windows(ODBC and Power BI):registry://%DSN%Windows:%APPDATA%Asana Data Provider\OAuthSettings.txtMac:%APPDATA%//Asana Data Provider/OAuthSettings.txtLinux:%APPDATA%//Asana Data Provider/OAuthSettings.txt
Loading Credentials Via Memory Storage
Memory locations are specified by using a value starting with memory://, followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose, but it should be unique to the user.
Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again.
To retrieve OAuth property values, query the sys_connection_props system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.
Supported Storage Types
**memory://**:Stores OAuth tokens in-memory (unique identifier, shared within same process, etc.)**registry://**:Only supported in the Windows ODBC and Power BI editions. Stores OAuth tokens in the registry under the DSN settings. Must end in a DSN name likeregistry://Asana` connector Data Source`, orregistry://%DSN%``.%DSN%: The name of the DSN you are connecting with.Default(no prefix): Stores OAuth tokens within files. The value can be either an absolute path, or a path starting with%APPDATA%or%PROGRAMFILES%.
CallbackURL
Identifies the URL users return to after authenticating to Asana via OAuth. (Custom OAuth applications only.).
Data Type
string
Default Value
http://localhost:33333
Remarks
If you created a custom OAuth application, the OAuth authorization server redirects the user to this URL during the authentication process. This value must match the callback URL you specified when you Configured the custom OAuth application.
Scope
Specifies the scope of the authenticating user's access to the application. Generally specified at the time the custom OAuth application is created (if necessary), so that the authenticating user can obtain the the level of access appropriate to their credentials.
Data Type
string
Default Value
""
Remarks
Scopes are set to define what kind of access the authenticating user will have; for example, read, read and write, restricted access to sensitive information. System administrators can use scopes to selectively enable access by functionality or security clearance.
When InitiateOAuth is set to GETANDREFRESH, you must use this property if you want to change which scopes are requested. When InitiateOAuth is set to either REFRESH or OFF, you can use either this property or the Scope input to change which scopes are requested.
OAuthVerifier
Specifies a verifier code returned from the OAuthAuthorizationURL . Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set.
Data Type
string
Default Value
""
OAuthRefreshToken
Specifies the OAuth refresh token used to request a new access token after the original has expired.
Data Type
string
Default Value
""
Remarks
The refresh token is used to obtain a new access token when the current one expires. It enables seamless authentication for long-running or automated workflows without requiring the user to log in again. This property is especially important in headless, CI/CD, or server-based environments where interactive authentication is not possible.
The refresh token is typically obtained during the initial OAuth exchange by calling the GetOAuthAccessToken stored procedure. After that, it can be set using this property to enable automatic token refresh, or passed to the RefreshOAuthAccessToken stored procedure if you prefer to manage the refresh manually.
When InitiateOAuth is set to REFRESH, the driver uses this token to retrieve a new access token automatically. After the first refresh, the driver saves updated tokens in the location defined by OAuthSettingsLocation, and uses those values for subsequent connections.
The OAuthRefreshToken should be handled securely and stored in a trusted location. Like access tokens, refresh tokens can expire or be revoked depending on the identity provider’s policies.
OAuthExpiresIn
Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working.
Data Type
string
Default Value
""
Remarks
The OAuth Access Token is assigned to an authenticated user, granting that user access to the network for a specified period of time. The access token is used in place of the user's login ID and password, which stay on the server.
An access token created by the server is only valid for a limited time. OAuthExpiresIn is the number of seconds the token is valid from when it was created. For example, a token generated at 2024-01-29 20:00:00 UTC that expires at 2024-01-29 21:00:00 UTC (an hour later) would have an OAuthExpiresIn value of 3600, no matter what the current time is.
To determine how long the user has before the Access Token will expire, use OAuthTokenTimestamp.
OAuthTokenTimestamp
Displays a Unix epoch timestamp in milliseconds that shows how long ago the current Access Token was created.
Data Type
string
Default Value
""
Remarks
The OAuth Access Token is assigned to an authenticated user, granting that user access to the network for a specified period of time. The access token is used in place of the user's login ID and password, which stay on the server.
An access token created by the server is only valid for a limited time. OAuthTokenTimestamp is the Unix timestamp when the server created the token. For example, OAuthTokenTimestamp=1706558400 indicates the OAuthAccessToken was generated by the server at 2024-01-29 20:00:00 UTC.
SSL
This section provides a complete list of SSL properties you can configure.
| Property | Description |
|---|---|
SSLServerCert |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
SSLServerCert
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
Data Type
string
Default Value
""
Remarks
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.
Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
Schema
This section provides a complete list of schema properties you can configure.
| 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 . |
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.
Data Type
string
Default Value
%APPDATA%\Asana Data Provider\Schema
Remarks
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%\Asana Data Provider\Schema, where %APPDATA% is set to the user's configuration directory:
| Platform | %APPDATA% |
|---|---|
Windows |
The value of the APPDATA environment variable |
Mac |
~/Library/Application Support |
Linux |
~/.config |
BrowsableSchemas
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Data Type
string
Default Value
""
Remarks
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.
Tables
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC.
Data Type
string
Default Value
""
Remarks
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.
Views
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Data Type
string
Default Value
""
Remarks
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.
Miscellaneous
This section provides a complete list of miscellaneous properties you can configure.
| 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. |
UseTypeaheadSearch |
Typeahead endpoint will be utilized to fetch the results for Projects, Tasks, Users and ProjectTemplates tables. |
MaxRows
Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Data Type
int
Default Value
-1
Remarks
This property sets an upper limit on the number of rows the connector 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.
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.
Data Type
string
Default Value
""
Remarks
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.
Integration and Formatting
| Property | Description |
|---|---|
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=True |
Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time). |
RecordToFile=filename |
Records the underlying socket data transfer to the specified file. |
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.
Data Type
string
Default Value
""
Remarks
This property allows you to define which pseudocolumns the connector 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: "*=*"
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.
Data Type
int
Default Value
60
Remarks
This property controls the maximum time, in seconds, that the connector waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the connector 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 the timeout value 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.
UserDefinedViews
Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
Data Type
string
Default Value
""
Remarks
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 connector 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 connector.
Refer to User Defined Views for more information.
UseTypeaheadSearch
Typeahead endpoint will be utilized to fetch the results for Projects, Tasks, Users and ProjectTemplates tables.
Data Type
bool
Default Value
false
Remarks
- This property works with Projects, Tasks, Users and ProjectTemplates tables.
- With this property, only Name column is filterable supporting "=" and "LIKE" operators server side with limitation of supporting "starts with" with LIKE (LIKE 'abc%').
- The results are unstable with maximum limit of 100 and no pagination, so it does not guarantee complete result set.