はじめに

このページでは、CData Cloud でのBacklog への接続の確立のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

Backlog への接続

接続の確立は、CData Cloud にデータベースを作成するためのBacklog への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してBacklog からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメントで詳しく説明します。

接続の確立

Database タブで対応するアイコンを選択して、Backlog に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

Backlog への認証

認証方法にはAPI キーとOAuth があります。

API キー

AuthScheme をAPIToken に設定します。

ApiKey を取得するには：

Backlog の個人設定ページを開きます。
API セクションをクリックして、「メモ」にAPI キーについての説明を追加し、登録ボタンをクリックします。トークンが生成されます。
ApiKey にAPI キーを指定します。
URL 接続プロパティには、Backlog のテナントURL を使用します。

OAuth

すべてのユーザーアカウントフローでAuthScheme をOAuth に設定する必要があります。

ヘッドレスマシン

ヘッドレスマシンのユーザーアカウントでOAuth を使用するようにドライバーを設定するには、インターネットブラウザに対応した別の端末で認証する必要があります。

以下のオプションから選択します。
- オプション1：後述の「Verifier code を取得および交換」に従い、OAuthVerifier 値を取得します。
- オプション2：インターネットブラウザに対応したマシンにCloud をインストールし、後述の「OAuth 設定を転送」の説明に従い、通常のブラウザベースのフローで認証後にOAuth 認証値を転送します。
次に、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするようにCloud を設定します。

オプション1：Verifier code を取得および交換

Verifier code を取得するには、OAuth Authorization URL で認証する必要があります。

インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。

以下のプロパティを設定し、認証URL を作成します。
- InitiateOAuth：OFF に設定。
- OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
- OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
次に、適切なCallbackURL を指定してGetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。
ログインして、Cloud にアクセス許可を与えます。すると、verifier code を含むコールバックURL にリダイレクトされます。
verifier code の値を保存します。後ほどこれをOAuthVerifier 接続プロパティに設定します。

次に、OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換する必要があります。次のプロパティを設定します。

ヘッドレスマシンでは、次の接続プロパティを設定してOAuth 認証値を取得します。

InitiateOAuth：REFRESH に設定。
OAuthVerifier：verifier code に設定。
OAuthClientId：（カスタムアプリのみ）カスタムOAuth アプリケーション設定のクライアントId に設定。
OAuthClientSecret：カスタムOAuth アプリケーション設定のクライアントシークレットに設定。
OAuthSettingsLocation：これを設定すると、暗号化されたOAuth 認証値が指定された場所に永続化されます。

OAuth 設定ファイルが生成されたら、以下のように接続プロパティをリセットする必要があります。

InitiateOAuth：REFRESH に設定。
OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
OAuthSettingsLocation：暗号化されたOAuth 認証値を含む場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所がCloud に読み書きのアクセス許可を与えることを確認してください。

オプション2：OAuth 設定を転送

ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバとの接続を作成し、インストールする必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。

「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定された場所に暗号化されて書き込まれます。デフォルトのファイル名はOAuthSettings.txt です。

接続テストに成功したら、OAuth 設定ファイルをヘッドレスマシンにコピーします。

ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。

InitiateOAuth：REFRESH に設定。
OAuthClientId：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントId に設定。
OAuthClientSecret：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
OAuthSettingsLocation：OAuth 設定ファイルの場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所がCloud に読み書きのアクセス許可を与えることを確認してください。

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

ProxyServer：HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort：プロキシサーバーが起動しているTCP ポート。
ProxyAuthScheme：プロキシサーバーに対して認証する際にCloud が使用する認証方法。
ProxyUser：プロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword：ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
接続をトンネルするには、FirewallType をTUNNEL に設定します。
認証するには、FirewallUser とFirewallPassword を設定します。
SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

データモデル

概要

このセクションでは、利用可能なAPI オブジェクトを示し、Backlog API へのSQL の実行について詳しく説明します。

主要機能

Cloud はドキュメント、フォルダ、およびグループなどのBacklog エンティティをリレーショナルビューとしてモデル化し、SQL を記述してBacklog データをクエリできるようにします。
ストアドプロシージャを使用するとBacklog の操作を実行できます。
これらのオブジェクトへのライブ接続により、Cloud を使用するとBacklog アカウントへのあらゆる変更が即座に反映されます。

ビュー

ビューでは、利用可能なビューを説明します。ビューは、Teams、Users、TeamMembers などを静的にモデル化するように定義されています。

テーブル

テーブルでは、利用可能なテーブルを説明します。テーブルは、Projects、Issues、WikiPages などを静的にモデル化するように定義されています。

ストアドプロシージャ

ストアドプロシージャは、Backlog のファンクションライクなインターフェースです。ストアドプロシージャを使用すると、オブジェクトのダウンロードやエンベロープの移動など、Backlog の操作を実行できます。

テーブル

Cloud はBacklog のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

CData Cloud - Backlog テーブル


Name	Description
IssueAttachments	Returns data from issue attachments table.
IssueComments	Returns data from issue comments table.
IssueLinkedSharedFiles	Returns data from issue linked shared files table.
Issues	Returns data from issues table.
ProjectAdministrators	Returns data from project administrators table.
ProjectCategories	Returns data from project categories table.
ProjectCustomFieldItems	Returns data from project custom field items table.
ProjectCustomFields	Returns data from project custom fields table.
ProjectIssueTypes	Returns data from project issue types table.
Projects	Returns data from projects table.
ProjectStatuses	Returns data from project statuses table.
ProjectTeams	Returns data from project teams table.
ProjectUsers	Returns data from project users table.
ProjectVersionMilestones	Returns data from project version milestones table.
PullRequestAttachments	Returns data from pull request attachments table.
PullRequestComments	Returns data from pull request comments table.
PullRequests	Returns data from project pull requests table.
Watchings	Returns data from watchings table.
WikiPageAttachments	Gets list of files attached to Wiki.
WikiPages	Returns data from wiki pages table.

IssueAttachments

Returns data from issue attachments table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはIssueId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

IssueId は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM IssueAttachments WHERE IssueId = 6840954

INSERT

INSERT は、このテーブルではサポートされていません。

Update

UPDATE は、このテーブルではサポートされていません。

Delete

削除は、IssueId AND ID を指定することで実行できます。

DELETE FROM IssueAttachments WHERE IssueId = 6840954 AND Id = 3470553

Columns


Name	Type	ReadOnly	Description
IssueId [KEY]	Int	False
Id [KEY]	Int	False
Name	String	False
Size	Int	False
Created	Datetime	False
CreatedById	Int	False
CreatedByUserId	String	False
CreatedByName	String	False
CreatedByKeyword	String	False
CreatedByRoleType	Int	False
CreatedByLanguage	String	False
CreatedByMailAddress	String	False
CreatedByNulabAccountName	String	False
CreatedByNulabId	String	False
CreatedByNulabAccountUniqueId	String	False

IssueComments

Returns data from issue comments table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはIssueId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

Id は'=' をサポートしています。
IssueId は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM IssueComments WHERE IssueId = 6840954
SELECT * FROM IssueComments WHERE IssueId = 6840954 AND Id = 39040604

Insert

挿入は、IssueId およびContent を指定することで実行できます。

INSERT INTO IssueComments (IssueId, Content) VALUES ('6840954', 'Sample Comment')

Update

UPDATE IssueComments SET Content = 'Third' WHERE IssueId = 6840954 AND Id = 39042035"

Delete

削除は、IssueId AND ID を指定することで実行できます。

DELETE FROM IssueComments WHERE IssueId = 6840954 AND Id = 39042338

Columns


Name	Type	ReadOnly	Description
IssueId [KEY]	Int	False
Id [KEY]	Int	False
Content	String	False
Created	Datetime	False
Updated	Datetime	False
CreatedById	Int	False
CreatedByUserId	String	False
CreatedByName	String	False
CreatedByRoleType	Int	False
CreatedByLanguage	String	False
CreatedByMailAddress	String	False
CreatedByNulabAccountName	String	False
CreatedByNulabId	String	False
CreatedByNulabAccountUniqueId	String	False

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
NotifiedUserId	String
AttachmentId	String

IssueLinkedSharedFiles

Returns data from issue linked shared files table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはIssueId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

IssueId は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM IssueLinkedSharedFiles WHERE IssueId = 6840954

Insert

挿入は、IssueId およびId を指定することで実行できます。

INSERT INTO IssueLinkedSharedFiles (IssueId, Id) VALUES ('6840954', '5597286')

Update

UPDATE は、このテーブルではサポートされていません。

Delete

削除は、IssueId AND ID を指定することで実行できます。

DELETE FROM IssueLinkedSharedFiles WHERE IssueId = 6840954 AND Id = 5597286

Columns


