CData Sync App は、Backlog データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Backlog コネクタはCData Sync アプリケーションから使用可能で、Backlog からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App はBacklog API を使用してBacklog への双方向アクセスを実現します。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
認証方法にはAPI キーとOAuth があります。
AuthScheme をAPIToken に設定します。
ApiKey を取得するには:
オプション1:Verifier code を取得および交換
Verifier code を取得するには、OAuth Authorization URL で認証する必要があります。
インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。
ヘッドレスマシンでは、次の接続プロパティを設定してOAuth 認証値を取得します。
OAuth 設定ファイルが生成されたら、以下のように接続プロパティをリセットする必要があります。
オプション2:OAuth 設定を転送
ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバとの接続を作成し、インストールする必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。
「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定された場所に暗号化されて書き込まれます。デフォルトのファイル名はOAuthSettings.txt です。
接続テストに成功したら、OAuth 設定ファイルをヘッドレスマシンにコピーします。
ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。
このセクションでは、Backlog Sync App の高度な機能を厳選して説明します。
Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
Sync App は、Backlog にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。
詳しくはクエリ処理 を参照してください。
CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。
デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
このセクションでは、利用可能なAPI オブジェクトを示し、Backlog API へのSQL の実行について詳しく説明します。
ビュー では、利用可能なビューを説明します。ビューは、Teams、Users、TeamMembers などを静的にモデル化するように定義されています。
テーブル では、利用可能なテーブルを説明します。テーブルは、Projects、Issues、WikiPages などを静的にモデル化するように定義されています。
ストアドプロシージャ は、Backlog のファンクションライクなインターフェースです。ストアドプロシージャを使用すると、オブジェクトのダウンロードやエンベロープの移動など、Backlog の操作を実行できます。
Sync App はBacklog のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
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. |
Returns data from issue attachments table.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはIssueId が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM IssueAttachments WHERE IssueId = 6840954
INSERT は、このテーブルではサポートされていません。
UPDATE は、このテーブルではサポートされていません。
削除は、IssueId AND ID を指定することで実行できます。
DELETE FROM IssueAttachments WHERE IssueId = 6840954 AND Id = 3470553
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 |
Returns data from issue comments table.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはIssueId が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM IssueComments WHERE IssueId = 6840954 SELECT * FROM IssueComments WHERE IssueId = 6840954 AND Id = 39040604
挿入は、IssueId およびContent を指定することで実行できます。
INSERT INTO IssueComments (IssueId, Content) VALUES ('6840954', 'Sample Comment')
UPDATE IssueComments SET Content = 'Third' WHERE IssueId = 6840954 AND Id = 39042035"
削除は、IssueId AND ID を指定することで実行できます。
DELETE FROM IssueComments WHERE IssueId = 6840954 AND Id = 39042338
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 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
NotifiedUserId | String | |
AttachmentId | String |
Returns data from issues table.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
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)
挿入は、ProjectId、Summary、PriorityId、およびIssueTypeId を指定することで実行できます。
INSERT INTO Issues (ProjectId, Summary, PriorityId, IssueTypeId) VALUES (114706, 'Summary', 3, 530959)
UPDATE Issues SET Summary = 'UPDATED_KEY23', ParentIssueId = '6700745', Comment = 'test' WHERE Id = 6700474
削除は、IssueId AND ID を指定することで実行できます。
DELETE FROM Issues WHERE IssueId = 6840954 AND Id = 3470553
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 |
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 |
Returns data from project administrators table.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM ProjectAdministrators WHERE ProjectId = 114706
挿入は、ProjectId およびUserId を指定することで実行できます。
INSERT INTO ProjectAdministrators (ProjectId, UserId) VALUES ('114706', '280728')
UPDATE は、このテーブルではサポートされていません。
削除は、ProjectId AND UserId を指定することで実行できます。
DELETE FROM ProjectAdministrators WHERE ProjectId = 114706 AND UserId = 280728
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 |
Returns data from project categories table.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM ProjectCategories WHERE ProjectId = 114706
挿入は、ProjectId およびName を指定することで実行できます。
INSERT INTO ProjectCategories (ProjectId, Name) VALUES ('114706', 'cat4')
UPDATE ProjectCategories SET Name = 'Sample' WHERE ProjectId = 114706 AND Id = 205625
削除は、IssueId AND ID を指定することで実行できます。
DELETE FROM ProjectCategories WHERE ProjectId = 114706 AND Id = 205622
Name | Type | ReadOnly | Description |
ProjectId [KEY] | Int | False | |
Id [KEY] | Int | False | |
Name | String | False | |
DisplayOrder | Int | False |
Returns data from project custom field items table.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM ProjectCustomFieldItems WHERE ProjectId = 114706
挿入は、ProjectId、CustomFieldId およびName を指定することで実行できます。
INSERT INTO ProjectCustomFieldItems (ProjectId, CustomFieldId, Name) VALUES ('114706', '44072', 'Fourth')
UPDATE ProjectCustomFieldItems SET Name = 'Fourth4' WHERE ProjectId = 114706 AND CustomFieldId = 44072 AND ItemId = 4
削除は、IssueId AND ID を指定することで実行できます。
DELETE FROM ProjectCustomFieldItems WHERE ProjectId = 114706 AND CustomFieldId = 44072 AND ItemId = 5
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 |
Returns data from project custom fields table.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM ProjectCustomFields WHERE ProjectId = 114706
挿入は、ProjectId、typeId およびName を指定することで実行できます。
INSERT INTO ProjectCustomFields (ProjectId, Name, typeId) VALUES ('114706', 'Milestone4', 1)
UPDATE ProjectCustomFields SET Name = 'Third' WHERE ProjectId = 114706 AND Id = 44203
削除は、IssueId AND ID を指定することで実行できます。
DELETE FROM ProjectCustomFields WHERE ProjectId = 114706 AND Id = 44204
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 |
Returns data from project issue types table.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM ProjectIssueTypes WHERE ProjectId = 114706
挿入は、ProjectId、Color およびName を指定することで実行できます。
INSERT INTO ProjectIssueTypes (ProjectId, Name, Color) VALUES ('114706', 'Sample', '#ff9200')
UPDATE ProjectIssueTypes SET Name = 'ytryet43' WHERE ProjectId = 114706 AND Id = 532089
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 |
Returns data from projects table.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
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
挿入は、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 Projects SET ProjectKey = 'UPDATED_KEY2', Name = 'UpdatedName2' WHERE Id = 112873
削除は、ID を指定することで実行できます。
DELETE FROM Projects WHERE Id = 113332
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 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
All | Boolean |
Returns data from project statuses table.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM ProjectStatuses WHERE ProjectId = 114706
挿入は、ProjectId およびColor を指定することで実行できます。
Color カラムに指定可能な値は#ea2c00、#e87758 、#e07b9a、#868cb7、#3b9dbd、#4caf93、#b0be3c、#eda62a、#f42858、#393939 です。
INSERT INTO ProjectStatuses (ProjectId, Name, Color) VALUES ('117182', 'Sample', '#3b9dbd')
UPDATE ProjectStatuses SET Name = 'Sample', color = '#ea2c00' WHERE ProjectId = 114706 AND Id = 18504
Name | Type | ReadOnly | Description |
Id [KEY] | Int | False | |
ProjectId [KEY] | Int | False | |
Name | String | False | |
Color | String | False | |
DisplayOrder | Int | True |
Returns data from project teams table.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM ProjectTeams WHERE ProjectId = 114706
挿入は、ProjectId およびTeamId を指定することで実行できます。
INSERT INTO ProjectTeams (ProjectId, TeamId) VALUES ('114706', '55083')
UPDATE は、このテーブルではサポートされていません。
削除は、IssueId AND ID を指定することで実行できます。
DELETE FROM ProjectTeams WHERE ProjectId = 114706 AND TeamId = 55082
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 |
Returns data from project users table.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM ProjectUsers WHERE ProjectId = 114706
挿入は、ProjectId およびUserId を指定することで実行できます。
INSERT INTO ProjectUsers (ProjectId, UserId) VALUES ('114706', '280728')
UPDATE は、このテーブルではサポートされていません。
削除は、ProjectId AND UserId を指定することで実行できます。
DELETE FROM ProjectUsers WHERE ProjectId = 114706 AND UserId = 280728
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 |
Returns data from project version milestones table.
projectversionmilestones
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM ProjectVersionMilestones WHERE ProjectId = 114706
挿入は、ProjectId およびName を指定することで実行できます。
INSERT INTO ProjectVersionMilestones (ProjectId, Name) VALUES ('114706', 'Milestone4')
UPDATE ProjectVersionMilestones SET Name = 'Sample' WHERE ProjectId = 114706 AND Id = 138889
削除は、ProjectId AND ID を指定することで実行できます。
DELETE FROM ProjectVersionMilestones WHERE ProjectId = 114706 AND Id = 138890
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 |
Returns data from pull request attachments table.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId、RepositoryId、PullRequestNumber が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM PullRequestAttachments WHERE ProjectId = '94706' AND RepositoryId = 21949 AND PullRequestNumber = 2
INSERT は、このテーブルではサポートされていません。
UPDATE は、このテーブルではサポートされていません。
削除は、ProjectId、RepositoryId、PullRequestNumber AND ID を指定することで実行できます。
DELETE FROM PullRequestAttachments WHERE ProjectId = 39470 AND RepositoryId = 21949 AND PullRequestNumber = 2 AND ID = 3
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 |
Returns data from pull request comments table.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId、RepositoryId、PullRequestNumber が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM PullRequestComments WHERE ProjectId = 114706 AND RepositoryId = 22462 AND PullRequestNumber = 2
挿入は、ProjectId、RepositoryId、PullRequestNumber およびContent を指定することで実行できます。
INSERT INTO PullRequestComments (ProjectId, RepositoryId, PullRequestNumber, Content) VALUES ('114706', '22462', '2', 'FirstComment')
UPDATE PullRequestComments SET Content = 'Third' WHERE ProjectId = 114706 AND RepositoryId = 22462 AND PullRequestNumber = 2 AND ID = 3
削除はこのテーブルではサポートされていません。
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 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
NotifiedUserId | String |
Returns data from project pull requests table.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId およびRepositoryId が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM PullRequests WHERE ProjectId = '114706' AND RepositoryId = 22462" SELECT * FROM PullRequests WHERE ProjectId = '114706' AND RepositoryId = 22462 AND Number = 2
挿入は、ProjectId、RepositoryId、Summary、description、base およびbranch を指定することで実行できます。
INSERT INTO PullRequests (ProjectId, RepositoryId, Summary, description, base, branch) VALUES ('114706', '22462', 'First', 'FirstPullReq', 'main', 'sample')
UPDATE PullRequests SET Summary = 'Third' WHERE ProjectId = 114706 AND RepositoryId = 22462 AND Number = 44203
削除はこのテーブルではサポートされていません。
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 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
NotifiedUserId | String | |
AttachmentId | String |
Returns data from watchings table.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはUserId が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Watchings WHERE UserId = '280688' SELECT * FROM Watchings WHERE Id = '145169'
挿入は、IssueId およびNote を指定することで実行できます。
INSERT INTO Watchings (IssueId, Note) VALUES ('6868643', 'Sample')
UPDATE Watchings SET Note = 'Third' WHERE Id = 145171
削除は、ID を指定することで実行できます。
DELETE FROM Watchings WHERE Id = 145170
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 |
Gets list of files attached to Wiki.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはWikiPageId が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM WikiPageAttachments WHERE WikiPageId = '639459'
INSERT は、このテーブルではサポートされていません。
UPDATE は、このテーブルではサポートされていません。
削除は、IssueId AND ID を指定することで実行できます。
DELETE FROM WikiPageAttachments WHERE WikiPageId = 639459 AND Id = 188522
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 |
Returns data from wiki pages table.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM WikiPages WHERE ProjectId = '114706' SELECT * FROM WikiPages WHERE Id = 639460
挿入は、ProjectId、Content、およびName を指定することで実行できます。
INSERT INTO WikiPages (ProjectId, Name, Content) VALUES ('114706', 'FirstWiki3', 'Sample Comment')
UPDATE WikiPages SET Name = 'UPDATED', Content = 'UPDATED' WHERE Id = 639460
削除は、ID を指定することで実行できます。
DELETE FROM WikiPages WHERE Id = 639461
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 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
MailNotify | Boolean |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
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. |
Returns data from issue categories table.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはIssueId が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM IssueCategories WHERE IssueId = 6840954
Name | Type | Description |
IssueId | String | |
Id [KEY] | Int | |
Name | String | |
DisplayOrder | String |
Returns data from issue comment change log table.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはIssueId が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM IssueCommentChangeLog WHERE IssueId = 6840954
Name | Type | Description |
IssueId | Int | |
CommentId | Int | |
AttachmentInfo | String | |
AttributeInfo | String | |
Field | String | |
NewValue | String | |
NotificationInfo | String | |
OriginalValue | String |
Returns data from issue comment notifications table.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはIssueId が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM IssueCommentNotifications WHERE IssueId = 6840954
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 |
Returns data from issue comment starts table.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはIssueId が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM IssueCommentStars WHERE IssueId = 6840954
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 |
Returns data from issue milestones table.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはIssueId が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM IssueMilestones WHERE IssueId = 6868745
Name | Type | Description |
IssueId | String | |
Id [KEY] | Int | |
Name | String | |
Description | String | |
Archived | Boolean | |
ProjectId | Int | |
ReleaseDueDate | Date | |
StartDate | Date | |
DisplayOrder | String |
Returns list of participants of an issue.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはIssueId が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM IssueParticipants WHERE IssueId = '6840954'
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 |
Returns data from issue versions table.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはIssueId が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM IssueVersions WHERE IssueId = 6868745
Name | Type | Description |
IssueId | String | |
Id [KEY] | Int | |
Name | String | |
Description | String | |
Archived | Boolean | |
ProjectId | Int | |
ReleaseDueDate | Date | |
StartDate | Date | |
DisplayOrder | String |
Returns licence.
Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。
Name | Type | Description |
Active | Boolean | |
AttachmentLimit | Int | |
AttachmentLimitPerFile | Int | |
AttachmentNumLimit | Int | |
Attribute | Boolean | |
AttributeLimit | Int | |
Burndown | Boolean | |
CommentLimit | Int | |
ComponentLimit | Int | |
FileSharing | Boolean | |
Gantt | Boolean | |
Git | Boolean | |
IssueLimit | Int | |
LicenceTypeId | Int | |
LimitDate | Date | |
NulabAccount | Boolean | |
ParentChildIssue | Boolean | |
PostIssueByMail | Boolean | |
ProjectGroup | Boolean | |
ProjectLimit | Int | |
PullRequestAttachmentLimitPerFile | Int | |
PullRequestAttachmentNumLimit | Int | |
RemoteAddress | Boolean | |
RemoteAddressLimit | Int | |
StartedOn | Datetime | |
StorageLimit | Int | |
Subversion | Boolean | |
SubversionExternal | Boolean | |
UserLimit | Int | |
VersionLimit | Int | |
WikiAttachment | Boolean | |
WikiAttachmentLimitPerFile | Int | |
WikiAttachmentNumLimit | Int |
Returns own notifications.
Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。
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 |
Returns data from priorities table.
Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。
Name | Type | Description |
Id [KEY] | Int | |
Name | String |
Returns recent update in the project.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM ProjectRecentUpdates WHERE ProjectId = 114706
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 |
Returns data from project team members table.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM ProjectTeamMembers WHERE ProjectId = 114706
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 |
Returns data from pull request comment changelog table.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId、RepositoryId、PullRequestNumber が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM PullRequestCommentChangeLog WHERE ProjectId = '114706' AND RepositoryId = 22462 AND PullRequestNumber = 2
Name | Type | Description |
ProjectId | Int | |
RepositoryId | Int | |
PullRequestNumber | Int | |
AttachmentInfo | String | |
AttributeInfo | String | |
Field | String | |
NewValue | String | |
NotificationInfo | String | |
OriginalValue | String |
Returns data from pull request comment notifications table.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId、RepositoryId、PullRequestNumber が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM PullRequestCommentNotifications WHERE ProjectId = '114706' AND RepositoryId = 22462 AND PullRequestNumber = 2
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 |
Returns data from pull request comment starts table.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId、RepositoryId、PullRequestNumber が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM PullRequestCommentStars WHERE ProjectId = '114706' AND RepositoryId = 22462 AND PullRequestNumber = 2
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 |
Returns data from project repositories table.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Repositories WHERE ProjectId = 117182 SELECT * FROM Repositories WHERE ProjectId = 117182 AND Id = 22862 SELECT * FROM Repositories WHERE ProjectId = 117182 AND Name = 'First'
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 |
Returns data from resolutions table.
Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。
Name | Type | Description |
Id [KEY] | Int | |
Name | String |
Returns information about your space.
Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。
Name | Type | Description |
SpaceKey | String | |
Name | String | |
OwnerId [KEY] | Int | |
Language | String | |
Timezone | String | |
ReportSendTime | Hour | |
TextFormattingRule | String | |
Created | Datetime | |
Updated | Datetime |
Returns information about space disk usage.
Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。
Name | Type | Description |
Capacity | String | |
Issue | String | |
Wiki | String | |
File | Int | |
Subversion | Int | |
Git | Int | |
GitLFS | Int | |
PullRequest | Int |
Returns information about space disk details usage.
Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。
Name | Type | Description |
ProjectId | String | |
File | Int | |
Git | Int | |
GitLFS | Int | |
Issue | String | |
Wiki | String | |
Subversion | Int |
Returns space notification.
Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。
Name | Type | Description |
Content | String | |
Updated | Datetime |
Returns recent updates in your space.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM SpaceUpdates WHERE Type = 13 SELECT * FROM SpaceUpdates WHERE Type IN (13, 5)
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 |
Returns data from team members table.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはTeamId が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM TeamMembers WHERE TeamId = 54836
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 |
Returns data from teams table.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Teams WHERE Id = 55081
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 |
Returns the list of stars that user received.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはUserId が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM UserReceivedStars WHERE UserId = 263366
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 |
Returns list of issues which the user viewed recently.
Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。
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 |
Returns list of projects which the user viewed recently.
Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。
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 |
Returns list of Wikis which the user viewed recently.
Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。
Name | Type | Description |
ProjectId | Int | |
Id [KEY] | Int | |
Name | String | |
Content | String | |
Created | Datetime |
Returns user recent updates.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはUserId が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
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)
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 |
Returns data from users table.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Users WHERE Id = 54836
Name | Type | Description |
Id [KEY] | Int | |
UserId | String | |
Name | String | |
NulabAccountName | String | |
NulabAccountID | String | |
NulabAccountUniqueId | String | |
RoleType | Int | |
Lang | String | |
MailAddress | String |
Returns history of Wiki page.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはWikiPageId が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM WikiPageHistory WHERE WikiPageId = '639459'
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 |
Returns list of stars received on the Wiki page.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはWikiPageId が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM WikiPageStars WHERE WikiPageId = '528251'
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 |
Returns list of tags that are used in the project.
Sync App は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でSync App 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM WikiPageTags WHERE ProjectId = '94706'
Name | Type | Description |
ProjectId | Int | |
Id [KEY] | Int | |
Name | String |
プロパティ | 説明 |
URL | Backlog アカウントのURL。 |
AuthScheme | Backlog に接続する際に使用する認証の種類。 |
ApiKey | API キーを使用すると、Backlog API へのリクエストを行うことができます。 |
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
プロパティ | 説明 |
LogModules | ログファイルに含めるコアモジュール。 |
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
プロパティ | 説明 |
IncludeCustomFields | 課題テーブルからカスタムフィールドを取得する場合は、True に設定します。 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
MaxThreads | 最大スレッド数。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
Pagesize | Backlog から返されるページあたりの結果の最大数。 |
ProjectId | 特定のプロジェクトのId。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
プロパティ | 説明 |
URL | Backlog アカウントのURL。 |
AuthScheme | Backlog に接続する際に使用する認証の種類。 |
ApiKey | API キーを使用すると、Backlog API へのリクエストを行うことができます。 |
Backlog アカウントのURL。
"https://{sample}.backlog.com" 形式のBacklog アカウントのURL。
Backlog に接続する際に使用する認証の種類。
API キーを使用すると、Backlog API へのリクエストを行うことができます。
API リクエストにAPI キーを追加してアカウントからデータを返します。
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。
OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。
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 |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロキシベースのファイアウォールで使われるプロトコル。
このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。
タイプ | デフォルトポート | 説明 |
TUNNEL | 80 | これが設定されている場合、Sync App はBacklog への接続を開き、プロキシを経由して通信が行われます。 |
SOCKS4 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。 |
SOCKS5 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
プロキシベースのファイアウォールの名前もしくはIP アドレス。
ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。
Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。
プロキシベースのファイアウォールのTCP ポート。
ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。
プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。
プロキシベースのファイアウォールへの認証に使われるパスワード。
このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
これは、システムプロキシ設定を使用するかどうかを示します。
これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。
SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。
ProxyServer プロキシが起動しているTCP ポート。
HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer プロキシへの認証で使われる認証タイプ。
この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。
Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
認証タイプは、次のどれかになります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer プロキシへの認証に使われるユーザー名。
ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。
ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。
user@domain domain\user
ProxyServer プロキシへの認証に使われるパスワード。
このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。
HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。
NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。
ProxyServer プロキシへの接続時に使用するSSL タイプ。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。
AUTO | デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。 |
ALWAYS | 接続は、常にSSL 有効となります。 |
NEVER | 接続は、SSL 有効になりません。 |
TUNNEL | 接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
ログファイルに含めるコアモジュール。
指定された(';' で区切られた)モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。
概要はログ ページを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
Sync App のスキーマファイル(テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル)を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\Backlog Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます:
Platform | %APPDATA% |
Windows | APPDATA 環境変数の値 |
Linux | ~/.config |
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
プロパティ | 説明 |
IncludeCustomFields | 課題テーブルからカスタムフィールドを取得する場合は、True に設定します。 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
MaxThreads | 最大スレッド数。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
Pagesize | Backlog から返されるページあたりの結果の最大数。 |
ProjectId | 特定のプロジェクトのId。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
最大スレッド数。
これらの隠しプロパティは特定のユースケースでのみ使用されます。
以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。
複数のプロパティをセミコロン区切りリストで指定します。
DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
Backlog から返されるページあたりの結果の最大数。
Pagesize プロパティは、Backlog から返されるページあたりの結果の最大数に影響を与えます。より大きい値を設定すると、1ページあたりの消費メモリが増える代わりに、パフォーマンスが向上する場合があります。
特定のプロジェクトのId。
特定のプロジェクトのId。
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。
カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。
また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。
次に例を示します。
{ "MyView": { "query": "SELECT * FROM Issues WHERE MyColumn = 'value'" }, "MyView2": { "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)" } }UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json指定されたパスは引用符で囲まれていないことに注意してください。