CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるAsana へのアクセスを実現します。SQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してAsana に接続できます。
CData Cloud により、他のOData エンドポイントや標準SQL Server と同じように、Asana への接続を標準化し、構成することができます。
このページでは、CData Cloud でのAsana への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。
接続の確立 は、CData Cloud にデータベースを作成するためのAsana への認証方法と必要な接続プロパティの設定方法について示します。
利用可能な標準サービスを経由してAsana からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。
Database タブで対応するアイコンを選択して、Asana に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。
以下をオプションで設定して、Asana から返されたデータを絞り込むことができます。
Asana はOAuth またはOAuthPKCE 認証標準を利用しています。
AuthScheme は、すべてのユーザーアカウントフローでOAuth に設定する必要があります。
AuthScheme をOAuthPKCE に設定します。
詳しくは、Asana ドキュメントのpersonal access tokens とservice accounts を参照してください。
OAuthClientId、OAuthClientSecret、CallbackURL を取得するには、まずAsana アカウントにリンクされたアプリを作成する必要があります。
Asana アカウントにリンクされたアプリを作成するには:
新規アプリの作成が完了すると画面に表示されます。そこでView Client ID をクリックすると、新しく作成したアプリのOAuthClientId とOAuthClientSecret が表示されます。
これらの権限はアクセススコープによって定義され、アプリケーションがアクセス可能なデータと実行可能なアクションを決定します。
このトピックでは、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. |
エンドポイントドメインとは、アプリケーションが認証、レコードの取得、その他の重要な操作を実行するために通信する必要がある特定のURL を指します。
これらのドメインを許可することで、アプリケーションとAPI 間のネットワークトラフィックがファイアウォールやセキュリティ設定によってブロックされることがなくなります。
Note: ほとんどのユーザーは特別な設定をする必要はありません。許可リストは通常、送信ネットワークトラフィックの制限など、厳格なセキュリティ対策が施された環境でのみ必要となります。
| Domain | Always Required | Description |
| app.asana.com | TRUE | The domain of your Asana instance. |
デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。
別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。
HTTP プロキシへの認証には、以下のように設定します。
次のプロパティを設定します。
このセクションでは、利用可能なAPI オブジェクトを示し、Asana API へのSQL の実行について詳しく説明します。
ビュー では、利用可能なビューを説明します。ビューは、Projects、Users、Workspaces などを静的にモデル化するように定義されています。
ストアドプロシージャ は、Asana のファンクションライクなインターフェースです。ストアドプロシージャを使用すると、オブジェクトのダウンロードやエンベロープの移動など、Asana の操作を実行できます。
Cloud はAsana のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
| 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 the Portfolios table. |
| ProjectMembership | To create, delete and query memberships in the Project. |
| Projects | To Create, Update, Delete and Query the Projects table. |
| ProjectStatuses | To Create, Delete and Query from ProjectStatuses table. A project status is an update on the progress of a particular project, and is sent out to all project followers when created. |
| Sections | To Create, Update, Delete, and Query from Sections table. A section is a subdivision of a project that groups tasks together. |
| StatusUpdates | A status update is an update on the progress of a particular object, and is sent out to all followers when created. |
| Stories | To Create, Update, Delete and Query from stories table. A story represents an activity associated with an object in the Asana system. Stories are generated by the system whenever users take actions such as creating or assigning tasks, or moving tasks between projects. |
| SubTasks | To Create, update, delete, and query from SubTasks table. |
| Tags | To Create, Update and Query from Tags table. A tag is a label that can be attached to any task in Asana. It exists in a single workspace. |
| Tasks | To Create, Update, Delete and Query from Tasks table. |
| TaskTemplates | To delete and query the task templates. |
| TeamMembership | To represents a users connection to a team. |
| Teams | A team is used to group related projects and people together within an organization. Each project in an organization is associated with a team. |
| TimeTrackingEntries | Returns time tracking entries for a given task. |
| WorkspaceMembership | To create, delete and query memberships in the Workspace. |
| Workspaces | To Update and Query from Workspaces table. A workspace is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace. |
To Create, Update, Delete and Query the Allocations table.
The Cloud 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 Cloud.
For example, the following queries are processed server-side:
SELECT * FROM Allocations WHERE Id = '1127092449876457' SELECT * FROM Allocations WHERE Assignee = '1126938691750986' AND WorkspaceId = '1126938837961830' SELECT * FROM Allocations WHERE Parent = '1208149945266501'
StartDate, EndDate, Assignee and Parent are mandatory columns for inserting into the Allocations table. For example:
INSERT INTO Allocations (StartDate, EndDate, AssigneeId, ParentId, EffortType, EffortValue) VALUES ('2024-01-11', '2024-02-11', '1208125247305564', '1207717475644852', 'hours', 20)
The following is an example of how to update the Allocations table:
UPDATE Allocations SET StartDate = '2024-01-11', EndDate = '2024-02-11', Assignee = '1208125247305564', Parent = '1207717475644852', EffortType = 'hours', EffortValue = 20 WHERE Id = '12345'
The following is an example of how to delete from the Allocations table:
DELETE FROM Allocations WHERE Id = '1234'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the user. | |
| ResourceType | String | True |
The base type of this resource. | |
| StartDate | Date | False |
The localized day on which the allocation starts. | |
| EndDate | Date | False |
The localized day on which the allocation ends. | |
| EffortType | String | False |
The units used for tracking effort on an allocation, either 使用できる値は次のとおりです。hours, percent | |
| EffortValue | Integer | False |
The numeric effort value on the allocation. | |
| Assignee | String | False |
Users.Id |
Globally unique identifier of the resource, as a string. |
| AssigneeName | String | True |
The name of allocation resource. | |
| CreatedById | String | True |
Globally unique identifier of the resource, as a string. | |
| CreatedByName | String | True |
Read-only except when same user as requester. The user's name. | |
| Parent | String | False |
Projects.Id |
Globally unique identifier of the resource, as a string. |
| ParentName | String | True |
Name of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer. | |
| ResourceSubType | String | True |
The subtype of the allocation. | |
| WorkspaceId | String | True |
Workspaces.Id |
Globally unique ID of the workspace. |
To Delete and Query from the Attachments in the tasks.
The Cloud 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 Cloud.
For example, the following queries are processed server side:
SELECT * FROM Attachments WHERE Id = '1134618934491707' SELECT * FROM Attachments WHERE TaskId = '1128092964672854'
Following is an example of how to delete from Attachments table:
DELETE FROM Attachments WHERE Id = '1134618934491707'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the attachment. | |
| Name | String | True |
The name of the file. | |
| Host | String | True |
The service hosting the attachment. Valid values are asana, dropbox, gdrive and box. | |
| CreatedAt | Datetime | True |
The time at which this attachment was uploaded. | |
| ViewURL | String | True |
The URL where the attachment can be viewed, which may be friendlier to users in a browser than just directing them to a raw file. | |
| DownloadURL | String | True |
May be null if the attachment is hosted by box. If present, this URL may only be valid for 1 hour from the time of retrieval. You should avoid persisting this URL somewhere and just refresh it on demand to ensure you do not keep stale URLs. | |
| TaskId | String | True |
Tasks.Id |
The task this attachment is attached to. |
| ResourceType | String | True |
The resource type of this resource. | |
| ResourceSubtype | String | True |
The service hosting the attachment. Valid values are asana, dropbox, gdrive, onedrive, box, vimeo, and external. | |
| PermanentURL | String | True |
PermanentURL | |
| Size | Integer | True |
The size of the attachment in bytes. Only present when the resource_subtype is asana. | |
| ConnectedToApp | Boolean | True |
Whether the attachment is connected to the app making the request for the purposes of showing an app components widget. Only present when the resource_subtype is external or gdrive. |
To Create, Delete and Query memberships in the Goal.
The Cloud 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 Cloud.
For example, the following queries are processed server side:
SELECT * FROM GoalMembership SELECT * FROM GoalMembership WHERE Id = '1126938837961834' SELECT * FROM GoalMembership WHERE MemberId = '1126938837961830' SELECT * FROM GoalMembership WHERE GoalId = '1126938691750986'
GoalId and MemberId is a mandatory column for inserting into GoalMembership table. For example:
INSERT INTO GoalMembership (GoalId, MemberId) VALUES ('1161963899354167', '1126938837961830')
Following is an example of how to delete from GoalMembership table:
DELETE FROM GoalMembership WHERE Id = '1161963899354167'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique Id of the goal membership. | |
| GoalId | String | False |
Goals.Id |
Globally unique identifier for goal. |
| GoalName | String | True |
The name of the goal. | |
| GoalOwnerGid | String | True |
Globally unique identifier of the goal owner. | |
| GoalOwnerName | String | True |
The name of the goal owner. | |
| Role | String | True |
Describes if the member is a commenter or editor in goal. | |
| MemberId | String | False |
Globally unique identifier of the member of the goal. | |
| MemberName | String | True |
The name of the member. | |
| MemberResourceType | String | True |
The type of the member (team or user). | |
| ResourceSubtype | String | True |
The type of membership. | |
| ResourceType | String | True |
The base type of this resource. |
To Create, Update, Delete, and Query the Goals table.
The Cloud 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 Cloud.
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'
UserId and Goals is a mandatory column for inserting into Goals table. For example:
INSERT INTO Goals (Name, DueOn, StartOn, IsWorkspaceLevel, liked, WorkspaceId, OwnerId, TimePeriodId) VALUES ('Sample Goal', '2023-10-31', '2023-09-15', 'false', 'false', '1203124527069362', '1203124437606434', '1203124434984659' )
Inserting multiple Followers into Goals table. For example:
INSERT INTO Goals (Name, WorkspaceId, OwnerId, Followers) VALUES ('Sample Goal', '1203124527069362', '1203124437606434', '1206414724399714,1207035318501516' )
Following is an example of how to update a Goals table:
UPDATE Goals SET DueOn ='2023-10-20' WHERE Id = '1128092864672888'
Following is an example of how to delete from Goals table:
DELETE FROM Goals WHERE Id = '1161963899354167'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
Globally unique Id of the goal. | |
| ResourceType | String | True |
The base type of this resource. | |
| Name | String | False |
The name of the goal. | |
| OwnerId | String | False |
Globally unique Id of the owner. | |
| OwnerName | String | True |
The name of the owner. | |
| OwnerResourceType | String | True |
The base type of this resource. | |
| DueOn | Date | False |
The localized day on which this goal is due. | |
| StartOn | Date | False |
The day on which work for this goal begins. | |
| CurrentStatusUpdateId | String | True |
Globally unique identifier of the resource, as a string. | |
| CurrentStatusUpdateResourceSubtype | String | True |
The base type of this resource. | |
| CurrentStatusUpdateResourceType | String | True |
The subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning. | |
| CurrentStatusUpdateResourceTitle | String | True |
The title of the status update. | |
| Followers | String | False |
Array of users who are members of this goal. | |
| IsWorkspaceLevel | Boolean | False |
Whether the goal belongs to the workspace. | |
| Liked | Boolean | False |
True if the goal is liked by the authorized user, false if not. | |
| Likes | String | True |
Array of likes for users who have liked this goal. | |
| MetricId | String | True |
Globally unique identifier of the metric. | |
| MetricCurrencyCode | String | True |
ISO 4217 currency code to format this custom field. This will be null if the unit is not currency. | |
| MetricCurrentDisplayValue | String | True |
This string is the current value of a goal metric of type string. | |
| MetricCurrentNumberValue | Integer | True |
This number is the current value of a goal metric of type number. | |
| MetricInitialNumberValue | Integer | True |
This number is the start value of a goal metric of type number. | |
| MetricPrecision | Integer | True |
Only relevant for goal metrics of type 'Number'. This field dictates the number of places after the decimal to round to, i.e. 0 is integer values, 1 rounds to the nearest tenth, and so on. Must be between 0 and 6, inclusive. | |
| MetricProgressSource | String | True |
This field defines how the progress value of a goal metric is being calculated. | |
| MetricResourceSubtype | String | True |
The subtype of this resource. | |
| MetricResourceType | String | True |
The base type of this resource. | |
| MetricTargetNumberValue | Integer | True |
This number is the end value of a goal metric of type number. This number cannot equal initial_number_value. | |
| MetricUnit | String | True |
A supported unit of measure for the goal metric, or none. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| PortfolioId | String |
Globally unique identifier for supporting portfolio. |
| ProjectId | String |
Globally unique identifier for supporting project. |
To Create, delete, and Query Items in the Portfolio.
The Cloud 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 Cloud.
For example, the following queries are processed server side:
SELECT * FROM PortfolioItems WHERE PortfolioId = '1173026173301164'
ProjectId and PortfolioId is a mandatory column for inserting into PortfolioItems table. For example:
INSERT INTO PortfolioItems (ProjectId, PortfolioId) VALUES ('1173023668354420', '1173026173301164')
Following is an example of how to delete from PortfolioItems table:
DELETE FROM PortfolioItems WHERE ProjectId = '1173023668354420' AND PortfolioId = '1173026173301164'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the Portfolio Item. | |
| Name | String | True |
Name of the Item. | |
| PortfolioId [KEY] | String | True |
Portfolios.Id |
Globally unique ID of the portfolio. |
| OwnerId | String | True |
Globally unique ID of the Owner. | |
| StartOn | Date | True |
The day on which work for this project begins, or null if the project has no start date. | |
| DueOn | Date | True |
The day on which this project is due. This takes a date with format YYYY-MM-DD. | |
| ProjectId | String | True |
Projects.Id |
Globally unique ID of the Project. This column is a Pseudocolmn and its used for INSERT and UPDATE. |
To create, delete and query memberships in the Portfolio.
The Cloud 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 Cloud.
For example, the following queries are processed server side:
SELECT * FROM PortfolioMembership WHERE WorkspaceId = '1172686716695308' AND UserId = '1172686741877880' SELECT * FROM PortfolioMembership WHERE PortfolioId = '1172684730399265' SELECT * FROM PortfolioMembership WHERE Id = '1172684730399266'
PortfolioId and UserId is a mandatory column for inserting into PortfolioMembership table. For example:
INSERT INTO PortfolioMembership (PortfolioId, UserId) VALUES ('1172684730399265', '1172686741877880')
Following is an example of how to delete from PortfolioMembership table:
DELETE FROM PortfolioMembership WHERE PortfolioId = '1172684730399265' AND UserId = '1172686741877880'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the portfolio 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 user's 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 pseudocolumn and is used in SELECT queries. |
| AccessLevel | String | True |
Whether the member has admin, editor, or viewer access to the portfolio. Portfolios do not support commenter access yet. |
To create, update, delete, and query from the Portfolios table.
The Cloud 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 Cloud.
For example, the following queries are processed server side:
SELECT * FROM Portfolios WHERE WorkspaceId = '1172686716695308' AND OwnerId = '1172686741877880' SELECT * FROM Portfolios WHERE Id = '1172684730399265'
WorkspaceId is a mandatory column for inserting into Portfolios table. For example:
INSERT INTO Portfolios (Name, Color, WorkspaceId) VALUES ('Test', 'dark-pink', '1172686716695308'
Following is an example of how to update a Portfolios table:
"UPDATE Portfolios SET Name = 'IT-Test' WHERE Id = '1173026173301164'
Following is an example of how to delete from Portfolios table:
DELETE FROM Portfolios WHERE Id = '1172684730399265'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the portfolio. | |
| Name | String | False |
Name of the portfolio. | |
| Color | String | False |
Color of the portfolio. 使用できる値は次のとおりです。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 who created this portfolio. | |
| CreatorName | String | True |
The user's 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 owner's 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 in the 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 |
The value is '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 |
The value is '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. |
To create, delete and query memberships in the Project.
The Cloud 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 Cloud.
For example, the following queries are processed server side:
SELECT * FROM ProjectMembership WHERE Id = '1127092449876445' SELECT * FROM ProjectMembership WHERE ProjectId = '1127092449876444'
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.
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.
| 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. |
To Create, Update, Delete and Query the Projects table.
The Cloud 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 Cloud.
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'
WorkspaceId or TeamId is a mandatory column for inserting into Projects table. For example:
INSERT INTO Projects (Name, Color, StartOn, WorkspaceId, DueOn, public, UserId) VALUES ('ProjectName', 'dark-pink', '2020-03-01', '1126938837961830', '2020-04-30', false, '1130062547672468')
Inserting multiple Followers into Projects table. For example:
INSERT INTO Projects (WorkspaceId, Followers) VALUES ('1126938837961830', '1206414724399714,1207035318501516' )
Following is an example of how to update a Projects table:
UPDATE Projects SET TeamId = '1129514033997890' WHERE Id = '1128092864672888'
Following is an example of how to delete from Projects table:
DELETE FROM Projects WHERE Id = '1128092864672888'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the project. | |
| Name | String | False |
Name of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer. | |
| Color | String | False |
Color of the project. Must be either null or one of: dark-pink, dark-green, dark-blue, dark-red, dark-teal, dark-brown, dark-orange, dark-purple, dark-warm-gray, light-pink, light-green, light-blue, light-red, light-teal, light-yellow, light-orange, light-purple, light-warm-gray. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。admin, editor, commenter, viewer | |
| MinimumAccessLevelForCustomization | String | False |
The minimum access level needed for project members to modify this project's workflow and appearance. 使用できる値は次のとおりです。admin, editor | |
| MinimumAccessLevelForSharing | String | False |
The minimum access level needed for project members to share the project and manage project memberships. 使用できる値は次のとおりです。admin, editor | |
| Completed | Boolean | True |
True if the project is currently marked complete, false if not. | |
| CompletedAt | Datetime | True |
The time at which this project was completed, or null if the project is not completed. | |
| CompletedById | String | True |
Globally unique identifier of the resource, as a string. | |
| CompletedByResourceType | String | True |
The base type of this resource. | |
| CompletedByName | String | True |
Read-only except when same user as requester. The user's name. | |
| Icon | String | True |
The icon for a project. | |
| ProjectBriefId | String | True |
The project brief associated with this project. | |
| ProjectBriefResourceType | String | True |
The project brief associated with this project. | |
| CreatedFromTemplateId | String | True |
Id of the project template from which this project was created. If the project was not created from a template, this field will be null. | |
| CreatedFromTemplateResourceType | String | True |
Resource type of the project template from which this project was created. If the project was not created from a template, this field will be null. | |
| CreatedFromTemplateName | String | True |
Name of the project template from which this project was created. If the project was not created from a template, this field will be null. |
To Create, Delete and Query from ProjectStatuses table. A project status is an update on the progress of a particular project, and is sent out to all project followers when created.
The Cloud 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 Cloud.
For example, the following queries are processed server side:
SELECT * FROM ProjectStatuses WHERE Id = '1127092449876445' SELECT * FROM ProjectStatuses WHERE ProjectId = '1127092449876444'
ProjectId is a mandatory column for inserting into ProjectStatuses table. For example:
INSERT INTO projectstatuses (Color, Title, Text, ProjectId) VALUES ('red', 'Status1', 'StatusNotes', '1127092449876444')
Following is an example of how to delete from ProjectStatuses table:
DELETE FROM ProjectStatuses WHERE Id = '1127092449876445'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the project status update. | |
| Color | String | True |
The color associated with the status update. 使用できる値は次のとおりです。green, yellow, red | |
| Title | String | True |
The title of the project status update. | |
| Text | String | True |
The text content of the status update. | |
| CreatedAt | Datetime | True |
The time at which the status update was created. | |
| CreatedBy | String | True |
Users.Id |
The creator of the status update. |
| ProjectId | String | True |
Projects.Id |
Globally unique ID of the project. |
| ResourceType | String | True |
The resource type of this resource. The value for this resource is always project_status. | |
| HTMLText | String | True |
The notes of the project with formatting as HTML. |
To Create, Update, Delete, and Query from Sections table. A section is a subdivision of a project that groups tasks together.
The Cloud 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 Cloud.
For example, the following queries are processed server side:
SELECT * FROM Sections WHERE Id = '1127092449876457' SELECT * FROM Sections WHERE ProjectId = '1128092964672848'
ProjectId is a mandatory column for inserting into Sections table. For example:
INSERT INTO Sections (Name, ProjectId) VALUES ('SectionName', '1128092964672848')
Following is an example of how to update a Sections table:
UPDATE Sections SET Name = 'IT-Pending' WHERE Id = '1127092449876457'
Following is an example of how to delete from Sections table:
DELETE FROM Sections WHERE Id = '1127092449876457'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the section. | |
| Name | String | False |
The name of the section. | |
| CreatedAt | Datetime | True |
The time at which the section was created. | |
| ResourceType | String | True |
The resource type of this resource. | |
| ProjectId | String | False |
Projects.Id |
The section under the project. |
A status update is an update on the progress of a particular object, and is sent out to all followers when created.
The Cloud 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 Cloud.
For example, the following queries are processed server side:
SELECT * FROM StatusUpdates SELECT * FROM StatusUpdates WHERE Id = '1126938837961834' SELECT * FROM StatusUpdates WHERE ParentId = '1126938837961834'
Text, StatusType and ParentId are mandatory columns for inserting into StatusUpdates table. For example:
INSERT INTO StatusUpdates(ParentId,Title,Text,StatusType) VALUES('1203125557018928','asd','tewr','on_track')
Following is an example of how to delete from StatusUpdates table:
DELETE FROM StatusUpdates WHERE Id = '1161963899354167'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique identifier of the resource, as a string. | |
| AuthorId | String | True |
A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks. Globally unique identifier of the resource. | |
| AuthorName | String | True |
A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks. The user's name. | |
| AuthorResourceType | String | True |
A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks. The base type of this resource. | |
| CreatedAt | Datetime | True |
The time at which this resource was created. | |
| CreatedById | String | True |
A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks. Globally unique identifier of the resource. | |
| CreatedByName | String | True |
A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks. The user's name. | |
| CreatedByResourceType | String | True |
A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks. The base type of this resource. | |
| Liked | Boolean | True |
True if the status is liked by the authorized user, false if not. | |
| Likes | String | True |
Array of likes for users who have liked this status. | |
| ModifiedAt | Datetime | True |
The time at which this project status was last modified. | |
| NumLikes | Integer | True |
The number of users who have liked this status. | |
| ParentId | String | False |
Id of parent of the status update. | |
| ParentName | String | True |
Name of parent of the status update. | |
| ParentResourceType | String | True |
Resource type of parent of the status update. | |
| ResourceSubtype | String | True |
The subtype of this resource. | |
| ResourceType | String | True |
The base type of this resource. | |
| StatusType | String | False |
The type associated with the status update. 使用できる値は次のとおりです。on_track, at_risk, off_track, on_hold, complete, achieved, partial, missed, dropped | |
| Text | String | False |
The text content of the status update. | |
| HTMLText | String | False |
The text content of the status update with formatting as HTML. | |
| Title | String | False |
The title of the status update. |
To Create, Update, Delete and Query from stories table. A story represents an activity associated with an object in the Asana system. Stories are generated by the system whenever users take actions such as creating or assigning tasks, or moving tasks between projects.
The Cloud 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 Cloud.
For example, the following queries are processed server side:
SELECT * FROM Stories WHERE Id = '1126938691750986' SELECT * FROM Stories WHERE TaskId = '1129514033997892'
TaskId is a mandatory column for inserting into Stories table. For example:
INSERT INTO Stories (Text, TaskId, IsPinned) VALUES ('InProgress', '1129514033997892', false)
Following is an example of how to update a Stories table:
UPDATE Stories SET Text = 'story line' WHERE Id = '1126938691750986'
Following is an example of how to delete from Stories table:
DELETE FROM Stories WHERE Id = '1126938691750986'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the story. | |
| Text | String | False |
Formatted text for the story or comment. | |
| CreatedAt | Datetime | True |
The time at which this story was created. | |
| creatorId | String | True |
Users.Id |
The user who created the story. |
| creatorName | String | False |
Users.Name |
The user who created the story. |
| Source | String | True |
The component of the Asana product the user used to create the story. | |
| TaskId | String | False |
Tasks.Id |
The story under the task. |
| Liked | Boolean | True |
True if the story is liked by the authorized user, false if not. | |
| IsPinned | Boolean | False |
This field is only present on comment and attachment stories. | |
| IsEdited | Boolean | True |
Whether the text of the story has been edited after creation. | |
| ResourceType | String | True |
The resource type of this resource. | |
| ResourceSubType | String | True |
The type of story. This provides fine-grained information about what triggered the story creation. | |
| HtmlText | String | True |
HTML formatted text for a comment. | |
| DuplicateTaskOf | String | True |
Tasks.Id |
The task is the basic object around which many operations in Asana are centered. |
| DependencyTaskId | String | True |
Tasks.Id |
The task is the basic object around which many operations in Asana are centered. |
| NumberofLikes | Integer | True |
The number of users who have liked this story. | |
| Likes | String | True |
Array of likes for users who have liked this story. | |
| StickerName | String | False |
The name of the sticker in this story. null if there is no sticker. 使用できる値は次のとおりです。green_checkmark, people_dancing, dancing_unicorn, heart, party_popper, people_waving_flags, splashing_narwhal, trophy, yeti_riding_unicorn, celebrating_people, determined_climbers, phoenix_spreading_love | |
| Type | String | True |
Story type (comment or system) | |
| Previews | String | True |
A collection of previews to be displayed in the story. This property only exists for comment stories. | |
| OldName | String | True |
OldName | |
| NewName | String | True |
NewName | |
| OldDatesStartOn | Date | True |
The day on which work for this goal begins, or null if the goal has no start date. This takes a date with YYYY-MM-DD format, and cannot be set unless there is an accompanying due date. | |
| OldDatesDueAt | Datetime | True |
The UTC date and time on which this task is due, or null if the task has no due time. This takes an ISO 8601 date string in UTC and should not be used together with due_on. | |
| OldDatesDueOn | Date | True |
The localized day on which this goal is due. This takes a date with format YYYY-MM-DD. | |
| NewDatesStartOn | Date | True |
The day on which work for this goal begins, or null if the goal has no start date. This takes a date with YYYY-MM-DD format, and cannot be set unless there is an accompanying due date. | |
| NewDatesDueAt | Datetime | True |
The UTC date and time on which this task is due, or null if the task has no due time. This takes an ISO 8601 date string in UTC and should not be used together with due_on. | |
| NewDatesDueOn | Date | True |
The localized day on which this goal is due. This takes a date with format YYYY-MM-DD. | |
| OldResourceSubtype | String | True |
OldResourceSubtype | |
| NewResourceSubtype | String | True |
NewResourceSubtype | |
| StoryId | String | True |
Globally unique identifier of the resource, as a string. | |
| StoryResourceType | String | True |
The base type of this resource. | |
| StoryCreatedAt | Datetime | True |
The time at which this resource was created. | |
| StoryCreatedById | String | True |
Globally unique identifier of the resource, as a string. | |
| StoryCreatedByResourceType | String | True |
The base type of this resource. | |
| StoryCreatedByName | String | True |
Read-only except when same user as requester. The user's name. | |
| StoryResourceSubtype | String | True |
The subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning. | |
| StoryText | String | True |
Human-readable text for the story or comment. This will not include the name of the creator. This is not guaranteed to be stable for a given type of story. For example, text for a reassignment may not always say 'assigned to ...' as the text for a story can both be edited and change based on the language settings of the user making the request. Use the resource_subtype property to discover the action that created the story. | |
| AssigneeId | String | True |
Globally unique identifier of the resource, as a string. | |
| AssigneeResourceType | String | True |
The base type of this resource. | |
| AssigneeName | String | True |
Read-only except when same user as requester. The user's name. | |
| FollowerId | String | True |
Globally unique identifier of the resource, as a string. | |
| FollowerResourceType | String | True |
The base type of this resource. | |
| FollowerName | String | True |
Read-only except when same user as requester. The user's name. | |
| OldSectionId | String | True |
Globally unique identifier of the resource, as a string. | |
| OldSectionResourceType | String | True |
The base type of this resource. | |
| OldSectionName | String | True |
Read-only except when same user as requester. The user's name. | |
| NewSectionId | String | True |
Globally unique identifier of the resource, as a string. | |
| NewSectionResourceType | String | True |
The base type of this resource. | |
| NewSectionName | String | True |
Read-only except when same user as requester. The user's name. | |
| StoryTaskId | String | True |
Globally unique identifier of the resource, as a string. | |
| StoryTaskResourceType | String | True |
The base type of this resource. | |
| StoryTaskName | String | True |
The name of the task. | |
| TaskResourceSubtype | String | True |
The subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning. | |
| TaskCreatedById | String | True |
Globally unique identifier of the resource. | |
| TaskCreatedByResourceType | String | True |
The type of resource. | |
| ProjectId | String | True |
Globally unique identifier of the resource, as a string. | |
| ProjectResourceType | String | True |
The base type of this resource. | |
| ProjectName | String | True |
Name of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer. | |
| TagId | String | True |
Globally unique identifier of the resource, as a string. | |
| TagResourceType | String | True |
The base type of this resource. | |
| TagName | String | True |
Name of the tag. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer. | |
| CustomField | String | True |
CustomField | |
| OldTextValue | String | True |
OldTextValue | |
| NewTextValue | String | True |
NewTextValue | |
| OldNumberValue | Integer | True |
OldNumberValue | |
| NewNumberValue | Integer | True |
NewNumberValue | |
| OldEnumValue | String | True |
OldEnumValue | |
| NewEnumValue | String | True |
NewEnumValue | |
| OldDateValue | String | True |
OldDateValue | |
| NewDateValue | String | True |
NewDateValue | |
| OldPeopleValue | String | True |
OldPeopleValue | |
| NewPeopleValue | String | True |
NewPeopleValue | |
| OldMultiEnumValues | String | True |
OldMultiEnumValues | |
| NewMultiEnumValues | String | True |
NewMultiEnumValues | |
| NewApprovalStatus | String | True |
The new value of approval status. | |
| OldApprovalStatus | String | True |
The old value of approval status. | |
| DuplicateOf | String | True |
DuplicateOf |
To Create, update, delete, and query from SubTasks table.
The Cloud 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 Cloud.
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 Cloud will first query the
workspace to retrieve a list of projects. A separate request will then be made for each project to retrieve all the applicable tasks. Another request will be made for
each task to retrieve any subtasks associated with the task. In theory, this is similar to executing the following query:
SELECT * FROM SubTasks WHERE ParentTaskId IN (SELECT Id FROM Tasks WHERE ProjectId IN (SELECT Id FROM Projects))Due to the number of required requests, performance may be impacted.
ParentTaskId is a mandatory column for inserting into Projects table. For example:
INSERT INTO SubTasks (ParentTaskId, Name, Assignee, AssigneeStatus, startOn, DueOn, Completed, ProjectId, Notes, ApprovalStatus, Followers) VALUES ('1167713816822372', 'subtask1', '1167715005778471', 'later', '2020-03-25', '2020-04-01', false, 1167713816822364, 'SubTask Notes', 'changes_requested', '1167715005778471')
Inserting multiple Followers into SubTasks table. For example:
INSERT INTO SubTasks (ParentTaskId, Followers) VALUES ('1167713816822372', '1206414724399714,1207035318501516' )
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the Subtask. | |
| ParentTaskId | String | True |
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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。default_task, milestone, section, approval | |
| HtmlNotes | String | False |
The notes of the text with formatting as HTML. | |
| Dependencies | String | True |
Array of resources referencing tasks that this task depends on. | |
| Memberships | String | True |
Array of projects this task is associated with and the section it is in. | |
| Dependents | String | True |
Array of resources referencing tasks that depend on this task. | |
| Liked | Boolean | False |
True if the task is liked by the authorized user, false if not. | |
| NumberofLikes | Integer | True |
The number of users who have liked this Task. | |
| LikedBy | String | True |
Array of likes for users who have liked this task. | |
| ResourceType | String | True |
The base type of this resource. | |
| IsRenderedAsSeparator | Boolean | True |
In some contexts tasks can be rendered as a visual separator. | |
| Followers | String | False |
Array of users following this task. | |
| Tags | String | False |
Array of tags associated with this task. | |
| CreatedById | String | True |
Globally unique identifier of the resource. | |
| CreatedByResourceType | String | True |
The type of resource. | |
| NumSubTasks | Integer | True |
NumSubTasks. | |
| StartAt | Datetime | True |
StartAt. | |
| ActualTimeMinutes | Integer | True |
ActualTimeMinutes. | |
| AssigneeSection | String | True |
AssigneeSection. |
To Create, Update and Query from Tags table. A tag is a label that can be attached to any task in Asana. It exists in a single workspace.
The Cloud 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 Cloud.
For example, the following queries are processed server side:
SELECT * FROM Tags WHERE Id = '1129517083601713' SELECT * FROM Tags WHERE WorkspaceId = '1126938837961830' SELECT * FROM Tags WHERE TaskId = '1128092964672854'
Workspaceid is a mandatory column for inserting into Tags table. For example:
INSERT INTO Tags (Name, Color, WorkspaceId, Notes) VALUES ('TestTag', 'dark-blue', '1126938837961830', 'sample notes')
Following is an example of how to update a Tags table:
UPDATE Tags SET Name = 'IT-1' WHERE Id = '1158271967831255'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the tag. | |
| Name | String | True |
Name of the tag. | |
| CreatedAt | Datetime | True |
The time at which this tag was created. | |
| Color | String | True |
Color of the tag. 使用できる値は次のとおりです。dark-pink, dark-green, dark-blue, dark-red, dark-teal, dark-brown, dark-orange, dark-purple, dark-warm-gray, light-pink, light-green, light-blue, light-red, light-teal, light-brown, light-orange, light-purple, light-warm-gray | |
| Notes | String | False |
Notes of the tag. | |
| Followers | String | False |
Followers for the tag. | |
| WorkspaceId | String | True |
Workspaces.Id |
The workspace or organization this tag is associated with. |
| ResourceType | String | True |
The base type of this resource. | |
| TaskId | String | True |
Tasks.Id |
The task this tag is mapped with. |
To Create, Update, Delete and Query from Tasks table.
The Cloud 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 Cloud.
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 Cloud 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 Cloud 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'
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')
The following is an example of how to update the Tasks table:
UPDATE Tasks SET Browser = 'ie' WHERE Id = '1167713816822371'
The following is an example of how to delete from the Tasks table:
DELETE FROM Tasks WHERE Id = '1167713816822371'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the task. | |
| Name | String | False |
Name of the task. | |
| Assignee | String | False |
Users.Id |
User to which this task is assigned. |
| AssigneeStatus | String | False |
Scheduling status of this task for the user it is assigned to. 使用できる値は次のとおりです。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 |
The day on which work begins for the task , or null if the task has no start date. This takes a date with YYYY-MM-DD format and should not be used together with start_at. Note: due_on or due_at must be present in the request when setting or unsetting the start_on parameter. | |
| 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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. |
To delete and query the task templates.
The Cloud 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 Cloud.
For example, the following queries are processed server-side:
SELECT * FROM TaskTemplates WHERE Id = '1127092449876457' SELECT * FROM TaskTemplates WHERE ProjectId = '1208149945266501'
The following is an example of how to delete from the TaskTemplates table:
DELETE FROM TaskTemplates WHERE Id = '1234'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the user. | |
| ResourceType | String | True |
The base type of this resource. | |
| Name | String | True |
Name of the task template. | |
| ProjectId | String | True |
Projects.Id |
Globally unique identifier of the resource, as a string. |
| ProjectName | String | True |
Name of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer. | |
| TemplateName | String | True |
Globally unique identifier of the resource, as a string. | |
| TemplateTaskResourceSubtype | String | True |
The subtype of the task that will be created from this template. | |
| TemplateDescription | String | True |
Description of the task that will be created from this template. | |
| TemplateHTMLDescription | String | True |
HTML description of the task that will be created from this template. | |
| TemplateMemberships | String | True |
Array of projects that the task created from this template will be added to. | |
| TemplateRelativeStartOn | Integer | True |
The number of days after the task has been instantiated on which that the task will start. | |
| TemplateRelativeDueOn | Integer | True |
The number of days after the task has been instantiated on which that the task will be due. | |
| TemplateDueTime | 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 |
The user's name. Read-only except when the same user is the requester. | |
| CreatedAt | Datetime | True |
The time at which this task template was created. |
To represents a users connection to a team.
The Cloud 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 Cloud.
For example, the following queries are processed server side:
SELECT * FROM TeamMembership WHERE UserId = '1126938691750986' AND WorkspaceId = '1126938837961830' SELECT * FROM TeamMembership WHERE TeamId = '1126938837961832' SELECT * FROM TeamMembership WHERE Id = '1126938837961832'
UserId and TeamId is a mandatory column for inserting into TeamMembership table. For example:
INSERT INTO TeamMembership (UserId, TeamId) VALUES ('1161963899354167', '1126938837961832')
Following is an example of how to delete from TeamMembership table:
DELETE FROM TeamMembership WHERE UserId = '1161963899354167' AND TeamId = '1126938837961832'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique identifier of the resource, as a string. | |
| userId [KEY] | String | True |
Users.Id |
Globally unique ID of the user. |
| userName | String | True |
The users name. | |
| TeamId [KEY] | String | True |
Teams.Id |
Globally unique ID of the team. |
| TeamName | String | True |
The name of the team. | |
| IsGuest | Boolean | True |
Describes if the user is a guest in the team. | |
| ResourceType | String | True |
The base type of this resource. | |
| IsLimitedAccess | Boolean | True |
Describes if the user has limited access to the team. | |
| IsAdmin | Boolean | True |
Describes if the user is a team admin. | |
| WorkspaceId | String | True |
Workspaces.Id |
Globally unique ID of the workspace. |
A team is used to group related projects and people together within an organization. Each project in an organization is associated with a team.
The Cloud 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 Cloud.
For example, the following queries are processed server side:
SELECT * FROM Teams WHERE Id = '1126938837961832' SELECT * FROM Teams WHERE WorkspaceId = '1126938837961830' SELECT * FROM Teams WHERE UserId = '1126938691750986' AND workspaceid = '1126938837961830'
INSERT INTO Teams (Name, Description, HTMLDescrption, WorkspaceId) VALUES ('Salessssk', 'sales developers should be members of this team.', '<body> <em>All</em> developers should be members of this team.</body>', '1126938837961830')
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the team. | |
| Name | String | False |
The name of the team. | |
| Description | String | False |
The description of the team. | |
| WorkspaceId | String | True |
Workspaces.Id |
The workspace or organization this team is associated with. |
| HTMLDescrption | String | False |
The description of the team formatted 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. 使用できる値は次のとおりです。secret, request_to_join, public | |
| TeamContentManagementAccessLevel | String | False |
Controls who can create and share content with the team. 使用できる値は次のとおりです。no_restriction, only_team_admins | |
| EditTeamNameOrDescriptionAccessLevel | String | True |
Controls who can edit team name and description. 使用できる値は次のとおりです。all_team_members, only_team_admins | |
| EditTeamVisibilityOrTrashTeamAccessLevel | String | True |
Controls who can edit team visibility and trash teams. 使用できる値は次のとおりです。all_team_members, only_team_admins | |
| MemberInviteManagementAccessLevel | String | True |
Controls who can accept or deny member invites for a given team. 使用できる値は次のとおりです。all_team_members, only_team_admins | |
| GuestInviteManagementAccessLevel | String | True |
Controls who can accept or deny guest invites for a given team. 使用できる値は次のとおりです。all_team_members, only_team_admins | |
| JoinRequestManagementAccessLevel | String | True |
Controls who can accept or deny join team requests for a Membership by Request team. 使用できる値は次のとおりです。all_team_members, only_team_admins | |
| TeamMemberRemovalAccessLevel | String | True |
Controls who can remove team members. 使用できる値は次のとおりです。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. |
Returns time tracking entries for a given task.
The Cloud 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 Cloud.
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 Cloud will first query the
workspace to retrieve a list of projects. A separate request will then be made for each project to retrieve all the applicable tasks. Then requests to get time tracking entries on each task will be made. In theory, this is similar
to executing the following query:
SELECT * FROM TimeTrackingEntries WHERE TaskId IN (SELECT Id FROM Tasks)
TaskId is a mandatory column for inserting into TimeTrackingEntries table. For example:
INSERT INTO TimeTrackingEntries (TaskId, DurationMinutes, EnteredOn) VALUES ('1203125557018947', 3600, '2024-01-01')
Following is an example of how to update a TimeTrackingEntries table:
UPDATE TimeTrackingEntries SET DurationMinutes = 4000, EnteredOn = '2023-01-01' WHERE Id = '1208387811113769'
Following is an example of how to delete from TimeTrackingEntries table:
DELETE FROM TimeTrackingEntries WHERE Id = '1208387811113769'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the team. | |
| ResourceType | String | True |
The base type of this resource. | |
| CreatedBy | String | True |
A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks. | |
| CreatedByResourceType | String | True |
The base type of the CreatedBy user resource. | |
| CreatedByName | String | True |
The user's name. | |
| DurationMinutes | Integer | False |
Time in minutes tracked by the entry. | |
| EnteredOn | Date | False |
The day that this entry is logged on. | |
| CreatedAt | Datetime | True |
The time at which this resource was created. | |
| TaskId | String | False |
The associated Task's object Id. The task is the basic object around which many operations in Asana are centered. | |
| TaskResourceType | String | True |
The base type of the Task resource. | |
| TaskName | String | True |
The name of the task. | |
| TaskResourceSubtype | String | True |
The subtype of the Task resource. |
To create, delete and query memberships in the Workspace.
The Cloud 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 Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkspaceMembership WHERE WorkspaceId = '1126938837961830' SELECT * FROM WorkspaceMembership WHERE UserId = '1126938691750986' SELECT * FROM WorkspaceMembership WHERE Id = '1126938837961834'
UserId and WorkspaceId is a mandatory column for inserting into WorkspaceMembership table. For example:
INSERT INTO WorkspaceMembership (UserId, WorkspaceId) VALUES ('1161963899354167', '1126938837961830')
Following is an example of how to delete from WorkspaceMembership table:
DELETE FROM WorkspaceMembership WHERE UserId = '1161963899354167' AND WorkspaceId = '1126938837961830'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique Id of the membership. | |
| userId [KEY] | String | True |
Users.Id |
Globally unique Id of the user. |
| userName | String | True |
The user's name. | |
| WorkspaceId [KEY] | String | True |
Workspaces.Id |
Globally unique Id of the workspace. |
| WorkspaceName | String | True |
The workspace name. | |
| IsActive | Boolean | True |
Reflects if this user still a member of the workspace. | |
| IsAdmin | Boolean | True |
Reflects if this user is an admin of the workspace. | |
| IsGuest | Boolean | True |
Reflects if this user is a guest of the workspace. | |
| UserTaskListId | String | True |
UserTaskList.Id |
A user task list represents the tasks assigned to a particular user. |
| ResourceType | String | True |
The base type of this resource. | |
| VacationStartDate | String | True |
The day on which the user's vacation in this workspace starts. | |
| VacationEndDate | String | True |
The day on which the user's vacation in this workspace ends. | |
| CreatedAt | Datetime | True |
The time at which this resource was created. | |
| IsViewOnly | Boolean | True |
Reflects if this user has a view-only license in the workspace. |
To Update and Query from Workspaces table. A workspace is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace.
The Cloud 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 Cloud.
For example, the following queries are processed server side:
SELECT * FROM Workspaces WHERE Id = '1126938837961835' SELECT * FROM Workspaces WHERE UserId = '1126938691750986'
Following is an example of how to update a Workspaces table:
UPDATE Workspaces SET Name = 'IT-Eng' WHERE Id = '1126938837961835'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Globally unique ID of the workspace. | |
| Name | String | False |
The name of the workspace. | |
| ResourceType | String | True |
The resource type of this resource. | |
| IsOrganization | Boolean | True |
Whether the workspace is an organization. | |
| EmailDomains | String | True |
Whether the workspace is an organization. | |
| ItemURL | String | True |
A url that points directly to the object within Asana. | |
| UserId | String | True |
Users.Id |
Globally unique ID of the user. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| 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. |
To view the Custom Fields in the project or workspace.
The Cloud 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 Cloud.
For example, the following query is processed server side:
SELECT * FROM CustomFields WHERE ProjectId = '1126938691750986'
| Name | Type | References | Description |
| Id | String | Globally unique identifier of the resource. | |
| Name | String | The name of the custom field. | |
| Description | String | The description of the custom field. | |
| Type | String | The type of the custom field. It must be one of the given values. | |
| ProjectId | String |
Projects.Id | Globally unique Id of the project. |
| ProjectName | String | Name of the project. | |
| IsImportant | Boolean | Name of the project. | |
| Format | String | The format of the custom field. | |
| Precision | Integer | Only relevant for custom fields of type 'Number'. This field specifies the number of digits after the decimal to round to. | |
| CurrencyCode | String | The currency code for this custom field. This will be null if the format is not currency. | |
| EnumOptions | String | Array of projects this task is associated with and the section it is in. | |
| CreatedBy | String | Globally unique user identifier. | |
| CreatedByName | String | The user's name. | |
| IsGlobaltoWorkspace | Boolean | A boolean flag that specifies whether this custom field is available to every container in the workspace. | |
| HasNotificationsEnabled | Boolean | A boolean flag that specifies whether a follower of a task with this field should receive inbox notifications about changes in this field. | |
| WorkspaceId | String |
Workspaces.Id | Globally unique ID of the workspace. |
To view the events in projects and tasks.
The Cloud 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 Cloud.
For example, the following queries are processed server side:
SELECT * FROM Events WHERE ResourceId = '1128092964672854'
| Name | Type | References | Description |
| ResourceId [KEY] | String | The resource GID for the events were requested for. | |
| ResourceType | String | The resource type for the events were requested for. | |
| ResourceSubType | String | The resource sub type for the events were requested for. | |
| ResourceName | String | The resource name for the events were requested for. | |
| Parent | String | For added/removed events, the parent that resource was added to or removed from. null for other event types. | |
| CreatedAt | Datetime | The timestamp when the event occurred. | |
| UserId | String | The event may be triggered by a different user GID than the subscriber. | |
| UserFullname | String | The event may be triggered by a different user name than the subscriber. | |
| Action | String | The type of action taken that triggered the event. | |
| ChangeField | String | The name of the field that has changed in the resource. | |
| ChangeAction | String | The type of action taken on the field which has been changed. This can be one of changed, added, or removed depending on the nature of the change. | |
| ChangeNewValue | String | This property is only present when the value of the event's change.action is changed and the new_value is an Asana resource. This will be only the gid and resource_type of the resource when the events come from webhooks. | |
| ChangeAddedValue | String | This property is only present when the value of the event's change.action is added and the added_value is an Asana resource. This will be only the gid and resource_type of the resource when the events come from webhooks. | |
| ChangeRemovedValue | String | This property is only present when the value of the event's change.action is removed and the removed_value is an Asana resource. This will be only the gid and resource_type of the resource when the events come from webhook. |
To view the Project follower details.
| Name | Type | References | Description |
| ProjectId | String |
Projects.Id | Globally unique ID of the Project. |
| UserId | String |
Users.Id | Globally unique ID of the user. |
| UserName | String | The user`s name. | |
| ResourceType | String | The resource type of this resource. | |
| WorkspaceId | String |
Workspaces.Id | The workspace this Project is associated with. |
TO get ProjectTemplates in the Team or workspace.
The Cloud 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 Cloud.
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'
| 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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| WorkspaceId | String | The workspace Id to filter results on. |
To query all of the dependencies of a task.
The Cloud 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 Cloud.
For example, the following queries are processed server-side:
SELECT * FROM TaskDependencies WHERE TaskId = '1208618397035168'
| Name | Type | References | Description |
| Id [KEY] | String | Globally unique ID of the task. | |
| Name | String | Name of the task. | |
| Assignee | String |
Users.Id | User to which this task is assigned. |
| AssigneeStatus | String | Scheduling status of this task for the user it is assigned to.
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。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. |
To query all of the dependents of a task.
The Cloud 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 Cloud.
For example, the following queries are processed server-side:
SELECT * FROM TaskDependents WHERE TaskId = '1208618397035168'
| Name | Type | References | Description |
| Id [KEY] | String | Globally unique ID of the task. | |
| Name | String | Name of the task. | |
| Assignee | String |
Users.Id | User to which this task is assigned. |
| AssigneeStatus | String | Scheduling status of this task for the user it is assigned to.
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。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. |
Get task count of a project.
The Cloud 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 Cloud.
For example, the following queries are processed server side:
SELECT * FROM TaskStatuses WHERE ProjectId = '1136437449978157'
| Name | Type | References | Description |
| ProjectId | String |
Projects.Id | Globally unique ID of the project. |
| NumberofTasks | Integer | The number of tasks in a project. | |
| CompletedTasks | Integer | The number of completed tasks in a project. | |
| IncompleteTasks | Integer | The number of incomplete tasks in a project. | |
| NumberofMilestones | Integer | The number of milestones in a project. | |
| CompletedMilestones | Integer | The number of completed milestones in a project. | |
| InCompleteMilestones | Integer | The number of incomplete milestones in a project. |
To query time period records or full record for a single time period.
The Cloud 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 Cloud.
For example, the following queries are processed server-side:
SELECT * FROM TimePeriods where Id = '1200585294122707' SELECT * FROM TimePeriods where WorkspaceId = '1126938837961835'
| Name | Type | References | Description |
| Id [KEY] | String | Globally unique ID of the user. | |
| ResourceType | String | The base type of this resource. | |
| EndOn | String | The localized end date of the time period in YYYY-MM-DD format. | |
| StartOn | String | The localized start date of the time period in YYYY-MM-DD format. | |
| Period | String | The cadence and index of the time period. The value is one of: FY, H1, H2, Q1, Q2, Q3, or Q4. | |
| DisplayName | String | A string representing the cadence code and the fiscal year. | |
| ParentId | String | Globally unique ID of the user. | |
| ParentResourceType | String | The base type of this resource. | |
| ParentEndOn | String | The localized end date of the time period in YYYY-MM-DD format. | |
| ParentStartOn | String | The localized start date of the time period in YYYY-MM-DD format. | |
| ParentPeriod | String | The cadence and index of the time period. The value is one of: FY, H1, H2, Q1, Q2, Q3, or Q4. | |
| ParentDisplayName | String | A string representing the cadence code and the fiscal year. | |
| WorkspaceId | String |
Workspaces.Id | Globally unique ID of the workspace. |
To view the users details.
The Cloud 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 Cloud.
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'
| Name | Type | References | Description |
| Id [KEY] | String | Globally unique ID of the user. | |
| Name | String | The user`s name. | |
| String | The user`s email address. | ||
| ResourceType | String | The resource type of this resource. | |
| WorkspaceId [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. |
Generated schema file.
The Cloud 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 Cloud.
For example, the following queries are processed server side:
SELECT * FROM UserTaskList WHERE Id = '1126938837961837' SELECT * FROM UserTaskList WHERE UserId = '1126938691750986' AND workspaceId = '1126938837961830'
| Name | Type | References | Description |
| Id [KEY] | String |
WorkspaceMembership.UserTaskListId | Globally unique ID of the user task list. |
| Name | String | The name of the user task list. | |
| UserId | String |
Users.Id | The owner of the user task list. |
| workspaceId | String |
Workspaces.Id | The workspace in which the user task list is located. |
| ResourceType | String | The resource type of this resource. |
ストアドプロシージャはファンクションライクなインターフェースで、Asana の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにAsana から関連するレスポンスデータを返します。
| 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. |
| DuplicateProject | To create a duplicate copy of the project. |
| DuplicateTask | To Set or Unlink dependencies to the task. |
| InstantiateTaskFromTemplate | Creates a task from the task template. |
| MoveSectionsinProject | To reorder the section in the project. |
| 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. |
To set of tasks as dependencies of this task, if they are not already dependencies. A task can have at most 15 dependencies.
| 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(,). |
| Name | Type | Description |
| Status | String | The status of the operation. |
To Set or Unlink dependents to the task.
| 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(,). |
| Name | Type | Description |
| Status | String | The status of the operation. |
To add followers to the tasks or projects.
| 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.
使用できる値は次のとおりです。projects, tasks |
| Name | Type | Description |
| Status | String | The status of the operation. |
Add a project to a task.
| 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. |
| Name | Type | Description |
| Status | String | The status of the operation. |
To Set or Unlink dependents to the task.
| Name | Type | Required | Description |
| TaskId | String | True | The Tasks Id to operate on. |
| TagId | String | True | Tags Id to add in the task. |
| Name | Type | Description |
| Status | String | The status of the operation. |
Add a task to a specific, existing section. This will remove the task from other sections of the project.
| 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. |
| Name | Type | Description |
| Status | String | The status of the operation. |
To create a duplicate copy of the project.
| 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. |
| Name | Type | Description |
| Status | String | The status of the operation. |
To Set or Unlink dependencies to the task.
| 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(,). |
| Name | Type | Description |
| Status | String | The status of the operation. |
Creates a task from the task template.
| Name | Type | Required | Description |
| TaskTemplateId | String | True | Globally unique identifier for the task template. |
| Name | String | True | The name of the new task. |
| 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. |
To reorder the section in the project.
| 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. |
| Name | Type | Description |
| Status | String | The status of the operation. |
To Set or Unlink dependencies to the task.
| 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(,). |
| Name | Type | Description |
| Status | String | The status of the operation. |
To Set or Unlink dependents to the task.
| 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(,). |
| Name | Type | Description |
| Status | String | The status of the operation. |
To remove followers from the tasks or projects.
| 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.
使用できる値は次のとおりです。projects, tasks |
| Name | Type | Description |
| Status | String | The status of the operation. |
Remove a project from a task.
| 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. |
| Name | Type | Description |
| Status | String | The status of the operation. |
To Set or Unlink dependents to the task.
| Name | Type | Required | Description |
| TaskId | String | True | The Tasks Id to operate on. |
| TagId | String | True | Tags Id to remove from the task. |
| Name | Type | Description |
| Status | String | The status of the operation. |
To Set the parent of a task.
| 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. |
| Name | Type | Description |
| Status | String | The status of the operation. |
このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。
以下のテーブルは、Asana のデータベースメタデータを返します。
以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。
次のテーブルは、データ変更クエリ(バッチ処理を含む)のクエリ統計を返します。
利用可能なデータベースをリストします。
次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。
SELECT * FROM sys_catalogs
| Name | Type | Description |
| CatalogName | String | データベース名。 |
利用可能なスキーマをリストします。
次のクエリは、すべての利用可能なスキーマを取得します。
SELECT * FROM sys_schemas
| Name | Type | Description |
| CatalogName | String | データベース名。 |
| SchemaName | String | スキーマ名。 |
利用可能なテーブルをリストします。
次のクエリは、利用可能なテーブルおよびビューを取得します。
SELECT * FROM sys_tables
| Name | Type | Description |
| CatalogName | String | テーブルまたはビューを含むデータベース。 |
| SchemaName | String | テーブルまたはビューを含むスキーマ。 |
| TableName | String | テーブル名またはビュー名。 |
| TableType | String | テーブルの種類(テーブルまたはビュー)。 |
| Description | String | テーブルまたはビューの説明。 |
| IsUpdateable | Boolean | テーブルが更新可能かどうか。 |
利用可能なテーブルおよびビューのカラムについて説明します。
次のクエリは、projects テーブルのカラムとデータ型を返します。
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='projects'
| Name | Type | Description |
| CatalogName | String | テーブルまたはビューを含むデータベースの名前。 |
| SchemaName | String | テーブルまたはビューを含むスキーマ。 |
| TableName | String | カラムを含むテーブルまたはビューの名前。 |
| ColumnName | String | カラム名。 |
| DataTypeName | String | データ型の名前。 |
| DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
| Length | Int32 | カラムのストレージサイズ。 |
| DisplaySize | Int32 | 指定されたカラムの通常の最大幅(文字数)。 |
| NumericPrecision | Int32 | 数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ(文字数)。 |
| NumericScale | Int32 | カラムのスケール(小数点以下の桁数)。 |
| IsNullable | Boolean | カラムがNull を含められるかどうか。 |
| Description | String | カラムの簡単な説明。 |
| Ordinal | Int32 | カラムのシーケンスナンバー。 |
| IsAutoIncrement | String | カラムに固定増分値が割り当てられるかどうか。 |
| IsGeneratedColumn | String | 生成されたカラムであるかどうか。 |
| IsHidden | Boolean | カラムが非表示かどうか。 |
| IsArray | Boolean | カラムが配列かどうか。 |
| IsReadOnly | Boolean | カラムが読み取り専用かどうか。 |
| IsKey | Boolean | sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。 |
| ColumnType | String | スキーマ内のカラムの役割または分類。可能な値は、SYSTEM、LINKEDCOLUMN、NAVIGATIONKEY、REFERENCECOLUMN、およびNAVIGATIONPARENTCOLUMN が含まれます。 |
利用可能なストアドプロシージャをリストします。
次のクエリは、利用可能なストアドプロシージャを取得します。
SELECT * FROM sys_procedures
| Name | Type | Description |
| CatalogName | String | ストアドプロシージャを含むデータベース。 |
| SchemaName | String | ストアドプロシージャを含むスキーマ。 |
| ProcedureName | String | ストアドプロシージャの名前。 |
| Description | String | ストアドプロシージャの説明。 |
| ProcedureType | String | PROCEDURE やFUNCTION などのプロシージャのタイプ。 |
ストアドプロシージャパラメータについて説明します。
次のクエリは、UploadAttachment ストアドプロシージャのすべての入力パラメータについての情報を返します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'UploadAttachment' AND Direction = 1 OR Direction = 2
パラメータに加えて結果セットのカラムを含めるには、IncludeResultColumns 擬似カラムをTrue に設定します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'UploadAttachment' AND IncludeResultColumns='True'
| Name | Type | Description |
| CatalogName | String | ストアドプロシージャを含むデータベースの名前。 |
| SchemaName | String | ストアドプロシージャを含むスキーマの名前。 |
| ProcedureName | String | パラメータを含むストアドプロシージャの名前。 |
| ColumnName | String | ストアドプロシージャパラメータの名前。 |
| Direction | Int32 | パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。 |
| DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
| DataTypeName | String | データ型の名前。 |
| NumericPrecision | Int32 | 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。 |
| Length | Int32 | 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。 |
| NumericScale | Int32 | 数値データの小数点以下の桁数。 |
| IsNullable | Boolean | パラメータがNull を含められるかどうか。 |
| IsRequired | Boolean | プロシージャの実行にパラメータが必要かどうか。 |
| IsArray | Boolean | パラメータが配列かどうか。 |
| Description | String | パラメータの説明。 |
| Ordinal | Int32 | パラメータのインデックス。 |
| Values | String | このパラメータで設定できる値は、このカラムに表示されるものに限られます。指定できる値はカンマ区切りです。 |
| SupportsStreams | Boolean | パラメータがファイルを表すかどうか。ファイルは、ファイルパスとして渡すことも、ストリームとして渡すこともできます。 |
| IsPath | Boolean | パラメータがスキーマ作成操作のターゲットパスかどうか。 |
| Default | String | 何も値が指定されていない場合に、このパラメータで使用される値。 |
| SpecificName | String | 複数のストアドプロシージャが同じ名前を持つ場合、それぞれの同名のストアドプロシージャを一意に識別するラベル。特定の名前を持つプロシージャが1つだけの場合は、その名前がここに単純に反映されます。 |
| IsCDataProvided | Boolean | プロシージャがネイティブのAsana プロシージャではなく、CData によって追加 / 実装されているかどうか。 |
| Name | Type | Description |
| IncludeResultColumns | Boolean | 出力にパラメータに加えて結果セットのカラムを含めるかどうか。デフォルトはFalse です。 |
主キーおよび外部キーについて説明します。
次のクエリは、projects テーブルの主キーを取得します。
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='projects'
| Name | Type | Description |
| CatalogName | String | キーを含むデータベースの名前。 |
| SchemaName | String | キーを含むスキーマの名前。 |
| TableName | String | キーを含むテーブルの名前。 |
| ColumnName | String | キーカラムの名前 |
| IsKey | Boolean | カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。 |
| IsForeignKey | Boolean | カラムがTableName フィールドで参照される外部キーかどうか。 |
| PrimaryKeyName | String | 主キーの名前。 |
| ForeignKeyName | String | 外部キーの名前。 |
| ReferencedCatalogName | String | 主キーを含むデータベース。 |
| ReferencedSchemaName | String | 主キーを含むスキーマ。 |
| ReferencedTableName | String | 主キーを含むテーブル。 |
| ReferencedColumnName | String | 主キーのカラム名。 |
外部キーについて説明します。
次のクエリは、他のテーブルを参照するすべての外部キーを取得します。
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
| 名前 | タイプ | 説明 |
| CatalogName | String | キーを含むデータベースの名前。 |
| SchemaName | String | キーを含むスキーマの名前。 |
| TableName | String | キーを含むテーブルの名前。 |
| ColumnName | String | キーカラムの名前 |
| PrimaryKeyName | String | 主キーの名前。 |
| ForeignKeyName | String | 外部キーの名前。 |
| ReferencedCatalogName | String | 主キーを含むデータベース。 |
| ReferencedSchemaName | String | 主キーを含むスキーマ。 |
| ReferencedTableName | String | 主キーを含むテーブル。 |
| ReferencedColumnName | String | 主キーのカラム名。 |
| ForeignKeyType | String | 外部キーがインポート(他のテーブルを指す)キーかエクスポート(他のテーブルから参照される)キーかを指定します。 |
主キーについて説明します。
次のクエリは、すべてのテーブルとビューから主キーを取得します。
SELECT * FROM sys_primarykeys
| Name | Type | Description |
| CatalogName | String | キーを含むデータベースの名前。 |
| SchemaName | String | キーを含むスキーマの名前。 |
| TableName | String | キーを含むテーブルの名前。 |
| ColumnName | String | キーカラムの名前。 |
| KeySeq | String | 主キーのシーケンス番号。 |
| KeyName | String | 主キーの名前。 |
利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。
次のクエリは、主キーでないすべてのインデックスを取得します。
SELECT * FROM sys_indexes WHERE IsPrimary='false'
| Name | Type | Description |
| CatalogName | String | インデックスを含むデータベースの名前。 |
| SchemaName | String | インデックスを含むスキーマの名前。 |
| TableName | String | インデックスを含むテーブルの名前。 |
| IndexName | String | インデックス名。 |
| ColumnName | String | インデックスに関連付けられたカラムの名前。 |
| IsUnique | Boolean | インデックスが固有の場合はTrue。そうでない場合はFalse。 |
| IsPrimary | Boolean | インデックスが主キーの場合はTrue。そうでない場合はFalse。 |
| Type | Int16 | インデックスタイプに対応する整数値:statistic (0)、clustered (1)、hashed (2)、またはother (3)。 |
| SortOrder | String | 並べ替え順序:A が昇順、D が降順。 |
| OrdinalPosition | Int16 | インデックスのカラムのシーケンスナンバー。 |
利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。
次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。
SELECT * FROM sys_connection_props WHERE Value <> ''
| Name | Type | Description |
| Name | String | 接続プロパティ名。 |
| ShortDescription | String | 簡単な説明。 |
| Type | String | 接続プロパティのデータ型。 |
| Default | String | 明示的に設定されていない場合のデフォルト値。 |
| Values | String | 可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。 |
| Value | String | 設定した値またはあらかじめ設定されたデフォルト。 |
| Required | Boolean | プロパティが接続に必要かどうか。 |
| Category | String | 接続プロパティのカテゴリ。 |
| IsSessionProperty | String | プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。 |
| Sensitivity | String | プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。 |
| PropertyName | String | キャメルケースの短縮形の接続プロパティ名。 |
| Ordinal | Int32 | パラメータのインデックス。 |
| CatOrdinal | Int32 | パラメータカテゴリのインデックス。 |
| Hierarchy | String | このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。 |
| Visible | Boolean | プロパティが接続UI に表示されるかどうかを通知します。 |
| ETC | String | プロパティに関するその他のさまざまな情報。 |
Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。
SQL 構文の詳細については、SQL 準拠 を参照してください。
以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。
| 名前 | 説明 | 有効な値 |
| AGGREGATE_FUNCTIONS | サポートされている集計関数。 | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
| COUNT | COUNT 関数がサポートされているかどうか。 | YES, NO |
| IDENTIFIER_QUOTE_OPEN_CHAR | 識別子をエスケープするための開始文字。 | [ |
| IDENTIFIER_QUOTE_CLOSE_CHAR | 識別子をエスケープするための終了文字。 | ] |
| SUPPORTED_OPERATORS | サポートされているSQL 演算子。 | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
| GROUP_BY | GROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。 | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
| OJ_CAPABILITIES | サポートされている外部結合の種類。 | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
| OUTER_JOINS | 外部結合がサポートされているかどうか。 | YES, NO |
| SUBQUERIES | サブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。 | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
| 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 | サポートされている数値関数。 | 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 | サポートされている日付および時刻関数。 | 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 | レプリケーション中にスキップされたテーブルを示します。 | |
| REPLICATION_TIMECHECK_COLUMNS | レプリケーション中に更新判断のカラムとして使用するかどうかを、(指定された順に)チェックするカラムのリストを含む文字列の配列。 | |
| IDENTIFIER_PATTERN | 識別子としてどの文字列が有効かを示す文字列値。 | |
| SUPPORT_TRANSACTION | プロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。 | YES, NO |
| DIALECT | 使用するSQL ダイアレクトを示します。 | |
| KEY_PROPERTIES | Uniform データベースを特定するプロパティを示します。 | |
| SUPPORTS_MULTIPLE_SCHEMAS | プロバイダー用に複数のスキームが存在するかどうかを示します。 | YES, NO |
| SUPPORTS_MULTIPLE_CATALOGS | プロバイダー用に複数のカタログが存在するかどうかを示します。 | YES, NO |
| DATASYNCVERSION | このドライバーにアクセスするために必要な、CData Sync のバージョン。 | Standard, Starter, Professional, Enterprise |
| DATASYNCCATEGORY | このドライバーのCData Sync カテゴリ。 | Source, Destination, Cloud Destination |
| SUPPORTSENHANCEDSQL | API で提供されている以上の、追加SQL 機能がサポートされているかどうか。 | TRUE, FALSE |
| SUPPORTS_BATCH_OPERATIONS | バッチ操作がサポートされているかどうか。 | YES, NO |
| SQL_CAP | このドライバーでサポートされているすべてのSQL 機能。 | 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 | 使用したいcacheOptions を指定する文字列値。 | |
| ENABLE_EF_ADVANCED_QUERY | ドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。 | YES, NO |
| PSEUDO_COLUMNS | 利用可能な疑似カラムを示す文字列の配列。 | |
| MERGE_ALWAYS | 値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。 | TRUE, FALSE |
| REPLICATION_MIN_DATE_QUERY | レプリケート開始日時を返すSELECT クエリ。 | |
| REPLICATION_MIN_FUNCTION | サーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。 | |
| REPLICATION_START_DATE | レプリケート開始日を、プロバイダーが指定できるようになります。 | |
| REPLICATION_MAX_DATE_QUERY | レプリケート終了日時を返すSELECT クエリ。 | |
| REPLICATION_MAX_FUNCTION | サーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。 | |
| IGNORE_INTERVALS_ON_INITIAL_REPLICATE | 初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。 | |
| CHECKCACHE_USE_PARENTID | CheckCache 構文を親キーカラムに対して実行するかどうかを示します。 | TRUE, FALSE |
| CREATE_SCHEMA_PROCEDURES | スキーマファイルの生成に使用できる、ストアドプロシージャを示します。 |
次のクエリは、WHERE 句で使用できる演算子を取得します。
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。
| Name | Type | Description |
| NAME | String | SQL 構文のコンポーネント、またはサーバー上で処理できる機能。 |
| VALUE | String | サポートされるSQL またはSQL 構文の詳細。 |
試行された変更に関する情報を返します。
次のクエリは、バッチ処理で変更された行のId を取得します。
SELECT * FROM sys_identity
| Name | Type | Description |
| Id | String | データ変更処理から返された、データベース生成Id。 |
| Batch | String | バッチの識別子。1 は単一処理。 |
| Operation | String | バッチ内の処理の結果:INSERTED、UPDATED、またはDELETED。 |
| Message | String | SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。 |
利用可能なシステム情報を説明します。
次のクエリは、すべてのカラムを取得します。
SELECT * FROM sys_information
| Name | Type | Description |
| Product | String | 製品名。 |
| Version | String | 製品のバージョン番号。 |
| Datasource | String | 製品が接続するデータソースの名前。 |
| NodeId | String | 製品がインストールされているマシンの固有識別子。 |
| HelpURL | String | 製品のヘルプドキュメントのURL。 |
| License | String | 製品のライセンス情報。(この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。) |
| Location | String | 製品のライブラリが格納されているファイルパスの場所。 |
| Environment | String | 製品が現在稼働している環境またはランタイムのバージョン。 |
| DataSyncVersion | String | 本コネクタを使用するために必要なCData Sync のティア。 |
| DataSyncCategory | String | CData Sync 機能のカテゴリ(例:Source、Destination)。 |
| プロパティ | 説明 |
| AuthScheme | The type of authentication to use when connecting to Asana. |
| プロパティ | 説明 |
| 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. |
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。 |
| OAuthClientSecret | カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ) |
| Scope | データへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。 |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| Verbosity | ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。 |
| プロパティ | 説明 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| プロパティ | 説明 |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
| UseTypeaheadSearch | Typeahead endpoint will be utilized to fetch the results for Projects, Tasks, Users and ProjectTemplates tables. |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| AuthScheme | The type of authentication to use when connecting to Asana. |
The type of authentication to use when connecting to Asana.
string
"OAuth"
Current authentication methods supported for new apps:
このセクションでは、本プロバイダーの接続文字列で設定可能なConnection プロパティの全リストを提供します。
| プロパティ | 説明 |
| ProjectId | The globally unique identifier (gid) associated with your Asana Project. |
| WorkspaceId | The globally unique identifier (gid) associated with your Asana Workspace. |
| IncludeCustomFields | Custom fields may be added to the Tasks, SubTasks, and PortfolioItems tables. |
The globally unique identifier (gid) associated with your Asana Project.
string
""
Requests will return the data mapped under this project.
The globally unique identifier (gid) associated with your Asana Workspace.
string
""
Requests will return the projects mapped under this WorkspaceId.
Custom fields may be added to the Tasks, SubTasks, and PortfolioItems tables.
bool
false
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 プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。 |
| OAuthClientSecret | カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ) |
| Scope | データへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。 |
カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
string
""
このプロパティは2つのケースで必要となります:
(ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにCloud によって設定されており、手動で入力する必要がないことがあります。)
OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。
OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。
クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。
接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。
カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
string
""
このプロパティ(アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます)は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。
クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。
OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。
Notes:
接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。
データへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。
string
""
スコープは、認証ユーザーがどのようなアクセス権を持つかを定義するために設定されます。例えば、読み取り、読み取りと書き込み、機密情報への制限付きアクセスなどです。システム管理者は、スコープを使用して機能またはセキュリティクリアランスによるアクセスを選択的に有効化できます。
InitiateOAuth がGETANDREFRESH に設定されている場合、要求するスコープを変更したい場合はこのプロパティを使用する必要があります。
InitiateOAuth がREFRESH またはOFF のいずれかに設定されている場合、このプロパティまたはScope 入力を使用して、要求するスコープを変更できます。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
string
""
TLS/SSL 接続を使用している場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。このプロパティに値を指定すると、マシンによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります:
| 説明 | 例 |
| フルPEM 証明書(例では省略されています) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| 証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
| 公開鍵(例では省略されています) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| MD5 Thumbprint(hex 値はスペースまたはコロン区切り) | ecadbdda5a1529c58a1e9e09828d70e4 |
| SHA1 Thumbprint(hex 値はスペースまたはコロン区切り) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
Note:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
| プロパティ | 説明 |
| Verbosity | ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。 |
ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。
string
"1"
このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。
デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。
LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
string
""
利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
| UseTypeaheadSearch | Typeahead endpoint will be utilized to fetch the results for Projects, Tasks, Users and ProjectTemplates tables. |
集計やGROUP BY を含まないクエリで返される最大行数を指定します。
int
-1
このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。)
MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。
テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
string
""
このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。
個々の擬似カラムを指定するには、以下の形式を使用します。
Table1=Column1;Table1=Column2;Table2=Column3
すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください:
*=*
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
int
60
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。
タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。
Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。
Typeahead endpoint will be utilized to fetch the results for Projects, Tasks, Users and ProjectTemplates tables.
bool
false
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.