Name	Type	ReadOnly	Description
IssueId [KEY]	Int	False
Id [KEY]	Int	False
Name	String	True
Size	Int	True
Type	String	True
Dir	String	True
Created	Datetime	True
CreatedById	Int	True
CreatedByUserId	String	True
CreatedByName	String	True
CreatedByKeyword	String	True
CreatedByRoleType	Int	True
CreatedByLanguage	String	True
CreatedByMailAddress	String	True
CreatedByNulabAccountName	String	True
CreatedByNulabId	String	True
CreatedByNulabAccountUniqueId	String	True
Updated	Datetime	True
UpdatedById	Int	True
UpdatedByUserId	String	True
UpdatedByName	String	True
UpdatedByKeyword	String	True
UpdatedByRoleType	Int	True
UpdatedByLanguage	String	True
UpdatedByMailAddress	String	True
UpdatedByNulabAccountName	String	True
UpdatedByNulabId	String	True
UpdatedByNulabAccountUniqueId	String	True

Issues

Returns data from issues table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でCloud 内部で処理されます。

Id は'=, IN' をサポートしています。
ProjectId は'=, IN' をサポートしています。
StatusId は'=, IN' をサポートしています。
ResolutionId は'=, IN'をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM Issues WHERE ID = 6840954
SELECT * FROM Issues WHERE ID IN (6840954, 6840954)
SELECT * FROM Issues WHERE ProjectId = 112873
SELECT * FROM Issues WHERE ProjectId IN (112873, 6840954)
SELECT * FROM Issues WHERE StatusId = 1
SELECT * FROM Issues WHERE StatusId IN (112873, 6840954)
SELECT * FROM Issues WHERE ResolutionId = 0
SELECT * FROM Issues WHERE ResolutionId IN (0, 3)

Insert

挿入は、ProjectId、Summary、PriorityId、およびIssueTypeId を指定することで実行できます。

INSERT INTO Issues (ProjectId, Summary, PriorityId, IssueTypeId) VALUES (114706, 'Summary', 3, 530959)

Update

UPDATE Issues SET Summary = 'UPDATED_KEY23', ParentIssueId = '6700745', Comment = 'test' WHERE Id = 6700474

Delete

削除は、IssueId AND ID を指定することで実行できます。

DELETE FROM Issues WHERE IssueId = 6840954 AND Id = 3470553

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Int	False
ProjectId	Int	False
IssueKey	String	False
KeyId	Int	False
ParentIssueId	Int	False
Summary	String	False
Description	String	False
CustomAttributes	String	False
StartDate	Date	False
DueDate	Date	False
ActualHours	Decimal	False
EstimatedHours	Decimal	False
Created	Datetime	False
CreatedByUserName	String	False
CreatedByUserId	String	False
Updated	Datetime	False
UpdatedByUserName	String	False
UpdatedByUserId	String	False
ResolutionId	Int	False
ResolutionName	String	False
PriorityId	Int	False
PriorityName	String	False
IssueTypeId	Int	False
IssueTypeName	String	False
IssueTypeProjectId	Int	False
IssueTypeColor	String	False
IssueTypeDisplayOrder	Int	False
StatusId	Int	False
StatusProjectId	Int	False
StatusName	String	False
StatusColor	String	False
StatusDisplayOrder	Int	False
AssigneeId	Int	False
AssigneeName	String	False
AssigneeRoleType	Int	False
AssigneeLanguage	String	False
AssigneeMailAddress	String	False

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
Category	String
Version	String
Milestone	String
ParentChild	Int	使用できる値は次のとおりです。0, 1, 2, 3, 4
Attachment	Boolean
SharedFile	Boolean
CreatedSince	String
CreatedUntil	String
UpdatedSince	String
UpdatedUntil	String
StartDateSince	String
StartDateUntil	String
DueDateSince	String
DueDateUntil	String
Keyword	String
Comment	String

ProjectAdministrators

Returns data from project administrators table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

ProjectId は'=' をサポートします。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM ProjectAdministrators WHERE ProjectId = 114706

Insert

挿入は、ProjectId およびUserId を指定することで実行できます。

INSERT INTO ProjectAdministrators (ProjectId, UserId) VALUES ('114706', '280728')

Update

UPDATE は、このテーブルではサポートされていません。

Delete

削除は、ProjectId AND UserId を指定することで実行できます。

DELETE FROM ProjectAdministrators WHERE ProjectId = 114706 AND UserId = 280728

Columns


Name	Type	ReadOnly	Description
ProjectId [KEY]	Int	False
UserId [KEY]	Int	False
UserCode	String	False
Name	String	False
Keyword	String	False
NulabAccountName	String	False
NulabId	String	False
NulabAccountUniqueId	String	False
RoleType	Int	False
Language	String	False
MailAddress	String	False

ProjectCategories

Returns data from project categories table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

ProjectId は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM ProjectCategories WHERE ProjectId = 114706

Insert

挿入は、ProjectId およびName を指定することで実行できます。

INSERT INTO ProjectCategories (ProjectId, Name) VALUES ('114706', 'cat4')

Update

UPDATE ProjectCategories SET Name = 'Sample' WHERE ProjectId = 114706 AND Id = 205625

Delete

削除は、IssueId AND ID を指定することで実行できます。

DELETE FROM ProjectCategories WHERE ProjectId = 114706 AND Id = 205622

Columns


Name	Type	ReadOnly	Description
ProjectId [KEY]	Int	False
Id [KEY]	Int	False
Name	String	False
DisplayOrder	Int	False

ProjectCustomFieldItems

Returns data from project custom field items table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

ProjectId は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM ProjectCustomFieldItems WHERE ProjectId = 114706

Insert

挿入は、ProjectId、CustomFieldId およびName を指定することで実行できます。

INSERT INTO ProjectCustomFieldItems (ProjectId, CustomFieldId, Name) VALUES ('114706', '44072', 'Fourth')

Update

UPDATE ProjectCustomFieldItems SET Name = 'Fourth4' WHERE ProjectId = 114706 AND CustomFieldId = 44072 AND ItemId = 4

Delete

削除は、IssueId AND ID を指定することで実行できます。

DELETE FROM ProjectCustomFieldItems WHERE ProjectId = 114706 AND CustomFieldId = 44072 AND ItemId = 5

Columns


Name	Type	ReadOnly	Description
ProjectId [KEY]	Int	False
Id [KEY]	Int	False
DisplayOrder	String	True
Name	String	False
ItemId [KEY]	Int	False
ItemName	String	False
ItemDisplayOrder	String	True

ProjectCustomFields

Returns data from project custom fields table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

ProjectId は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM ProjectCustomFields WHERE ProjectId = 114706

Insert

挿入は、ProjectId、typeId およびName を指定することで実行できます。

INSERT INTO ProjectCustomFields (ProjectId, Name, typeId) VALUES ('114706', 'Milestone4', 1)

Update

UPDATE ProjectCustomFields SET Name = 'Third' WHERE ProjectId = 114706 AND Id = 44203

Delete

削除は、IssueId AND ID を指定することで実行できます。

DELETE FROM ProjectCustomFields WHERE ProjectId = 114706 AND Id = 44204

Columns


Name	Type	ReadOnly	Description
ProjectId [KEY]	Int	False
Id [KEY]	Int	False
TypeId	String	False
Name	String	False
Description	String	False
Required	Booelan	False
AllowAddItem	Booelan	False
UseIssueType	Booelan	False
ApplicableIssueTypes	String	False
DisplayOrder	String	False

ProjectIssueTypes

Returns data from project issue types table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

ProjectId は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM ProjectIssueTypes WHERE ProjectId = 114706

Insert

挿入は、ProjectId、Color およびName を指定することで実行できます。

INSERT INTO ProjectIssueTypes (ProjectId, Name, Color) VALUES ('114706', 'Sample', '#ff9200')

Update

UPDATE ProjectIssueTypes SET Name = 'ytryet43' WHERE ProjectId = 114706 AND Id = 532089

Columns


Name	Type	ReadOnly	Description
ProjectId [KEY]	Int	False
Id [KEY]	Int	False
Name	String	False
Color	String	False
DisplayOrder	Int	True
TemplateSummary	String	False
TemplateDescription	String	False

Projects

Returns data from projects table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でCloud 内部で処理されます。

Id は'=' をサポートしています。
ProjectKey は'=' をサポートしています。
All は'=' をサポートしています。
Archived は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM Projects WHERE Id = 114706
SELECT * FROM Projects WHERE ProjectKey = 'SAMPLE_KEY'
SELECT * FROM Projects WHERE All = true
SELECT * FROM Projects WHERE Archived = false

Insert

挿入は、Name、ProjectKey、chartEnabled、projectLeaderCanEditProjectLeader、subtaskingEnabled、textFormattingRule、ProjectLeaderCanEditProjectLeader、UseDevAttributes およびUseWikiTreeView を指定することで実行できます。

INSERT INTO Projects (Name, ProjectKey, chartEnabled, projectLeaderCanEditProjectLeader, subtaskingEnabled, textFormattingRule, ProjectLeaderCanEditProjectLeader, UseDevAttributes, UseWikiTreeView) VALUES ('InsertedName', 'INSERTED_KEY_3', false, true, true, markdown, true, false, false)

Update

UPDATE Projects SET ProjectKey = 'UPDATED_KEY2', Name = 'UpdatedName2' WHERE Id = 112873

Delete

削除は、ID を指定することで実行できます。

DELETE FROM Projects WHERE Id = 113332

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Int	False
ProjectKey	String	False
Name	String	False
DisplayOrder	Int	False
ChartEnabled	Boolean	False
SubtaskingEnabled	Boolean	False
ProjectLeaderCanEditProjectLeader	Boolean	False
UseDevAttributes	Boolean	False
UseWikiTreeView	Boolean	False
TextFormattingRule	String	False
Archived	Boolean	False
useResolvedForChart	Boolean	False
useWiki	Boolean	False
useFileSharing	Boolean	False
useOriginalImageSizeAtWiki	Boolean	False

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
All	Boolean

ProjectStatuses

Returns data from project statuses table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

ProjectId は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM ProjectStatuses WHERE ProjectId = 114706

Insert

挿入は、ProjectId およびColor を指定することで実行できます。
Color カラムに指定可能な値は#ea2c00、#e87758 、#e07b9a、#868cb7、#3b9dbd、#4caf93、#b0be3c、#eda62a、#f42858、#393939 です。

INSERT INTO ProjectStatuses (ProjectId, Name, Color) VALUES ('117182', 'Sample', '#3b9dbd')

Update

UPDATE ProjectStatuses SET Name = 'Sample', color = '#ea2c00' WHERE ProjectId = 114706 AND Id = 18504

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Int	False
ProjectId [KEY]	Int	False
Name	String	False
Color	String	False
DisplayOrder	Int	True

ProjectTeams

Returns data from project teams table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

ProjectId は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM ProjectTeams WHERE ProjectId = 114706

Insert

挿入は、ProjectId およびTeamId を指定することで実行できます。

INSERT INTO ProjectTeams (ProjectId, TeamId) VALUES ('114706', '55083')

Update

UPDATE は、このテーブルではサポートされていません。

Delete

削除は、IssueId AND ID を指定することで実行できます。

DELETE FROM ProjectTeams WHERE ProjectId = 114706 AND TeamId = 55082

Columns


Name	Type	ReadOnly	Description
ProjectId [KEY]	Int	False
TeamId [KEY]	Int	False
Name	String	True
DisplayOrder	Int	True
Created	Datetime	True
CreatedById	Int	True
CreatedByUserId	String	True
CreatedByName	String	True
CreatedByRoleType	Int	True
CreatedByLang	String	True
CreatedByMailAddress	String	True
Updated	Datetime	True
UpdatedById	Int	True
UpdatedByUserId	String	True
UpdatedByName	String	True
UpdatedByRoleType	Int	True
UpdatedByLang	String	True
UpdatedByMailAddress	String	True

ProjectUsers

Returns data from project users table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

ProjectId は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM ProjectUsers WHERE ProjectId = 114706

Insert

挿入は、ProjectId およびUserId を指定することで実行できます。

INSERT INTO ProjectUsers (ProjectId, UserId) VALUES ('114706', '280728')

Update

UPDATE は、このテーブルではサポートされていません。

Delete

削除は、ProjectId AND UserId を指定することで実行できます。

DELETE FROM ProjectUsers WHERE ProjectId = 114706 AND UserId = 280728

Columns


Name	Type	ReadOnly	Description
ProjectId [KEY]	Int	False
UserId [KEY]	Int	False
UserCode	String	False
Name	String	False
Keyword	String	False
NulabAccountName	String	False
NulabId	String	False
NulabAccountUniqueId	String	False
RoleType	Int	False
Language	String	False
MailAddress	String	False

ProjectVersionMilestones

Returns data from project version milestones table.

projectversionmilestones

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

ProjectId は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM ProjectVersionMilestones WHERE ProjectId = 114706

Insert

挿入は、ProjectId およびName を指定することで実行できます。

INSERT INTO ProjectVersionMilestones (ProjectId, Name) VALUES ('114706', 'Milestone4')

Update

UPDATE ProjectVersionMilestones SET Name = 'Sample' WHERE ProjectId = 114706 AND Id = 138889

Delete

削除は、ProjectId AND ID を指定することで実行できます。

DELETE FROM ProjectVersionMilestones WHERE ProjectId = 114706 AND Id = 138890

Columns


Name	Type	ReadOnly	Description
ProjectId [KEY]	Int	False
Id [KEY]	Int	False
Name	String	False
Description	String	False
DisplayOrder	Int	True
StartDate	Date	False
ReleaseDueDate	Date	False
Archived	Boolean	True

PullRequestAttachments

Returns data from pull request attachments table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId、RepositoryId、PullRequestNumber が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

ProjectId は'=' をサポートしています。
RepositoryId は'=' をサポートしています。
PullRequestNumber は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM PullRequestAttachments WHERE ProjectId = '94706' AND RepositoryId = 21949 AND PullRequestNumber = 2

INSERT

INSERT は、このテーブルではサポートされていません。

Update

UPDATE は、このテーブルではサポートされていません。

Delete

削除は、ProjectId、RepositoryId、PullRequestNumber AND ID を指定することで実行できます。

DELETE FROM PullRequestAttachments WHERE ProjectId = 39470 AND RepositoryId = 21949 AND PullRequestNumber = 2 AND ID = 3

Columns


Name	Type	ReadOnly	Description
ProjectId [KEY]	Int	True
RepositoryId [KEY]	Int	True
PullRequestNumber [KEY]	Int	True
Id [KEY]	Int	True
Name	String	True
Size	Int	True
Created	Datetime	True
CreatedById	Int	True
CreatedByUserId	String	True
CreatedByName	String	True
CreatedByKeyword	String	True
CreatedByRoleType	Int	True
CreatedByLanguage	String	True
CreatedByMailAddress	String	True
CreatedByNulabAccountName	String	True
CreatedByNulabId	String	True
CreatedByNulabAccountUniqueId	String	True

PullRequestComments

Returns data from pull request comments table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId、RepositoryId、PullRequestNumber が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

ProjectId は'=' をサポートしています。
RepositoryId は'=' をサポートしています。
PullRequestNumber は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM PullRequestComments WHERE ProjectId = 114706 AND RepositoryId = 22462 AND PullRequestNumber = 2

Insert

挿入は、ProjectId、RepositoryId、PullRequestNumber およびContent を指定することで実行できます。

INSERT INTO PullRequestComments (ProjectId, RepositoryId, PullRequestNumber, Content) VALUES ('114706', '22462', '2', 'FirstComment')

Update

UPDATE PullRequestComments SET Content = 'Third' WHERE ProjectId = 114706 AND RepositoryId = 22462 AND PullRequestNumber = 2 AND ID = 3

Delete

削除はこのテーブルではサポートされていません。

Columns


Name	Type	ReadOnly	Description
ProjectId	Int	False
RepositoryId	Int	False
PullRequestNumber	Int	False
Id [KEY]	Int	False
Content	String	False
Created	Datetime	True
Updated	Datetime	True
CreatedById	Int	True
CreatedByUserId	String	True
CreatedByName	String	True
CreatedByRoleType	Int	True
CreatedByLanguage	String	True
CreatedByMailAddress	String	True
CreatedByNulabAccountName	String	True
CreatedByNulabId	String	True
CreatedByNulabAccountUniqueId	String	True

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
NotifiedUserId	String

PullRequests

Returns data from project pull requests table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId およびRepositoryId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

ProjectId は'=' をサポートしています。
RepositoryId は'=' をサポートしています。
Number は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM PullRequests WHERE ProjectId = '114706' AND RepositoryId = 22462"
SELECT * FROM PullRequests WHERE ProjectId = '114706' AND RepositoryId = 22462 AND Number = 2

Insert

挿入は、ProjectId、RepositoryId、Summary、description、base およびbranch を指定することで実行できます。

INSERT INTO PullRequests (ProjectId, RepositoryId, Summary, description, base, branch) VALUES ('114706', '22462', 'First', 'FirstPullReq', 'main', 'sample')

Update

UPDATE PullRequests SET Summary = 'Third' WHERE ProjectId = 114706 AND RepositoryId = 22462 AND Number = 44203

Delete

削除はこのテーブルではサポートされていません。

Columns


Name	Type	ReadOnly	Description
ProjectId [KEY]	Int	False
RepositoryId [KEY]	Int	False
Id [KEY]	Int	False
Number	Int	False
Summary	String	False
Description	String	False
Base	String	False
Branch	String	False
BaseCommit	String	True
BranchCommit	String	True
CloseAt	Datetime	True
MergeAt	Datetime	True
StatusId	Int	True
StatusName	String	True
IssueId	Int	False
AssigneeId	Int	False
AssigneeName	String	True
AssigneeRoleType	Int	True
AssigneeLanguage	String	True
AssigneeMailAddress	String	True
Created	Datetime	True
CreatedById	Int	True
CreatedByUserId	String	True
CreatedByName	String	True
CreatedByKeyword	String	True
CreatedByRoleType	Int	True
CreatedByLanguage	String	True
CreatedByMailAddress	String	True
CreatedByNulabAccountName	String	True
CreatedByNulabId	String	True
CreatedByNulabAccountUniqueId	String	True
Updated	Datetime	True
UpdatedById	Int	True
UpdatedByUserId	String	True
UpdatedByName	String	True
UpdatedByKeyword	String	True
UpdatedByRoleType	Int	True
UpdatedByLanguage	String	True
UpdatedByMailAddress	String	True
UpdatedByNulabAccountName	String	True
UpdatedByNulabId	String	True
UpdatedByNulabAccountUniqueId	String	True

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
NotifiedUserId	String
AttachmentId	String

Watchings

Returns data from watchings table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはUserId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

UserId は'=' をサポートしています。
Id は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM Watchings WHERE UserId = '280688'
SELECT * FROM Watchings WHERE Id = '145169'

Insert

挿入は、IssueId およびNote を指定することで実行できます。

INSERT INTO Watchings (IssueId, Note) VALUES ('6868643', 'Sample')

Update

UPDATE Watchings SET Note = 'Third' WHERE Id = 145171

Delete

削除は、ID を指定することで実行できます。

DELETE FROM Watchings WHERE Id = 145170

Columns


Name	Type	ReadOnly	Description
UserId	Int	False
Id [KEY]	Int	False
Note	String	False
Type	String	True
IssueId	String	True
ResourceAlreadyRead	Boolean	True
LastContentUpdated	Datetime	True
Created	Datetime	True
Updated	Datetime	True

WikiPageAttachments

Gets list of files attached to Wiki.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはWikiPageId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

WikiPageId は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM WikiPageAttachments WHERE WikiPageId = '639459'

INSERT

INSERT は、このテーブルではサポートされていません。

Update

UPDATE は、このテーブルではサポートされていません。

Delete

削除は、IssueId AND ID を指定することで実行できます。

DELETE FROM WikiPageAttachments WHERE WikiPageId = 639459 AND Id = 188522

Columns


Name	Type	ReadOnly	Description
WikiPageId [KEY]	Int	False
Id [KEY]	Int	False
Name	String	False
Size	Int	False
Created	Datetime	False
CreatedById	Int	False
CreatedByUserId	String	False
CreatedByName	String	False
CreatedByKeyword	String	False
CreatedByRoleType	Int	False
CreatedByLanguage	String	False
CreatedByMailAddress	String	False
CreatedByNulabAccountName	String	False
CreatedByNulabId	String	False
CreatedByNulabAccountUniqueId	String	False

WikiPages

Returns data from wiki pages table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

ProjectId は'=' をサポートしています。
Id は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM WikiPages WHERE ProjectId = '114706'
SELECT * FROM WikiPages WHERE Id = 639460

Insert

挿入は、ProjectId、Content、およびName を指定することで実行できます。

INSERT INTO WikiPages (ProjectId, Name, Content) VALUES ('114706', 'FirstWiki3', 'Sample Comment')

Update

UPDATE WikiPages SET Name = 'UPDATED', Content = 'UPDATED' WHERE Id = 639460

Delete

削除は、ID を指定することで実行できます。

DELETE FROM WikiPages WHERE Id = 639461

Columns


Name	Type	ReadOnly	Description
ProjectId	Int	False
Id [KEY]	Int	False
Name	String	False
Content	String	False
Created	Datetime	True
CreatedById	Int	True
CreatedByUserId	String	True
CreatedByName	String	True
CreatedByKeyword	String	True
CreatedByRoleType	Int	True
CreatedByLanguage	String	True
CreatedByMailAddress	String	True
CreatedByNulabAccountName	String	True
CreatedByNulabId	String	True
CreatedByNulabAccountUniqueId	String	True
Updated	Datetime	True
UpdatedById	Int	True
UpdatedByUserId	String	True
UpdatedByName	String	True
UpdatedByKeyword	String	True
UpdatedByRoleType	Int	True
UpdatedByLanguage	String	True
UpdatedByMailAddress	String	True
UpdatedByNulabAccountName	String	True
UpdatedByNulabId	String	True
UpdatedByNulabAccountUniqueId	String	True

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
MailNotify	Boolean

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

CData Cloud - Backlog ビュー


Name	Description
IssueCategories	Returns data from issue categories table.
IssueCommentChangeLog	Returns data from issue comment change log table.
IssueCommentNotifications	Returns data from issue comment notifications table.
IssueCommentStars	Returns data from issue comment starts table.
IssueMilestones	Returns data from issue milestones table.
IssueParticipants	Returns list of participants of an issue.
IssueVersions	Returns data from issue versions table.
Licenses	Returns licence.
Notifications	Returns own notifications.
Priorities	Returns data from priorities table.
ProjectRecentUpdates	Returns recent update in the project.
ProjectSharedFiles	Gets list of Project Shared Files
ProjectTeamMembers	Returns data from project team members table.
PullRequestCommentChangeLog	Returns data from pull request comment changelog table.
PullRequestCommentNotifications	Returns data from pull request comment notifications table.
PullRequestCommentStars	Returns data from pull request comment starts table.
Repositories	Returns data from project repositories table.
Resolutions	Returns data from resolutions table.
Space	Returns information about your space.
SpaceDiskUsage	Returns information about space disk usage.
SpaceDiskUsageDetails	Returns information about space disk details usage.
SpaceNotifications	Returns space notification.
SpaceUpdates	Returns recent updates in your space.
TeamMembers	Returns data from team members table.
Teams	Returns data from teams table.
UserReceivedStars	Returns the list of stars that user received.
UserRecentlyViewedIssues	Returns list of issues which the user viewed recently.
UserRecentlyViewedProjects	Returns list of projects which the user viewed recently.
UserRecentlyViewedWikiPages	Returns list of Wikis which the user viewed recently.
UserRecentUpdates	Returns user recent updates.
Users	Returns data from users table.
WikiPageHistory	Returns history of Wiki page.
WikiPageLinkedSharedFiles	Returns data from wiki page linked shred files table.
WikiPageStars	Returns list of stars received on the Wiki page.
WikiPageTags	Returns list of tags that are used in the project.

IssueCategories

Returns data from issue categories table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはIssueId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

IssueId は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM IssueCategories WHERE IssueId = 6840954

Columns


Name	Type	Description
IssueId	String
Id [KEY]	Int
Name	String
DisplayOrder	String

IssueCommentChangeLog

Returns data from issue comment change log table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはIssueId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

IssueId は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM IssueCommentChangeLog WHERE IssueId = 6840954

Columns


Name	Type	Description
IssueId	Int
CommentId	Int
AttachmentInfo	String
AttributeInfo	String
Field	String
NewValue	String
NotificationInfo	String
OriginalValue	String

IssueCommentNotifications

Returns data from issue comment notifications table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはIssueId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

IssueId は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM IssueCommentNotifications WHERE IssueId = 6840954

Columns


Name	Type	Description
IssueId	Int
CommentId	Int
NotificationId [KEY]	Int
Reason	String
AlreadyRead	Boolean
ResourceAlreadyRead	Boolean
CreatedById	Int
CreatedByUserId	String
CreatedByName	String
CreatedByKeyword	String
CreatedByRoleType	Int
CreatedByLanguage	String
CreatedByMailAddress	String
CreatedByNulabAccountName	String
CreatedByNulabId	String
CreatedByNulabAccountUniqueId	String

IssueCommentStars

Returns data from issue comment starts table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはIssueId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

IssueId は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM IssueCommentStars WHERE IssueId = 6840954

Columns


Name	Type	Description
IssueId	Int
CommentId	Int
StarId [KEY]	Int
Comment	String
Title	String
Url	String
Created	Datetime
PresenterId	Int
PresenterUserId	String
PresenterName	String
PresenterKeyword	String
PresenterRoleType	Int
PresenterLanguage	String
PresenterMailAddress	String
PresenterNulabAccountName	String
PresenterNulabId	String
PresenterNulabAccountUniqueId	String

IssueMilestones

Returns data from issue milestones table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはIssueId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

IssueId は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM IssueMilestones WHERE IssueId = 6868745

Columns


Name	Type	Description
IssueId	String
Id [KEY]	Int
Name	String
Description	String
Archived	Boolean
ProjectId	Int
ReleaseDueDate	Date
StartDate	Date
DisplayOrder	String

IssueParticipants

Returns list of participants of an issue.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはIssueId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

IssueId は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM IssueParticipants WHERE IssueId = '6840954'

Columns


Name	Type	Description
IssueId	Int
Id [KEY]	Int
UserId	String
Name	String
Keyword	String
NulabAccountName	String
NulabId	String
NulabAccountUniqueId	String
RoleType	Int
Language	String
MailAddress	String

IssueVersions

Returns data from issue versions table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはIssueId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

IssueId は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM IssueVersions WHERE IssueId = 6868745

Columns


Name	Type	Description
IssueId	String
Id [KEY]	Int
Name	String
Description	String
Archived	Boolean
ProjectId	Int
ReleaseDueDate	Date
StartDate	Date
DisplayOrder	String

Licenses

Returns licence.

テーブル固有の情報

Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。

Columns

Description Boolean Int Int Int Boolean Int Boolean Int Int Boolean Boolean Boolean Int Int Date Boolean Boolean Boolean Boolean Int Int Int Boolean Int Datetime Int Boolean Boolean Int Int Boolean Int Int


Name	Type
Active
AttachmentLimit
AttachmentLimitPerFile
AttachmentNumLimit
Attribute
AttributeLimit
Burndown
CommentLimit
ComponentLimit
FileSharing
Gantt
Git
IssueLimit
LicenceTypeId
LimitDate
NulabAccount
ParentChildIssue
PostIssueByMail
ProjectGroup
ProjectLimit
PullRequestAttachmentLimitPerFile
PullRequestAttachmentNumLimit
RemoteAddress
RemoteAddressLimit
StartedOn
StorageLimit
Subversion
SubversionExternal
UserLimit
VersionLimit
WikiAttachment
WikiAttachmentLimitPerFile
WikiAttachmentNumLimit

Notifications

Returns own notifications.

テーブル固有の情報

Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。

Columns


Name	Type	Description
Id [KEY]	Int
AlreadyRead	Boolean
Reason	Int
ResourceAlreadyRead	Int
Created	Int
ProjectId	Int
ProjectKey	String
ProjectName	String
ProjectDisplayOrder	Int
ProjectChartEnabled	Boolean
ProjectSubtaskingEnabled	Boolean
ProjectProjectLeaderCanEditProjectLeader	Boolean
ProjectUseDevAttributes	Boolean
ProjectUseWikiTreeView	Boolean
ProjectTextFormattingRule	String
ProjectArchived	Boolean
IssueId	Int
IssueProjectId	Int
IssueKey	String
IssueKeyId	Int
IssueTypeId	Int
IssueTypeName	String
IssueTypeColor	String
IssueTypeProjectId	Int
IssueTypeDisplayOrder	Int
IssueSummary	String
IssueDescription	String
IssueResolutions	String
IssuePriorityId	Int
IssuePriorityName	String
IssueStatusId	Int
IssueStatusName	String
IssueStatusColor	String
IssueStatusProjectId	Int
IssueStatusDisplayOrder	Int
IssueAssigneeId	Int
IssueAssigneeName	String
IssueAssigneeRoleType	Int
IssueAssigneeLanguage	String
IssueAssigneeMailAddress	String
IssueCategories	String
IssueVersions	String
IssueMilestones	String
IssueCustomFields	String
IssueAttachments	String
IssueSharedFiles	String
IssueStars	String
IssueStartDate	Date
IssueDueDate	Date
IssueEstimatedHours	Decimal
IssueActualHours	Decimal
IssueParentIssueId	Int
IssueCreated	Datetime
IssueCreatedById	Int
IssueCreatedByUserId	String
IssueCreatedByName	String
IssueCreatedByKeyword	String
IssueCreatedByNulabAccountName	String
IssueCreatedByNulabId	String
IssueCreatedByNulabAccountUniqueId	String
IssueCreatedByRoleType	Int
IssueCreatedByLanguage	String
IssueCreatedByMailAddress	String
IssueUpdated	Datetime
IssueUpdatedById	Int
IssueUpdatedByUserId	String
IssueUpdatedByName	String
IssueUpdatedByKeyword	String
IssueUpdatedByNulabAccountName	String
IssueUpdatedByNulabId	String
IssueUpdatedByNulabAccountUniqueId	String
IssueUpdatedByRoleType	Int
IssueUpdatedByLanguage	String
IssueUpdatedByMailAddress	String
CommentId	Int
CommentContent	String
CommentCreated	String
SentById	Int
SentByUserId	String
SentByName	String
SentByKeyword	String
SentByNulabAccountName	String
SentByNulabId	String
SentByNulabAccountUniqueId	String
SentByRoleType	Int
SentByLanguage	String
SentByMailAddress	String

Priorities

Returns data from priorities table.

テーブル固有の情報

Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。

Columns


Name	Type	Description
Id [KEY]	Int
Name	String

ProjectRecentUpdates

Returns recent update in the project.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

ProjectId は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM ProjectRecentUpdates WHERE ProjectId = 114706

Columns


Name	Type	Description
Id [KEY]	Int
Created	Datetime
Type	String
ContentId	Int
Content	String
ContentDiff	String
ContentKeyId	String
ContentDescription	String
ContentSummary	String
ContentRepository	String
ContentAttachments	String
ContentSharedFiles	String
ContentComments	String
ContentChanges	String
ContentParties	String
ProjectId	Int
ProjectKey	String
ProjectName	String
ProjectDisplayOrder	Int
ProjectChartEnabled	Boolean
ProjectSubtaskingEnabled	Boolean
ProjectProjectLeaderCanEditProjectLeader	Boolean
ProjectUseDevAttributes	Boolean
ProjectUseWikiTreeView	Boolean
ProjectTextFormattingRule	String
ProjectArchived	Boolean
CreatedById	Int
CreatedByUserId	String
CreatedByName	String
CreatedByKeyword	String
CreatedByNulabAccountName	String
CreatedByNulabId	String
CreatedByNulabAccountUniqueId	String
CreatedByRoleType	Int
CreatedByLanguage	String
CreatedByMailAddress	String

ProjectSharedFiles

Gets list of Project Shared Files

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

ProjectId は'=' をサポートしています。
Directory は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM ProjectSharedFiles WHERE ProjectId = '114706'
SELECT * FROM ProjectSharedFiles WHERE ProjectId = '114706' AND Directory = '/folder/'

Columns


Name	Type	Description
ProjectId	Int
Id [KEY]	Int
Name	String
Size	Int
Type	String
Directory	String
Created	Datetime
CreatedById	Int
CreatedByUserId	String
CreatedByName	String
CreatedByKeyword	String
CreatedByRoleType	Int
CreatedByLanguage	String
CreatedByMailAddress	String
CreatedByNulabAccountName	String
CreatedByNulabId	String
CreatedByNulabAccountUniqueId	String
Updated	Datetime
UpdatedById	Int
UpdatedByUserId	String
UpdatedByName	String
UpdatedByKeyword	String
UpdatedByRoleType	Int
UpdatedByLanguage	String
UpdatedByMailAddress	String
UpdatedByNulabAccountName	String
UpdatedByNulabId	String
UpdatedByNulabAccountUniqueId	String

ProjectTeamMembers

Returns data from project team members table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

ProjectId は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM ProjectTeamMembers WHERE ProjectId = 114706

Columns


Name	Type	Description
ProjectId	Int
TeamId	Int
MemberId	Int
UserId	String
Name	String
Keyword	String
NulabAccountName	String
NulabId	String
NulabAccountUniqueId	String
RoleType	Int
Lang	String
MailAddress	String

PullRequestCommentChangeLog

Returns data from pull request comment changelog table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId、RepositoryId、PullRequestNumber が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

ProjectId は'=' をサポートしています。
RepositoryId は'=' をサポートしています。
PullRequestNumber は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM PullRequestCommentChangeLog WHERE ProjectId = '114706' AND RepositoryId = 22462 AND PullRequestNumber = 2

Columns


Name	Type	Description
ProjectId	Int
RepositoryId	Int
PullRequestNumber	Int
AttachmentInfo	String
AttributeInfo	String
Field	String
NewValue	String
NotificationInfo	String
OriginalValue	String

PullRequestCommentNotifications

Returns data from pull request comment notifications table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId、RepositoryId、PullRequestNumber が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

ProjectId は'=' をサポートしています。
RepositoryId は'=' をサポートしています。
PullRequestNumber は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM PullRequestCommentNotifications WHERE ProjectId = '114706' AND RepositoryId = 22462 AND PullRequestNumber = 2

Columns


Name	Type	Description
ProjectId	Int
RepositoryId	Int
PullRequestNumber	Int
NotificationId [KEY]	Int
Reason	String
AlreadyRead	Boolean
ResourceAlreadyRead	Boolean
CreatedById	Int
CreatedByUserId	String
CreatedByName	String
CreatedByKeyword	String
CreatedByRoleType	Int
CreatedByLanguage	String
CreatedByMailAddress	String
CreatedByNulabAccountName	String
CreatedByNulabId	String
CreatedByNulabAccountUniqueId	String

PullRequestCommentStars

Returns data from pull request comment starts table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId、RepositoryId、PullRequestNumber が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

ProjectId は'=' をサポートしています。
RepositoryId は'=' をサポートしています。
PullRequestNumber は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM PullRequestCommentStars WHERE ProjectId = '114706' AND RepositoryId = 22462 AND PullRequestNumber = 2

Columns


Name	Type	Description
ProjectId	Int
RepositoryId	Int
PullRequestNumber	Int
StarId [KEY]	Int
Comment	String
Title	String
Url	String
Created	Datetime
PresenterId	Int
PresenterUserId	String
PresenterName	String
PresenterKeyword	String
PresenterRoleType	Int
PresenterLanguage	String
PresenterMailAddress	String
PresenterNulabAccountName	String
PresenterNulabId	String
PresenterNulabAccountUniqueId	String

Repositories

Returns data from project repositories table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

ProjectId は'=' をサポートしています。
Id は'=' をサポートしています。
Name は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM Repositories WHERE ProjectId = 117182
SELECT * FROM Repositories WHERE ProjectId = 117182 AND Id = 22862
SELECT * FROM Repositories WHERE ProjectId = 117182 AND Name = 'First'

Columns


Name	Type	Description
Id [KEY]	Int
ProjectId	Int
Name	String
Description	String
HookUrl	String
HttpUrl	String
SshUrl	String
DisplayOrder	Int
PushedAt	Datetime
Created	Datetime
CreatedById	Int
CreatedByUserId	String
CreatedByName	String
CreatedByKeyword	String
CreatedByRoleType	Int
CreatedByLanguage	String
CreatedByMailAddress	String
CreatedByNulabAccountName	String
CreatedByNulabId	String
CreatedByNulabAccountUniqueId	String
Updated	Datetime
UpdatedById	Int
UpdatedByUserId	String
UpdatedByName	String
UpdatedByKeyword	String
UpdatedByRoleType	Int
UpdatedByLanguage	String
UpdatedByMailAddress	String
UpdatedByNulabAccountName	String
UpdatedByNulabId	String
UpdatedByNulabAccountUniqueId	String

Resolutions

Returns data from resolutions table.

テーブル固有の情報

Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。

Columns


Name	Type	Description
Id [KEY]	Int
Name	String

Space

Returns information about your space.

テーブル固有の情報

Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。

Columns


Name	Type	Description
SpaceKey	String
Name	String
OwnerId [KEY]	Int
Language	String
Timezone	String
ReportSendTime	Hour
TextFormattingRule	String
Created	Datetime
Updated	Datetime

SpaceDiskUsage

Returns information about space disk usage.

テーブル固有の情報

Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。

Columns


Name	Type	Description
Capacity	String
Issue	String
Wiki	String
File	Int
Subversion	Int
Git	Int
GitLFS	Int
PullRequest	Int

SpaceDiskUsageDetails

Returns information about space disk details usage.

テーブル固有の情報

Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。

Columns


Name	Type	Description
ProjectId	String
File	Int
Git	Int
GitLFS	Int
Issue	String
Wiki	String
Subversion	Int

SpaceNotifications

Returns space notification.

テーブル固有の情報

Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。

Columns


Name	Type	Description
Content	String
Updated	Datetime

SpaceUpdates

Returns recent updates in your space.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でCloud 内部で処理されます。

Type は'=,IN' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM SpaceUpdates WHERE Type = 13
SELECT * FROM SpaceUpdates WHERE Type IN (13, 5)

Columns


Name	Type	Description
Id [KEY]	Int
Created	Datetime
Type	String
ContentId	Int
Content	String
ContentDiff	String
ContentKeyId	String
ContentDescription	String
ContentSummary	String
ContentRepository	String
ContentAttachments	String
ContentSharedFiles	String
ContentComments	String
ContentChanges	String
ContentParties	String
ProjectId	Int
ProjectKey	String
ProjectName	String
ProjectDisplayOrder	Int
ProjectChartEnabled	Boolean
ProjectSubtaskingEnabled	Boolean
ProjectProjectLeaderCanEditProjectLeader	Boolean
ProjectUseDevAttributes	Boolean
ProjectUseWikiTreeView	Boolean
ProjectTextFormattingRule	String
ProjectArchived	Boolean
CreatedById	Int
CreatedByUserId	String
CreatedByName	String
CreatedByKeyword	String
CreatedByNulabAccountName	String
CreatedByNulabId	String
CreatedByNulabAccountUniqueId	String
CreatedByRoleType	Int
CreatedByLanguage	String
CreatedByMailAddress	String

TeamMembers

Returns data from team members table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはTeamId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

TeamId は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM TeamMembers WHERE TeamId = 54836

Columns


Name	Type	Description
TeamId	Int
Id [KEY]	Int
UserId	String
Name	String
Keyword	String
NulabAccountName	String
NulabId	String
NulabAccountUniqueId	String
RoleType	Int
Lang	String
MailAddress	String

Teams

Returns data from teams table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でCloud 内部で処理されます。

Id は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM Teams WHERE Id = 55081

Columns


Name	Type	Description
Id [KEY]	Int
Name	String
DisplayOrder	Int
Members	String
Created	Datetime
CreatedById	Int
CreatedByUserId	String
CreatedByName	String
CreatedByRoleType	Int
CreatedByLang	String
CreatedByMailAddress	String
Updated	Datetime
UpdatedById	Int
UpdatedByUserId	String
UpdatedByName	String
UpdatedByRoleType	Int
UpdatedByLang	String
UpdatedByMailAddress	String

UserReceivedStars

Returns the list of stars that user received.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはUserId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

UserId は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM UserReceivedStars WHERE UserId = 263366

Columns


Name	Type	Description
UserId	String
Id [KEY]	Int
Comment	String
Title	String
Url	String
Created	Datetime
PresenterId	Int
PresenterUserId	String
PresenterName	String
PresenterKeyword	String
PresenterRoleType	Int
PresenterLanguage	String
PresenterMailAddress	String
PresenterNulabAccountName	String
PresenterNulabId	String
PresenterNulabAccountUniqueId	String

UserRecentlyViewedIssues

Returns list of issues which the user viewed recently.

テーブル固有の情報

Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。

Columns


Name	Type	Description
Id [KEY]	Int
ProjectId	Int
IssueKey	String
KeyId	Int
ParentIssueId	Int
Summary	String
Description	String
StartDate	Date
DueDate	Date
ActualHours	Decimal
EstimatedHours	Decimal

UserRecentlyViewedProjects

Returns list of projects which the user viewed recently.

テーブル固有の情報

Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。

Columns


Name	Type	Description
Id [KEY]	Int
ProjectKey	String
Name	String
DisplayOrder	Int
ChartEnabled	Boolean
SubtaskingEnabled	Boolean
ProjectLeaderCanEditProjectLeader	Boolean
UseDevAttributes	Boolean
UseWikiTreeView	Boolean
TextFormattingRule	String
Archived	Boolean

UserRecentlyViewedWikiPages

Returns list of Wikis which the user viewed recently.

テーブル固有の情報

Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。

Columns


Name	Type	Description
ProjectId	Int
Id [KEY]	Int
Name	String
Content	String
Created	Datetime

UserRecentUpdates

Returns user recent updates.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはUserId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

UserId は'=' をサポートしています。
Type は'=,IN' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM UserRecentUpdates WHERE UserId = 263366
SELECT * FROM UserRecentUpdates WHERE UserId = 263366 AND Type = 3
SELECT * FROM UserRecentUpdates WHERE UserId = 263366 AND Type IN (3, 5)

Columns


Name	Type	Description
UserId	String
Id [KEY]	Int
Created	Datetime
Type	String
ContentId	Int
Content	String
ContentDiff	String
ContentKeyId	String
ContentDescription	String
ContentSummary	String
ContentRepository	String
ContentAttachments	String
ContentSharedFiles	String
ContentComments	String
ContentChanges	String
ContentParties	String
ProjectId	Int
ProjectKey	String
ProjectName	String
ProjectDisplayOrder	Int
ProjectChartEnabled	Boolean
ProjectSubtaskingEnabled	Boolean
ProjectProjectLeaderCanEditProjectLeader	Boolean
ProjectUseDevAttributes	Boolean
ProjectUseWikiTreeView	Boolean
ProjectTextFormattingRule	String
ProjectArchived	Boolean
CreatedById	Int
CreatedByUserId	String
CreatedByName	String
CreatedByKeyword	String
CreatedByNulabAccountName	String
CreatedByNulabId	String
CreatedByNulabAccountUniqueId	String
CreatedByRoleType	Int
CreatedByLanguage	String
CreatedByMailAddress	String

Users

Returns data from users table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でCloud 内部で処理されます。

Id は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM Users WHERE Id = 54836

Columns


Name	Type	Description
Id [KEY]	Int
UserId	String
Name	String
NulabAccountName	String
NulabAccountID	String
NulabAccountUniqueId	String
RoleType	Int
Lang	String
MailAddress	String

WikiPageHistory

Returns history of Wiki page.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはWikiPageId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

WikiPageId は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM WikiPageHistory WHERE WikiPageId = '639459'

Columns


Name	Type	Description
WikiPageId	Int
PageId [KEY]	Int
Name	String
Content	String
Version	Int
Created	Datetime
CreatedById	Int
CreatedByUserId	String
CreatedByName	String
CreatedByKeyword	String
CreatedByRoleType	Int
CreatedByLanguage	String
CreatedByMailAddress	String
CreatedByNulabAccountName	String
CreatedByNulabId	String
CreatedByNulabAccountUniqueId	String

WikiPageLinkedSharedFiles

Returns data from wiki page linked shred files table.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはWikiPageId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

WikiPageId は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM WikiPageLinkedSharedFiles WHERE WikiPageId = '639459'

Columns


Name	Type	Description
WikiPageId	Int
Id [KEY]	Int
Name	String
Size	Int
Type	String
Dir	String
Created	Datetime
CreatedById	Int
CreatedByUserId	String
CreatedByName	String
CreatedByKeyword	String
CreatedByRoleType	Int
CreatedByLanguage	String
CreatedByMailAddress	String
CreatedByNulabAccountName	String
CreatedByNulabId	String
CreatedByNulabAccountUniqueId	String
Updated	Datetime
UpdatedById	Int
UpdatedByUserId	String
UpdatedByName	String
UpdatedByKeyword	String
UpdatedByRoleType	Int
UpdatedByLanguage	String
UpdatedByMailAddress	String
UpdatedByNulabAccountName	String
UpdatedByNulabId	String
UpdatedByNulabAccountUniqueId	String

WikiPageStars

Returns list of stars received on the Wiki page.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはWikiPageId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

WikiPageId は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM WikiPageStars WHERE WikiPageId = '528251'

Columns


Name	Type	Description
WikiPageId	Int
CommentId	Int
StarId [KEY]	Int
Comment	String
Title	String
Url	String
Created	Datetime
PresenterId	Int
PresenterUserId	String
PresenterName	String
PresenterKeyword	String
PresenterRoleType	Int
PresenterLanguage	String
PresenterMailAddress	String
PresenterNulabAccountName	String
PresenterNulabId	String
PresenterNulabAccountUniqueId	String

WikiPageTags

Returns list of tags that are used in the project.

Select

Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。

ProjectId は'=' をサポートしています。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM WikiPageTags WHERE ProjectId = '94706'

Columns


Name	Type	Description
ProjectId	Int
Id [KEY]	Int
Name	String

ストアドプロシージャ

ストアドプロシージャはファンクションライクなインターフェースで、Backlog の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにBacklog から関連するレスポンスデータを返します。

CData Cloud - Backlog ストアドプロシージャ


Name	Description
AddStar	Adds star.
AttachFileToWiki	Attaches file to Wiki.
GetOwnUser	Returns own information about user.
LinkSharedFilesToWiki	Links Shared Files to Wiki.
MarkWatchingAsRead	Mark a watching as read.
PostAttachmentFile	Posts an attachment file for issue or wiki.
RemoveProjectIssueType	Delete the Project Issue Type.
RemoveProjectStatus	Delete the Project Status.
RemoveSharedFileFromWiki	Removes link to shared file from Wiki.
UpdatePullRequestCommentInformation	Updates pull request comment information.Authenticated user can update his own comments.
UpdateSpaceNotification	Updates space notification.

AddStar

Adds star.

Input


Name	Type	Required	Description
IssueId	String	False	Id of the issue.
CommentId	String	False	Id of the comment.
WikiId	String	False	Id of the wiki.
PullRequestId	String	False	Id of the pullRequest.
PullRequestCommentId	String	False	Id of the pullRequestComment.

Result Set Columns


Name	Type	Description
Success	String	Returns True if procedure succeeded.

AttachFileToWiki

Attaches file to Wiki.

Input


Name	Type	Required	Description
WikiId	String	True	Id of the issue.
AttachmentId	String	True	Id of the attachment. You can specify multiple ids separating them by comma ','.

Result Set Columns


Name	Type	Description
Success	String	Returns True if the attachment succeeded.

GetOwnUser

Returns own information about user.

Stored Procedure Specific Information

Backlog does not allows columns to be used in the Exec query. For example:

EXECUTE GetOwnUser;

Result Set Columns


Name	Type	Description
Success	String	Returns True if procedure succeeded.
Id	String	Id of the User.

LinkSharedFilesToWiki

Links Shared Files to Wiki.

Input


Name	Type	Required	Description
WikiId	String	True	Id of the wiki.
SharedFileId	String	True	Id of the shared file. You can specify multiple ids separating them by comma ','.

Result Set Columns


Name	Type	Description
Success	String	Returns True if procedure succeeded.

MarkWatchingAsRead

Mark a watching as read.

Input


Name	Type	Required	Description
WatchingId	String	True	Id of the watching.

Result Set Columns


Name	Type	Description
Success	String	Returns True if procedure succeeded.

PostAttachmentFile

Posts an attachment file for issue or wiki.

Input


Name	Type	Required	Description
FileLocation	String	False	Location of the downloaded file. EX: C:\Temp\downloads\file.txt
FileName	String	False	File name that is uploaded. Required if content is not empty.

Result Set Columns


Name	Type	Description
Success	String	Returns True if the upload succeeded.

RemoveProjectIssueType

Delete the Project Issue Type.

Stored Procedure Specific Information

Backlog allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. For example:

EXECUTE RemoveProjectIssueType ProjectId ='123844', Id = '530228', SubstituteIssueTypeId = '530140'

Input


Name	Type	Required	Description
ProjectId	String	True	ProjectId.
Id	String	True	Project Issue Type Id.
SubstituteIssueTypeId	String	True	Project Issue Type Id to change linked issue.

Result Set Columns


Name	Type	Description
Success	String	Returns true if procedure succeeded.

RemoveProjectStatus

Delete the Project Status.

Stored Procedure Specific Information

Backlog allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. For example:

EXECUTE RemoveProjectStatus ProjectId ='123844', Id = '4', SubstituteStatusId = '3'

Input


Name	Type	Required	Description
ProjectId	String	True	ProjectId.
Id	String	True	Project Status Id.
SubstituteStatusId	String	True	Project Status Id to replace linked issues statuses. Issues which status are set to the deleted status will be set to the specied substitute status.

Result Set Columns


Name	Type	Description
Success	String	Returns true if procedure succeeded.

RemoveSharedFileFromWiki

Removes link to shared file from Wiki.

Input


Name	Type	Required	Description
WikiId	String	True	Id of the wiki.
SharedFileId	String	True	Id of the shared file.

Result Set Columns


Name	Type	Description
Success	String	Returns True if procedure succeeded.

UpdatePullRequestCommentInformation

Updates pull request comment information.Authenticated user can update his own comments.

Input


Name	Type	Required	Description
ProjectId	String	True	Id of the project.
RepositoryId	String	True	Id of the repository.
Number	String	True	Number of the pull request.
CommentId	String	True	Id of the comment.
Content	String	True	Content of the comment.

Result Set Columns


Name	Type	Description
Success	String	Returns True if procedure succeeded.

UpdateSpaceNotification

Updates space notification.

Input


Name	Type	Required	Description
Content	String	True	Content of the update.

Result Set Columns


Name	Type	Description
Success	String	Returns True if the update succeeded.

システムテーブル

このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。

スキーマテーブル

以下のテーブルは、Backlog のデータベースメタデータを返します。

sys_catalogs：利用可能なデータベースをリスト。
sys_schemas：利用可能なスキーマをリスト。
sys_tables：利用可能なテーブルおよびビューをリスト。
sys_tablecolumns：利用可能なテーブルおよびビューのカラムについて説明。
sys_procedures：利用可能なストアドプロシージャについて説明。
sys_procedureparameters：ストアドプロシージャパラメータについて説明。
sys_keycolumns：主キーおよび外部キーについて説明。
sys_indexes：利用可能なインデックスについて説明。

データソーステーブル

以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。

sys_connection_props：利用可能な接続プロパティについての情報を返す。
sys_sqlinfo：Cloud がデータソースにオフロードできるSELECT クエリについて説明。

クエリ情報テーブル

次のテーブルは、データ変更クエリのクエリ統計を返します。

sys_identity：バッチ処理または単一の更新に関する情報を返す。

sys_catalogs

利用可能なデータベースをリストします。

次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。

SELECT * FROM sys_catalogs

Columns


Name	Type	Description
CatalogName	String	データベース名。

sys_schemas

利用可能なスキーマをリストします。

次のクエリは、すべての利用可能なスキーマを取得します。

          SELECT * FROM sys_schemas

Columns


Name	Type	Description
CatalogName	String	データベース名。
SchemaName	String	スキーマ名。

sys_tables

利用可能なテーブルをリストします。

次のクエリは、利用可能なテーブルおよびビューを取得します。

          SELECT * FROM sys_tables

Columns


Name	Type	Description
CatalogName	String	テーブルまたはビューを含むデータベース。
SchemaName	String	テーブルまたはビューを含むスキーマ。
TableName	String	テーブル名またはビュー名。
TableType	String	テーブルの種類（テーブルまたはビュー）。
Description	String	テーブルまたはビューの説明。
IsUpdateable	Boolean	テーブルが更新可能かどうか。

sys_tablecolumns

利用可能なテーブルおよびビューのカラムについて説明します。

次のクエリは、Issues テーブルのカラムとデータ型を返します。

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Issues'

Columns


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 から返されたフィールドがテーブルの主キーであるかどうか。

sys_procedures

利用可能なストアドプロシージャをリストします。

次のクエリは、利用可能なストアドプロシージャを取得します。

          SELECT * FROM sys_procedures

Columns


Name	Type	Description
CatalogName	String	ストアドプロシージャを含むデータベース。
SchemaName	String	ストアドプロシージャを含むスキーマ。
ProcedureName	String	ストアドプロシージャの名前。
Description	String	ストアドプロシージャの説明。
ProcedureType	String	PROCEDURE やFUNCTION などのプロシージャのタイプ。

sys_procedureparameters

ストアドプロシージャパラメータについて説明します。

次のクエリは、AddStar ストアドプロシージャのすべての入力パラメータについての情報を返します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName='AddStar' AND Direction=1 OR Direction=2

Columns


Name	Type	Description
CatalogName	String	ストアドプロシージャを含むデータベースの名前。
SchemaName	String	ストアドプロシージャを含むスキーマの名前。
ProcedureName	String	パラメータを含むストアドプロシージャの名前。
ColumnName	String	ストアドプロシージャパラメータの名前。
Direction	Int32	パラメータのタイプに対応する整数値：input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataTypeName	String	データ型の名前。
DataType	Int32	データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length	Int32	文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericPrecision	Int32	数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ（文字数）。
NumericScale	Int32	数値データの小数点以下の桁数。
IsNullable	Boolean	パラメータがNull を含められるかどうか。
IsRequired	Boolean	プロシージャの実行にパラメータが必要かどうか。
IsArray	Boolean	パラメータが配列かどうか。
Description	String	パラメータの説明。
Ordinal	Int32	パラメータのインデックス。

sys_keycolumns

主キーおよび外部キーについて説明します。

次のクエリは、Issues テーブルの主キーを取得します。

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Issues'

Columns


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	主キーのカラム名。

sys_foreignkeys

外部キーについて説明します。

次のクエリは、他のテーブルを参照するすべての外部キーを取得します。

         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	外部キーがインポート（他のテーブルを指す）キーかエクスポート（他のテーブルから参照される）キーかを指定します。

sys_primarykeys

主キーについて説明します。

次のクエリは、すべてのテーブルとビューから主キーを取得します。

         SELECT * FROM sys_primarykeys

Columns


Name	Type	Description
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前。
KeySeq	String	主キーのシーケンス番号。
KeyName	String	主キーの名前。

sys_indexes

利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。

次のクエリは、主キーでないすべてのインデックスを取得します。

          SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns


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	インデックスのカラムのシーケンスナンバー。

sys_connection_props

利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。

次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns


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	プロパティに関するその他のさまざまな情報。

sys_sqlinfo

Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。

SQL 構文の詳細については、SQL 準拠を参照してください。

データソースのSELECT 機能

以下は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 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデルセクションを参照してください。

Columns


Name	Type	Description
NAME	String	SQL 構文のコンポーネント、またはサーバー上で処理できる機能。
VALUE	String	サポートされるSQL またはSQL 構文の詳細。

sys_identity

試行された変更に関する情報を返します。

次のクエリは、バッチ処理で変更された行のId を取得します。

         SELECT * FROM sys_identity

Columns


Name	Type	Description
Id	String	データ変更処理から返された、データベース生成Id。
Batch	String	バッチの識別子。1 は単一処理。
Operation	String	バッチ内の処理の結果：INSERTED、UPDATED、またはDELETED。
Message	String	SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。

sys_information

利用可能なシステム情報を説明します。

次のクエリは、すべてのカラムを取得します。

SELECT * FROM sys_information

Columns


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）。

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

Authentication

プロパティ	説明
URL	Backlog アカウントのURL。
AuthScheme	Backlog に接続する際に使用する認証の種類。
ApiKey	API キーを使用すると、Backlog API へのリクエストを行うことができます。

OAuth

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（コンシューマーシークレットとも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

SSL

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Logging

プロパティ	説明
Verbosity	ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

Schema

プロパティ	説明
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

Miscellaneous

プロパティ	説明
IncludeCustomFields	課題テーブルからカスタムフィールドを取得する場合は、True に設定します。
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
MaxThreads	最大スレッド数。
Pagesize	Backlog から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
ProjectId	特定のプロジェクトのId。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。

Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。

プロパティ	説明
URL	Backlog アカウントのURL。
AuthScheme	Backlog に接続する際に使用する認証の種類。
ApiKey	API キーを使用すると、Backlog API へのリクエストを行うことができます。

URL

Backlog アカウントのURL。

データ型

string

デフォルト値

""

解説

"https://{sample}.backlog.com" 形式のBacklog アカウントのURL。

AuthScheme

Backlog に接続する際に使用する認証の種類。

Possible Values

OAuth, APIToken

データ型

string

デフォルト値

"APIToken"

解説

APIToken：APIToken 認証でApiKey を使う場合に設定。
OAuth：OAuth 認証を実行する場合に設定。

ApiKey

API キーを使用すると、Backlog API へのリクエストを行うことができます。

データ型

string

デフォルト値

""

解説

API リクエストにAPI キーを追加してアカウントからデータを返します。

OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（コンシューマーシークレットとも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

OAuthClientId

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。

データ型

string

デフォルト値

""

解説

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

OAuthClientSecret

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（コンシューマーシークレットとも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

データ型

string

デフォルト値

""

解説

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

SSLServerCert

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

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

プロパティ	説明
Verbosity	ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

Verbosity

ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

データ型

string

デフォルト値

"1"

解説

このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。

デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。より高いVerbosity レベルは主にデバッグを目的としています。各レベルの詳細については、ログを参照してください。

LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

プロパティ	説明
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

BrowsableSchemas

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

データ型

string

デフォルト値

""

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

プロパティ	説明
IncludeCustomFields	課題テーブルからカスタムフィールドを取得する場合は、True に設定します。
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
MaxThreads	最大スレッド数。
Pagesize	Backlog から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
ProjectId	特定のプロジェクトのId。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。

IncludeCustomFields

課題テーブルからカスタムフィールドを取得する場合は、True に設定します。

データ型

bool

デフォルト値

false

解説

True に設定すると、ProjectId 接続プロパティも必須となります。

MaxRows

集計やGROUP BY を使用しないクエリで返される最大行数を指定します。

データ型

int

デフォルト値

-1

解説

このプロパティは、集計やGROUP BY 句を含まないクエリに対してCloud が返す行数の上限を設定します。この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。

MaxThreads

最大スレッド数。

データ型

string

デフォルト値

"1"

解説

Pagesize

Backlog から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。

データ型

int

デフォルト値

100

解説

クエリする特定のオブジェクトやサービスエンドポイントの結果を最適化するために、デフォルトのページサイズを調整したい場合があります。ページサイズを大きくするとパフォーマンスが向上するかもしれませんが、ページあたりのメモリ消費量が増える可能性もあることに注意してください。

ProjectId

特定のプロジェクトのId。

データ型

string

デフォルト値

""

解説

特定のプロジェクトのId。

PseudoColumns

テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。

データ型

string

デフォルト値

""

解説

このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"

すべてのテーブルのすべての擬似カラムを含めるには、次のようにします："*=*"

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。

データ型

int

デフォルト値

60

解説

このプロパティは、Cloud が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。操作の完了前にタイムアウト時間が経過すると、Cloud は操作をキャンセルして例外をスローします。

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

Cloud

Backlog - CData Cloud

概要

主要機能

はじめに

Backlog への接続

CData Cloud サービスからデータにアクセス

接続の確立

Backlog への認証

API キー

OAuth

ヘッドレスマシン

SSL の設定

SSL 設定のカスタマイズ

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

その他のプロキシ

データモデル

概要

主要機能

ビュー

テーブル

ストアドプロシージャ

テーブル

CData Cloud - Backlog テーブル

IssueAttachments

Select

INSERT

Update

Delete

Columns

IssueComments

Select

Insert

Update

Delete

Columns

Pseudo-Columns

IssueLinkedSharedFiles

Select

Insert

Update

Delete

Columns

Issues

Select

Insert

Update

Delete

Columns

Pseudo-Columns

ProjectAdministrators

Select

Insert

Update

Delete

Columns

ProjectCategories

Select

Insert

Update

Delete

Columns

ProjectCustomFieldItems

Select

Insert

Update

Delete

Columns

ProjectCustomFields

Select

Insert

Update

Delete

Columns

ProjectIssueTypes

Select

Insert

Update