CData Sync App は、Jira データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Jira コネクタはCData Sync アプリケーションから使用可能で、Jira からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App API のバージョン2と3を利用しています。これは内部で管理されており、追加の設定は必要ありません。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
接続するには、URL をJira のエンドポイントに設定します。例えば、https://yoursitename.atlassian.net です。
デフォルトでは、Sync App はシステムフィールドのみ表示します。Issues のカスタムフィールドにアクセスするには、IncludeCustomFields をtrue に設定するか、Sync App スキーマを拡張してカスタムフィールドへのアクセスを設定します。(カスタムフィールド を参照してください。)カスタムフィールドが含まれる場合、サーバーの応答時間が著しく遅くなることがありますのでご注意ください。
PAT は各ユーザーによって作成されます。作成されると、自動的にユーザーと同じパーミッションレベルになります。ユーザーはAtlassian Settings メニューから、またはREST API を使用してPAT を作成できます。
Atlassian アプリケーションから:
次に、以下のJira Sync App プロパティを設定します。
Note: PAT はREST API を使用して作成することもできます。詳しくは、https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html でJira のPAT 作成についてのドキュメントを参照してください。
以下の手順は、すべてのOAuth フローでAuthScheme がOAuth に設定されていることを前提としています。
AuthScheme をAPIToken に設定し、User およびAPIToken を設定することで、任意のJira Cloud アカウントへの接続を確立できます。
Cloud インスタンスへのベーシック認証には、API トークンが必要です。API トークンを生成するには、Atlassian アカウントにログインして[セキュリティ設定]->[API トークン]->[API トークンを作成する]をクリックします。生成されたトークンが表示されます。
AuthScheme をBasic に設定することで、任意のJira Server インスタンスへの接続を確立できます。Server インスタンスに接続するには、User およびPassword を指定します。
(Note:パスワードはCloud アカウントへの接続には非推奨となり、Server インスタンスへの接続にのみ使用されるようになりました。)
AuthScheme をLDAP に設定することで、任意のJira Server インスタンスへの接続を確立できます。追加で、Jira インスタンスのURL、User、およびPassword を指定します。
(Note:LDAP 認証は現在、Cloud アカウントではサポートされていません。)
AuthScheme をCrowd に設定し、次の接続プロパティを設定します。
接続文字列の例:
AuthScheme=Crowd;Url=https://yoursitename.atlassian.net;SSOLoginURL='https://<authority>/crowd/console/secure/saml/sso.action';User=crowdUserName;Password=crowdPassword;SSOExchangeUrl=https://<authority of Jira instance>/plugins/servlet/samlconsumer;SSOAppName=CrowdAppName;SSOAppPassword=CrowdAppPassword;
Okta に接続するには、AuthScheme をOkta に設定し、次のプロパティを設定します。
Okta クライアントリクエストコンテキストをオーバーライドする信頼されたアプリケーションまたはプロキシを使用する場合、またはMFA を設定している場合は、Okta を使用して認証するためにSSOProperties を組み合わせて使用する必要があります。必要に応じて、以下のいずれかを設定します。
接続文字列の例:
AuthScheme=Okta;Url=https://yoursitename.atlassian.net;SSOLoginURL='https://example.okta.com/home/appType/0bg4ivz6cJRZgCz5d6/46';User=oktaUserName;Password=oktaPassword;SSOExchangeUrl=https://<authority of Jira instance>/plugins/servlet/samlconsumer;
これらの権限はアクセススコープによって定義され、アプリケーションがアクセス可能なデータと実行可能なアクションを決定します。
このトピックでは、Jira プロバイダーに必要なアクセススコープとエンドポイントドメインについての情報を提供します。
スコープは、ユーザーのデータへのアプリケーションによるアクセスを制限するための手段です。これは、アプリケーションがユーザーに代わって実行できる特定のアクションを定義します。
例えば、読み取り専用スコープではアプリケーションにデータの閲覧を許可し、フルアクセススコープではデータの変更を許可することができます。
Scopes can be controlled using the Scope connection property.
Jira Cloud has two types of scopes: Classic and Granular. Jira recommends Classic scopes when available.
| Scope | Type | Description |
| read:jira-user | Classic | View user information in Jira that the user has access to, including usernames, email addresses, and avatars. Required for read and write access. |
| read:jira-work | Classic | Read Jira project and issue data, search for issues and objects associated with issues like attachments and worklogs. Required for read and write access. |
| write:jira-work | Classic | Create and edit issues in Jira, post comments as the user, create worklogs, and delete issues. Required for write access. |
| manage:jira-project | Classic | Create and edit project settings and create new project-level objects (for example, versions and components). Required for write access. |
| manage:jira-configuration | Classic | Take Jira administration actions (for example, create projects and custom fields, view workflows, and manage issue link types). Required for write access. |
| read:application-role:jira | Granular | View application roles. Required for read and write access. |
| read:audit-log:jira | Granular | View audit logs. Required for read and write access. |
| read:dashboard:jira | Granular | View dashboards. Required for read and write access. |
| read:filter:jira | Granular | View filters. Required for read and write access. |
| read:filter.column:jira | Granular | View filter columns. Required for read and write access. |
| read:group:jira | Granular | View user groups. Required for read and write access. |
| read:issue:jira | Granular | View issues. Required for read and write access. |
| write:issue:jira | Granular | Create and update issues. Required for write access. |
| delete:issue:jira | Granular | Delete issues. Required for write access. |
| read:issue-meta:jira | Granular | View issue meta. Required for read and write access. |
| read:attachment:jira | Granular | View issue attachments. Required for read and write access. |
| write:attachment:jira | Granular | Create and update issue attachments. Required for write access. |
| delete:attachment:jira | Granular | Delete issue attachments. Required for write access. |
| read:comment:jira | Granular | View issue comments. Required for read and write access. |
| write:comment:jira | Granular | Create and update issue comments. Required for write access. |
| delete:comment:jira | Granular | Delete issue comments. Required for write access. |
| read:comment.property:jira | Granular | View issue comment properties. Required for read and write access. |
| write:comment.property:jira | Granular | Create and update issue comment properties. Required for write access. |
| delete:comment.property:jira | Granular | Delete issue comment properties. Required for write access. |
| read:field:jira | Granular | View fields. Required for read and write access. |
| write:field:jira | Granular | Create and update fields. Required for write access. |
| read:field.option:jira | Granular | View field options. Required for read and write access. |
| read:field.options:jira | Granular | Read field options. Required for read and write access. |
| read:custom-field-contextual-configuration:jira | Granular | Read custom field contextual configurations. Required for read and write access. |
| write:custom-field-contextual-configuration:jira | Granular | Save custom field contextual configurations. Required for write access. |
| read:field-configuration:jira | Granular | Read field configurations. Required for read and write access. |
| write:field-configuration:jira | Granular | Save field configurations. Required for write access. |
| read:issue-link:jira | Granular | View issue links. Required for read and write access. |
| read:issue-link-type:jira | Granular | View issue link types. Required for read and write access. |
| read:issue.property:jira | Granular | View issue properties. Required for read and write access. |
| read:priority:jira | Granular | View priorities. Required for read and write access. |
| read:resolution:jira | Granular | View resolutions. Required for read and write access. |
| read:issue-details:jira | Granular | View issue details. Required for read and write access. |
| read:issue-security-scheme:jira | Granular | View issue security schemes. Required for read and write access. |
| read:issue-type:jira | Granular | View issue types. Required for read and write access. |
| read:issue-type-scheme:jira | Granular | View issue type schemes. Required for read and write access. |
| read:issue-type.property:jira | Granular | View issue type properties. Required for read and write access. |
| read:issue.watcher:jira | Granular | View issue watchers. Required for read and write access. |
| read:issue-worklog:jira | Granular | View issue worklogs. Required for read and write access. |
| read:issue-field-values:jira | Granular | View issue field values. Required for read and write access. |
| read:issue-security-level:jira | Granular | View issue security levels. Required for read and write access. |
| read:issue-status:jira | Granular | View issue statuses. Required for read and write access. |
| read:issue.changelog:jira | Granular | View issue changelogs. Required for read and write access. |
| read:issue.transition:jira | Granular | View issue transitions. Required for read and write access. |
| delete:issue-type:jira | Granular | Delete issue types. Required for write access. |
| write:issue-type:jira | Granular | Create and update issue types. Required for write access. |
| read:user:jira | Granular | View users. Required for read and write access. |
| read:user.columns:jira | Granular | View user columns. Required for read and write access. |
| read:project:jira | Granular | View projects. Required for read and write access. |
| write:project:jira | Granular | Create and update projects. Required for write access. |
| delete:project:jira | Granular | Delete projects and their details, such as issue types, project lead, and avatars. Required for write access. |
| read:project-category:jira | Granular | View project categories. Required for read and write access. |
| read:project.component:jira | Granular | View project components. Required for read and write access. |
| write:project.component:jira | Granular | Create and update project components. Required for write access. |
| delete:project.component:jira | Granular | Delete project components. Required for write access. |
| read:project.property:jira | Granular | View project properties. Required for read and write access. |
| write:project.property:jira | Granular | Create and update project properties. Required for write access. |
| delete:project.property:jira | Granular | Delete project properties. Required for write access. |
| read:project-role:jira | Granular | View project roles. Required for read and write access. |
| write:project-role:jira | Granular | Create and update project roles. Required for write access. |
| delete:project-role:jira | Granular | Delete project roles. Required for write access. |
| read:project-version:jira | Granular | View project versions. Required for read and write access. |
| write:project-version:jira | Granular | Create and update project versions. Required for write access. |
| delete:project-version:jira | Granular | Delete project versions. Required for write access. |
| read:issue.time-tracking:jira | Granular | View issue time tracking. Required for read and write access. |
| write:issue.time-tracking:jira | Granular | Create and update issue time tracking. Required for write access. |
| read:user.property:jira | Granular | View user properties. Required for read and write access. |
| write:user.property:jira | Granular | Create and update user properties. Required for write access. |
| delete:user.property:jira | Granular | Delete user properties. Required for write access. |
| read:workflow:jira | Granular | View workflows. Required for read and write access. |
| read:workflow-scheme:jira | Granular | View workflow schemes. Required for read and write access. |
| read:status:jira | Granular | View statuses. Required for read and write access. |
| read:workflow.property:jira | Granular | View workflow properties. Required for read and write access. |
| read:project-type:jira | Granular | View project types. Required for read and write access. |
| read:project.email:jira | Granular | View project emails. Required for read and write access. |
| write:project.email:jira | Granular | Create and update project emails. Required for write access. |
| read:role:jira | Granular | View roles. Required for read and write access. |
| read:user-configuration:jira | Granular | View user configurations. Required for read and write access. |
| write:user-configuration:jira | Granular | Create and update user configurations. Required for write access. |
| delete:user-configuration:jira | Granular | Delete user configurations. Required for write access. |
| read:jql:jira | Granular | View JQL. Required for read and write access. |
| validate:jql:jira | Granular | Validate JQL. Required for read and write access. |
Jira Data Center has one type of scopes as shown in the table below.
| Scope | Description |
| READ | View projects and issues the user account can view, including any related items, such as dashboards, filters, attachments, or comments. Also view the user profile. |
| WRITE | Create, update, and delete projects and issues the user account can change, including any related items, such as dashboards, filters, attachments, or comments. Also change the user profile. |
| ADMIN | Perform most administrative functions on the entire Jira instance, excluding functions such as backups, imports, and infrastructure settings which are limited to system administrators. |
| SYSTEM_ADMIN | Perform all administrative functions on the entire Jira instance, including functions such as backups, imports, and infrastructure settings. Note: This scope is not utilized by CData Sync App. |
エンドポイントドメインとは、アプリケーションが認証、レコードの取得、その他の重要な操作を実行するために通信する必要がある特定のURL を指します。
これらのドメインを許可することで、アプリケーションとAPI 間のネットワークトラフィックがファイアウォールやセキュリティ設定によってブロックされることがなくなります。
Note: ほとんどのユーザーは特別な設定をする必要はありません。許可リストは通常、送信ネットワークトラフィックの制限など、厳格なセキュリティ対策が施された環境でのみ必要となります。
| Domain | Always Required | Description |
| <URL> | TRUE | The URL of your Jira instance. |
| api.atlassian.com | FALSE | The base URL of the Jira API. Required when AuthScheme is set to OAuth. |
| <SSOLoginURL> | FALSE | The URL of your SSO provider. Required when AuthScheme is set to OKTA or CROWD. |
| <SSOExchangeURL> | FALSE | Your SSO Exchange URL. Required when AuthScheme is set to OKTA or CROWD. |
このセクションでは、Jira Sync App の高度な機能を厳選して説明します。
Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
詳しくは、クエリ処理 を参照してください。
TLS を有効化するには、以下を設定します。
この設定により、Sync App はサーバーとのTLS ネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。
別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。
Jira Sync App はクライアント証明書の設定もサポートしています。次を設定すれば、クライアント証明書を使って接続できます。
HTTP プロキシへの認証には、以下のように設定します。
次のプロパティを設定します。
Sync App は、Jira API をリレーショナルテーブル、ビュー、およびストアドプロシージャとしてモデル化します。これにより、Jira Cloud アカウントやJira Server インスタンスへのデータベースライクな接続が可能になります。
デフォルトでは、テーブルスキーマおよびビュースキーマは、Jira エンティティのシステムフィールドのカラム動作を記述します。システムフィールド同様、Issues のカスタムフィールド にアクセスするには、接続文字列のIncludeCustomFields を設定できます。
You can use the following properties to gain more control over column names:
By default, all supported operators are passed directly to the Jira API, enabling efficient server-side filtering. However, when queries include invalid Id or Key values, this approach can lead to inconsistent outcomes. On Jira Cloud, depending on the UseJqlSearchEndpoint setting, invalid filters may return 0 results instead of throwing an error, whereas on Jira Data Center they may cause API errors. The KeyColumnOperators connection property allows you to control this behavior.
By default, the KeyColumnOperators is set to Server-Side.
To ensure consistent results, you can set the KeyColumnOperators connection property to Client-Side. In this mode, the following operators applied to the Id and Key columns are handled client-side by the Sync App rather than being included in the JQL sent to the Jira API:
By handling these operators client-side, the Sync App avoids strict server-side filtering rules that could cause the entire query to fail or return zero results due to a single invalid value. However, enabling this property can impact performance:
デフォルトでは、テーブルスキーマおよびビュースキーマは、システムフィールドのカラム動作のみを記述します。システムフィールド同様Issues のカスタムフィールドにアクセスするには、接続文字列のIncludeCustomFields を設定できます。 スキーマを拡張してカスタムフィールドへのアクセスを設定することもできます。 次のセクションでは異なるタイプのカスタムフィールドを表示する方法について説明します。
IncludeCustomFields プロパティをTrue に設定して、すべてのカスタムフィールドへのアクセスを公開します。
すべてのカスタムフィールドを公開することにより、パフォーマンスのオーバーヘッドが発生することに注意してください。これが目的のユースケースを実現する上での障害となる場合は、カスタムスキーマフィールドを使用して、公開するメタデータを細かく制御できます。
カスタムスキーマは、利用可能なすべてのカスタムフィールドメタデータのサブセットへの接続を有効にすることにより、Sync App のパフォーマンスを向上させます。
テーブルスキーマおよびビュースキーマは、.rsd コンフィギュレーションファイルで定義されます。シンプルな形式でカスタマイズは簡単です。スキーマファイルを保存するには、例えばIncludeCustomFields 接続プロパティを設定した状態で、CreateSchema を呼び出します。または、このセクションの最後にあるIssues スキーマのサンプルを適用します。
カスタムスキーマに接続するには、Location プロパティをスキーマファイルを有するフォルダに設定します。Sync App に含まれるスキーマはインストールフォルダのdb サブフォルダにあります。
カラムはスキーマファイルのapi:info セクションで定義されています。カスタムフィールドカラムを作成するためのテンプレートとして、既存のどのカラム定義を使っても構いません。すべてのカラム定義は少なくとも名前とデータ型が必須です。
カスタムフィールドは次の追加パラメータが必須です:
次のセクションで、異なるタイプのカラムに必要な値にXPath を指定する例を示します。
次の例は、シンプルなデータ型を持つカスタムフィールドのカラム定義です。
<attr name="MyCustomField" xs:type="string" other:relativexpath="customfield_10002" other:urlname="customfield_10002" desc="My custom field." />
以下は、オブジェクト型カスタムフィールドのJSON 表現です。
"customfield_10001" : {
"name" : "New name",
"description" : "desc"
}
次の例では、オブジェクト型のカスタムフィールドのフィールドをカラムとしてモデル化しています。
<attr name="MyCustomFieldName" xs:type="string" other:relativexpath="name" other:urlname="customfield_10001" desc="My custom field." />
<attr name="MyCustomFieldDesc" xs:type="string" other:relativexpath="description" other:urlname="customfield_10001" desc="My custom field." />
配列型のカスタムフィールドを表示するには、カスタムフィールドの定義で説明しているrelativexpath およびurlname プロパティに加えて、Sync App の処理操作にいくつか追加入力を渡す必要があります。api:set キーワードを使用して、次の変数を定義します。
以下は、Issues テーブルへのクエリの生のJSON レスポンスの配列型のカスタムフィールドの例です。Sync App のログ機能を使用して、JSON レスポンスを取得できます。Logfile をSync App が書き込み可能な場所に設定し、Verbosity を3 に設定します。
{
"expand": "schema,names",
"startAt": 0,
"maxResults": 50,
"total": 43,
"issues" : [{
"expand" : "operations,versionedRepresentations,editmeta,changelog,renderedFields",
"id" : "10042",
"self" : "https://cdatadev.atlassian.net/rest/api/2/issue/10042",
"key" : "TEST-43",
"fields" : {
"customfield_1002" : [{
"description" : "MyCF",
"id" : "10001",
"created" : "2016-22-08",
"author" : {
"name" : "admin",
"key" : "admin",
}
}, {
"description" : "MyCF2",
"id" : "10002",
"created" : "2016-22-08",
"author" : {
"name" : "admin",
"key" : "admin",
}
},
...
]
}
...
]
}
以下は、配列型のカスタムフィールドにネストされた値を表示するサンプルスキーマです。
<api:script xmlns:api="vhttp://apiscript.com/ns?v1">
<api:info title="CustomFieldSample" description="Custom field example.">
<attr name="IssueId" xs:type="string" other:absolutexpath="/json/issues/id" desc="The Id of the issue." other:urlname="id" references="Issues.Id" />
<attr name="IssueKey" xs:type="string" other:absolutexpath="/json/issues/key" desc="The key of the issue." other:urlname="key" references="Issues.Key" />
<attr name="CfId" xs:type="string" other:relativexpath="id" desc="The Id of the custom field." />
<attr name="CfDescription" xs:type="string" other:relativexpath="description" desc="The description of the custom field." />
<attr name="CfCreatedDate" xs:type="datetime" other:relativexpath="created" desc="The date the custom field was created." />
<input name="JQL" description="JQL(Jira Query Language) allows you to build structured queries." />
<input name="Rows@Next" description="This is used to page through multiple pages of results and should not be set manually." />
</api:info>
<!--XPath should stay the same. Do not change this. -->
<api:set attr="XPath" value="/json/issues" />
<!--Subrepeat elment XPath. Set this based on the custom field structure. -->
<api:set attr="SubRepeatElement" value="/json/issues/fields/customfield_10020"/>
<!--Choose a column that is in every custom field row. -->
<api:set attr="RepeatElement" value="CfId" />
<!--Required. Do not change this. -->
<api:set attr="IsSearch" value="true" />
<!--Set this to the name of the custom field plus the Id, separated by an underscore. -->
<api:set attr="JiraTableCode" value="customfield_10020" />
<api:script method="GET">
<api:call op="jiraadoSelect" output="out">
<api:push item="out" />
</api:call>
</api:script>
</api:script>
テーブルにはカスタムフィールド外のカラムも含まれています。absolutexpath カラムプロパティを使用してこれらを追加できます。このオプションのフィールドは、反復エレメントに相対的ではない絶対XPath を指定するために使用できます。
以下は、Issues テーブルのスキーマ例です。
<api:script xmlns:api="http://apiscript.com/ns?v1">
<api:info title="Issues" description="" other:isissues="true">
<attr name="Id" xs:type="int" key="true" readonly="true" description="The Id of the issue." other:urlname="id" other:aggregate="" other:supportedoperators="=,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN" other:fieldname="" other:insertfield="" other:relativexpath="id"/>
<attr name="Key" xs:type="string" columnsize="2000" readonly="true" description="The key of the issue." other:urlname="key" other:aggregate="" other:supportedoperators="=,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN" other:fieldname="" other:insertfield="" other:relativexpath="key"/>
<attr name="IssueTypeId" xs:type="string" columnsize="2000" readonly="false" description="The issue type Id." other:urlname="issuetype" other:aggregate="" other:supportedoperators="=,!=,IS,IS NOT,IN,NOT IN" other:fieldname="" other:insertfield="" other:relativexpath="fields/issuetype/id"/>
<attr name="IssueTypeName" xs:type="string" columnsize="2000" readonly="true" description="The issue type name." other:urlname="issuetype" other:aggregate="" other:supportedoperators="=,!=,IS,IS NOT,IN,NOT IN" other:fieldname="" other:insertfield="" other:relativexpath="fields/issuetype/name"/>
<attr name="ProjectId" xs:type="string" columnsize="2000" readonly="false" description="The project Id of the issue." other:urlname="project" other:aggregate="" other:supportedoperators="=,!=,IS,IS NOT,IN,NOT IN" other:fieldname="" other:insertfield="" other:relativexpath="fields/project/id"/>
<attr name="ProjectName" xs:type="string" columnsize="2000" readonly="true" description="The project name of the issue." other:urlname="project" other:aggregate="" other:supportedoperators="=,!=,IS,IS NOT,IN,NOT IN" other:fieldname="" other:insertfield="" other:relativexpath="fields/project/name"/>
<attr name="ProjectKey" xs:type="string" columnsize="2000" readonly="false" description="The project key of the issue." other:urlname="project" other:aggregate="" other:supportedoperators="=,!=,IS,IS NOT,IN,NOT IN" other:fieldname="" other:insertfield="" other:relativexpath="fields/project/key"/>
<attr name="ResolutionId" xs:type="string" columnsize="2000" readonly="false" description="The resolution Id of the issue." other:urlname="resolution" other:aggregate="" other:supportedoperators="=,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN" other:fieldname="" other:insertfield="" other:relativexpath="fields/resolution/id"/>
<attr name="ResolutionName" xs:type="string" columnsize="2000" readonly="false" description="The resolution name of the issue." other:urlname="resolution" other:aggregate="" other:supportedoperators="=,!=,IS,IS NOT,IN,NOT IN" other:fieldname="" other:insertfield="" other:relativexpath="fields/resolution/name"/>
<attr name="ResolutionDescription" xs:type="string" columnsize="2000" readonly="true" description="The resolution description of the issue." other:urlname="resolution" other:aggregate="" other:supportedoperators="" other:fieldname="" other:insertfield="" other:relativexpath="fields/resolution/description"/>
<attr name="ResolutionDate" xs:type="datetime" readonly="false" description="The resolution date of the issue." other:urlname="resolutiondate" other:aggregate="" other:supportedoperators="=,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN" other:fieldname="" other:insertfield="" other:relativexpath="fields/resolutiondate"/>
<attr name="Workratio" xs:type="long" readonly="false" description="The work ratio of the issue." other:urlname="workratio" other:aggregate="" other:supportedoperators="=,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN" other:fieldname="" other:insertfield="" other:relativexpath="fields/workratio"/>
<attr name="LastViewed" xs:type="datetime" readonly="true" description="The last time that the issue was viewed." other:urlname="lastViewed" other:aggregate="" other:supportedoperators="=,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN" other:fieldname="" other:insertfield="" other:relativexpath="fields/lastViewed"/>
<attr name="WatchCount" xs:type="int" readonly="true" description="The number of watches of the issue." other:urlname="watches" other:aggregate="" other:supportedoperators="" other:fieldname="" other:insertfield="" other:relativexpath="fields/watches/watchCount"/>
<attr name="IsWatching" xs:type="bool" readonly="false" description="Whether the currently authenticated user is watching the issue." other:urlname="watches" other:aggregate="" other:supportedoperators="" other:fieldname="" other:insertfield="" other:relativexpath="fields/watches/isWatching"/>
<attr name="Created" xs:type="datetime" readonly="true" description="The creation date of the issue." other:urlname="created" other:aggregate="" other:supportedoperators="=,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN" other:fieldname="" other:insertfield="" other:relativexpath="fields/created"/>
<attr name="PriorityId" xs:type="string" columnsize="2000" readonly="false" description="The priority Id of the issue." other:urlname="priority" other:aggregate="" other:supportedoperators="=,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN" other:fieldname="" other:insertfield="" other:relativexpath="fields/priority/id"/>
<attr name="PriorityName" xs:type="string" columnsize="2000" readonly="true" description="The priority name of the issue." other:urlname="priority" other:aggregate="" other:supportedoperators="=,!=,IS,IS NOT,IN,NOT IN" other:fieldname="" other:insertfield="" other:relativexpath="fields/priority/name"/>
<attr name="TimeSpentSeconds" xs:type="long" readonly="true" description="The time spent in seconds on the issue." other:urlname="timespent" other:aggregate="" other:supportedoperators="" other:fieldname="timetracking" other:insertfield="" other:relativexpath="fields/timetracking/timeSpentSeconds"/>
<attr name="TimeSpent" xs:type="string" columnsize="2000" readonly="true" description="The time spent on the issue." other:urlname="timespent" other:aggregate="" other:supportedoperators="=,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN" other:fieldname="timetracking" other:insertfield="" other:relativexpath="fields/timetracking/timeSpent"/>
<attr name="TimeRemainingEstimateSeconds" xs:type="long" readonly="true" description="The time estimate in seconds of the issue." other:urlname="timeestimate" other:aggregate="" other:supportedoperators="" other:fieldname="timetracking" other:insertfield="" other:relativexpath="fields/timetracking/remainingEstimateSeconds"/>
<attr name="TimeRemainingEstimate" xs:type="string" columnsize="2000" readonly="false" description="The time estimate of the issue." other:urlname="timeestimate" other:aggregate="" other:supportedoperators="=,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN" other:fieldname="timetracking" other:insertfield="" other:relativexpath="fields/timetracking/remainingEstimate"/>
<attr name="TimeOriginalEstimateSeconds" xs:type="long" readonly="true" description="The original time estimate in seconds of the issue." other:urlname="timeoriginalestimate" other:aggregate="" other:supportedoperators="" other:fieldname="timetracking" other:insertfield="" other:relativexpath="fields/timetracking/originalEstimateSeconds"/>
<attr name="TimeOriginalEstimate" xs:type="string" columnsize="2000" readonly="false" description="The original time estimate of the issue." other:urlname="timeoriginalestimate" other:aggregate="" other:supportedoperators="=,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN" other:fieldname="timetracking" other:insertfield="" other:relativexpath="fields/timetracking/originalEstimate"/>
<attr name="AggregateTimeSpent" xs:type="long" readonly="true" description="The aggregate time spent of the issue." other:urlname="aggregatetimespent" other:aggregate="" other:supportedoperators="" other:fieldname="" other:insertfield="" other:relativexpath="fields/aggregatetimespent"/>
<attr name="AggregateTimeOriginalEstimate" xs:type="long" readonly="true" description="The original aggregate time estimate of the issue." other:urlname="aggregatetimeoriginalestimate" other:aggregate="" other:supportedoperators="" other:fieldname="" other:insertfield="" other:relativexpath="fields/aggregatetimeoriginalestimate"/>
<attr name="AggregateTimeEstimate" xs:type="long" readonly="true" description="The aggregate time estimate of the issue." other:urlname="aggregatetimeestimate" other:aggregate="" other:supportedoperators="" other:fieldname="" other:insertfield="" other:relativexpath="fields/aggregatetimeestimate"/>
<attr name="AssigneeDisplayName" xs:type="string" columnsize="2000" readonly="true" description="Assignee display name." other:urlname="assignee" other:aggregate="" other:supportedoperators="" other:fieldname="" other:insertfield="" other:relativexpath="fields/assignee/displayName"/>
<attr name="AssigneeKey" xs:type="string" columnsize="2000" readonly="false" description="The assignee key of the issue." other:urlname="assignee" other:aggregate="" other:supportedoperators="=,!=,IS,IS NOT,IN,NOT IN" other:fieldname="" other:insertfield="" other:relativexpath="fields/assignee/key"/>
<attr name="AssigneeName" xs:type="string" columnsize="2000" readonly="true" description="The assignee name of the issue." other:urlname="assignee" other:aggregate="" other:supportedoperators="=,!=,IS,IS NOT,IN,NOT IN" other:fieldname="" other:insertfield="" other:relativexpath="fields/assignee/name"/>
<attr name="AssigneeEmail" xs:type="string" columnsize="2000" readonly="true" description="The assignee email of the issue." other:urlname="assignee" other:aggregate="" other:supportedoperators="=,!=,IS,IS NOT,IN,NOT IN" other:fieldname="" other:insertfield="" other:relativexpath="fields/assignee/emailAddress"/>
<attr name="Updated" xs:type="datetime" readonly="true" description="The updated date of the issue." other:urlname="updated" other:aggregate="" other:supportedoperators="=,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN" other:fieldname="" other:insertfield="" other:relativexpath="fields/updated"/>
<attr name="StatusId" xs:type="string" columnsize="2000" readonly="false" description="The status Id of the issue." other:urlname="status" other:aggregate="" other:supportedoperators="=,!=,IS,IS NOT,IN,NOT IN" other:fieldname="" other:insertfield="" other:relativexpath="fields/status/id"/>
<attr name="StatusName" xs:type="string" columnsize="2000" readonly="true" description="The status name of the issue." other:urlname="status" other:aggregate="" other:supportedoperators="=,!=,IS,IS NOT,IN,NOT IN" other:fieldname="" other:insertfield="" other:relativexpath="fields/status/name"/>
<attr name="Description" xs:type="string" columnsize="2000" readonly="false" description="The description of the issue." other:urlname="description" other:aggregate="" other:supportedoperators="LIKE,NOT LIKE,IS,IS NOT" other:fieldname="" other:insertfield="" other:relativexpath="fields/description"/>
<attr name="Summary" xs:type="string" columnsize="2000" readonly="false" description="The summary of the issue." other:urlname="summary" other:aggregate="" other:supportedoperators="LIKE,NOT LIKE,IS,IS NOT" other:fieldname="" other:insertfield="" other:relativexpath="fields/summary"/>
<attr name="CreatorDisplayName" xs:type="string" columnsize="2000" readonly="true" description="Issue creator display name." other:urlname="creator" other:aggregate="" other:supportedoperators="" other:fieldname="" other:insertfield="" other:relativexpath="fields/creator/displayName"/>
<attr name="CreatorName" xs:type="string" columnsize="2000" readonly="true" description="The creator name of the issue." other:urlname="creator" other:aggregate="" other:supportedoperators="=,!=,IS,IS NOT,IN,NOT IN" other:fieldname="" other:insertfield="" other:relativexpath="fields/creator/name"/>
<attr name="CreatorKey" xs:type="string" columnsize="2000" readonly="true" description="The creator key of the issue." other:urlname="creator" other:aggregate="" other:supportedoperators="=,!=,IS,IS NOT,IN,NOT IN" other:fieldname="" other:insertfield="" other:relativexpath="fields/creator/key"/>
<attr name="CreatorEmail" xs:type="string" columnsize="2000" readonly="true" description="The creator email of the issue." other:urlname="creator" other:aggregate="" other:supportedoperators="=,!=,IS,IS NOT,IN,NOT IN" other:fieldname="" other:insertfield="" other:relativexpath="fields/creator/emailAddress"/>
<attr name="ReporterDisplayName" xs:type="string" columnsize="2000" readonly="true" description="Issue reporter display name." other:urlname="reporter" other:aggregate="" other:supportedoperators="" other:fieldname="" other:insertfield="" other:relativexpath="fields/reporter/displayName"/>
<attr name="ReporterName" xs:type="string" columnsize="2000" readonly="true" description="The reporter name of the issue." other:urlname="reporter" other:aggregate="" other:supportedoperators="=,!=,IS,IS NOT,IN,NOT IN" other:fieldname="" other:insertfield="" other:relativexpath="fields/reporter/name"/>
<attr name="ReporterKey" xs:type="string" columnsize="2000" readonly="true" description="The reporter key of the issue." other:urlname="reporter" other:aggregate="" other:supportedoperators="=,!=,IS,IS NOT,IN,NOT IN" other:fieldname="" other:insertfield="" other:relativexpath="fields/reporter/key"/>
<attr name="ReporterEmail" xs:type="string" columnsize="2000" readonly="true" description="The reporter email of the issue." other:urlname="reporter" other:aggregate="" other:supportedoperators="=,!=,IS,IS NOT,IN,NOT IN" other:fieldname="" other:insertfield="" other:relativexpath="fields/reporter/emailAddress"/>
<attr name="Environment" xs:type="string" columnsize="2000" readonly="true" description="Search for issues where the environment contains particular text." other:urlname="reporter" other:aggregate="" other:supportedoperators="LIKE,NOT LIKE,IS,IS NOT" other:fieldname="" other:insertfield="" other:relativexpath="fields/environment"/>
<attr name="SecurityLevel" xs:type="string" columnsize="2000" readonly="true" description="Search for issues with a particular security level." other:urlname="reporter" other:aggregate="" other:supportedoperators="=,!=,IS,IS NOT,IN,NOT IN" other:fieldname="" other:insertfield="" other:relativexpath="fields/security/name"/>
<attr name="AggregateProgress" xs:type="long" readonly="true" description="The aggregate progress of the issue." other:urlname="aggregateprogress" other:aggregate="" other:supportedoperators="" other:fieldname="" other:insertfield="" other:relativexpath="fields/aggregateprogress/progress"/>
<attr name="TotalProgress" xs:type="long" readonly="true" description="The aggregate total progress of the issue." other:urlname="aggregateprogress" other:aggregate="" other:supportedoperators="" other:fieldname="" other:insertfield="" other:relativexpath="fields/aggregateprogress/total"/>
<attr name="Votes" xs:type="int" readonly="true" description="Votes of the issue." other:urlname="votes" other:aggregate="" other:supportedoperators="=,!=,>,>=,<,<=,IN,NOT IN" other:fieldname="" other:insertfield="" other:relativexpath="fields/votes/votes"/>
<attr name="HasVotes" xs:type="bool" readonly="true" description="The vote status of the issue." other:urlname="votes" other:aggregate="" other:supportedoperators="" other:fieldname="" other:insertfield="" other:relativexpath="fields/votes/hasVoted"/>
<attr name="DueDate" xs:type="datetime" readonly="false" description="The due date of the issue." other:urlname="duedate" other:aggregate="" other:supportedoperators="=,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN" other:fieldname="" other:insertfield="" other:relativexpath="fields/duedate"/>
<attr name="Labels" xs:type="string" columnsize="2000" readonly="false" description="The labels of an issue" other:urlname="labels" other:aggregate="" other:supportedoperators="=,!=,IS,IS NOT,IN,NOT IN" other:fieldname="" other:insertfield="" other:relativexpath="fields/labels"/>
<attr name="FixVersionsAggregate" xs:type="string" columnsize="2000" readonly="false" description="The fix versions of the issue" other:urlname="fixVersions" other:aggregate="/json/issues/fields/fixVersions" other:supportedoperators="" other:fieldname="" other:insertfield="fixVersions" other:relativexpath="fields/fixVersions"/>
<attr name="ComponentsAggregate" xs:type="string" columnsize="2000" readonly="false" description="Search for issues that belong to a particular component of a project. You can search by component name or component Id." other:urlname="components" other:aggregate="/json/issues/fields/components" other:supportedoperators="" other:fieldname="" other:insertfield="" other:relativexpath="fields/components"/>
<input name="JQL" xs:type="string" columnsize="2000" description="JQL (Jira Query Language) allows you to build structured queries." other:supportedoperators="IS,IS NOT" />
<input name="Attachments" xs:type="string" columnsize="2000" description="Search for issues that have or do not have attachments. This column can be queried with IS EMPTY or IS NOT EMPTY." other:supportedoperators="LIKE,NOT LIKE" />
<input name="Comment" xs:type="string" columnsize="2000" description="Search for issues that have a comment that contains particular text." other:urlname="" other:aggregate="" other:supportedoperators="=,!=,IS,IS NOT,IN,NOT IN"/>
<input name="Category" xs:type="string" columnsize="2000" description="Search for issues that belong to projects in a particular category." other:supportedoperators="=,!=,IS,IS NOT,IN,NOT IN"/>
<input name="SprintId" xs:type="integer" columnsize="2000" description="Search for issues that belongs to a specific sprint, by specifying the Id of the Sprint." other:supportedoperators="=,!=,IS,IS NOT,IN,NOT IN"/>
<input name="SprintName" xs:type="string" columnsize="2000" description="Search for issues that belongs to a specific sprint, by specifying the name of the Sprint." other:supportedoperators="=,!=,IS,IS NOT,IN,NOT IN"/>
<input name="Filter" xs:type="string" columnsize="2000" description="Search for issues of saved filters. This column can be queried with filter name or filter id." other:supportedoperators="=,!=,IN,NOT IN"/>
<input name="Rows@Next" desc="Identifier for the next page of results. Do not set this value manually." />
</api:info>
<api:script method="GET">
<api:call op="jiraadoSelect">
<api:push/>
</api:call>
</api:script>
<api:script method="POST">
<api:call op="jiraadoInsert">
<api:push/>
</api:call>
</api:script>
<api:script method="MERGE">
<api:call op="jiraadoUpdate">
<api:push/>
</api:call>
</api:script>
<api:script method="DELETE">
<api:call op="jiraadoDelete">
<api:push/>
</api:call>
</api:script>
</api:script>
Sync App はJira のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
| Name | Description |
| Attachments | Query, insert and delete the available Attachments in Jira. |
| Boards | Query, insert and delete the agile Boards in Jira. |
| Comments | Create, modify, delete and query the available Comment types in Jira. |
| Issues | Create, modify, delete and query Issues in Jira. |
| IssueTypes | Query the available Issue Types in Jira. |
| ProjectComponents | Query, create, modify, and delete the available Components of a project in Jira. |
| ProjectRoleActors | Query the actors who act in a role for specific projects in Jira. |
| Projects | Query, update, insert and delete the available Projects in Jira. |
| ProjectVersions | Query,create, modify and delete the available Versions of a project in Jira. |
| RoleActors | Query the default actors for project roles in Jira. |
| Roles | Query the available roles in Jira. |
| Sprints | Query,create, modify and delete the agile Sprints in Jira. |
| Users | Query the available Users in Jira. |
| Workflows | Query the available Workflows in Jira. |
| WorkflowSchemes | Create, modify, delete and query the available workflow schemes in Jira. |
| Worklogs | Create, modify, delete and query the available Worklogs in Jira. |
Query, insert and delete the available Attachments in Jira.
The Sync App uses the Jira API to process some of the filters.
The Sync App processes other filters within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM Attachments WHERE Id = 10003
To retrieve attachments linked to a specific issue, query the
Attachments table by specifying either the IssueId or IssueKey column.
SELECT * FROM Attachments WHERE IssueId = 123
To retrieve attachments linked to issues within a specific project, query the
Attachments table by specifying either the ProjectId or ProjectName column.
SELECT * FROM Attachments WHERE ProjectId = 10100
Use the JQL pseudocolumn for more complex filters on the issues to retrieve attachments from. For example, retrieve attachments of issues that were created after January 7th:
SELECT * FROM Attachments WHERE JQL = 'created > 2018-01-07'
Upload an attachment to an issue.
INSERT INTO Attachments (FilePath, IssueKey) VALUES ('C:/Users/User/Desktop/info.txt', 'SSFSF-1')
INSERT INTO Attachments (ContentEncoded, Name, IssueKey) VALUES ('U29tZSBjb250ZW50IGhlcmU=', 'Uploaded File', 'SSFSF-1')
Remove an attachment uploaded to any issue by specifying the Id of the attachment
DELETE FROM Attachments WHERE Id = 10003
| Name | Type | ReadOnly | References | SupportedOperators | Platform | Description |
| Id [KEY] | Integer | False | Common |
The Id of the attachment. | ||
| IssueId [KEY] | Integer | False |
Issues.Id | =,<>,>,>=,<,<=,IN,NOT IN | Common |
The Id of the issue. |
| IssueKey | String | False |
Issues.Key | =,<>,>,>=,<,<=,IN,NOT IN | Common |
The key of the issue. |
| ProjectId | Integer | True |
Projects.Id | =,IS,IS NOT,IN,NOT IN | Common |
The project Id of the attachment's issue. |
| ProjectName | String | True | =,IS,IS NOT,IN,NOT IN | Common |
The project name of the attachment's issue. | |
| IssueCreatedDate | Datetime | False | =,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common |
The date the attachment's issue was created. | |
| IssueUpdatedDate | Datetime | False | =,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common |
The date the attachment's issue was last updated. | |
| Filename | String | False | Common |
The filename of the attachment. | ||
| AuthorName | String | False | Common |
The name of the author of the attachment. | ||
| AuthorDisplayName | String | False |
Users.DisplayName | Common |
The display name of the author of the attachment. | |
| Created | Datetime | False | Common |
The creation date of the attachment. | ||
| Size | Integer | False | Common |
The size of the attachment. | ||
| MimeType | String | False | Common |
The MIME type of the attachment. | ||
| Content | String | False | Common |
The URI of the actual attached file. | ||
| Thumbnail | String | False | Common |
The thumbnail of the attachment. | ||
| AuthorAccountId | String | False |
Users.AccountId | Cloud |
The account Id of the author of the attachment. | |
| AuthorKey | String | False | Server |
The author key of the attachment. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| JQL | String |
JQL (Jira Query Language) allows you to build structured queries. |
| FilePath | String |
The path of the file to insert. |
| ContentEncoded | String |
BASE64 encoded content of the file to insert. |
| Name | String |
The name of the file to upload. Also the file extension should be specified. |
Query, insert and delete the agile Boards in Jira.
Sync App はJira API を使用して一部のフィルタを処理します。Sync App は他のフィルタをSync App 内で処理します。
サーバー側のフィルタを使用したクエリ例を次に示します。
SELECT * FROM Boards WHERE Id = 10022
その他のフィルタの使用:
SELECT * FROM Boards WHERE ProjectKeyOrId = 'QMTH' AND Type = 'scrum'
新しいボードを挿入するには、Name、Type、およびFilterId を指定する必要があります。
INSERT INTO Boards (Name, Type, FilterId) VALUES ('New board', 'scrum', 10200)
ボードを削除するには、Id を指定する必要があります。
DELETE FROM Boards WHERE Id = 130
| Name | Type | ReadOnly | References | SupportedOperators | Platform | Description |
| Id [KEY] | Integer | True | = | Common |
The Id of the board. | |
| Name | String | False | = | Common |
The name of the board. | |
| Type | String | False | = | Common |
The type of the board. 使用できる値は次のとおりです。scrum, kanban, simple |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| ProjectKeyOrId | String |
Filter the agile boards based on the project they are located in. |
| FilterId | String |
ID of a filter that the user has permissions to view. Not supported for next-gen boards. |
Create, modify, delete and query the available Comment types in Jira.
You can query this table to retrieve comments posted on all issues.
The Sync App uses the Jira API to process some of the filters.
The Sync App processes other filters within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM Comments
To retrieve comments associated with a specific issue, query the
Comments table by specifying either the IssueId or IssueKey column.
SELECT * FROM Comments WHERE IssueId = 10003
To retrieve comments associated to issues within a specific project, query the
Comments table by specifying either the ProjectId or ProjectName column.
SELECT * FROM Comments WHERE ProjectId = 10100
Additionally, the Created column can be used in the ORDER BY clause:
SELECT * FROM Comments WHERE IssueId = 10003 ORDER BY Created DESC
Post a comment as the logged in user. IssueId and Body are required.
INSERT INTO Comments (IssueId, Body) VALUES ('10003', 'Test Comment')
Only the body of the comment can be updated. The IssueId is required for an UPDATE as well.
UPDATE Comments SET Body = 'Updated Comment' WHERE Id = 10202 AND IssueId = 10003
Delete a comment posted in an issue by providing the Id and IssueId
DELETE FROM Comments WHERE Id = 10202 AND IssueId = 10003
| Name | Type | ReadOnly | References | SupportedOperators | Platform | Description |
| Id [KEY] | Integer | True | = | Common |
The Id of the comment. | |
| IssueId [KEY] | Integer | False |
Issues.Id | =,<>,>,>=,<,<=,IN,NOT IN | Common |
The Id of the issue. |
| IssueKey | String | False |
Issues.Key | =,<>,>,>=,<,<=,IN,NOT IN | Common |
The key of the issue. |
| ProjectId | Integer | True |
Projects.Id | =,IS,IS NOT,IN,NOT IN | Common |
The project Id of the comment's issue. |
| ProjectName | String | True | =,IS,IS NOT,IN,NOT IN | Common |
The project name of the comment's issue. | |
| IssueCreatedDate | Datetime | True | =,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common |
The date the comment's issue was created. | |
| IssueUpdatedDate | Datetime | True | =,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common |
The date the comment's issue was last updated. | |
| AuthorDisplayName | String | True |
Users.DisplayName | Common |
The display name of the author who made the comment. | |
| AuthorEmail | String | True |
Users.EmailAddress | Common |
The email address of the author who made the comment. | |
| UpdateDisplayName | String | True |
Users.DisplayName | Common |
The display name of the author who changed the comment. | |
| UpdateAuthorEmail | String | True |
Users.EmailAddress | Common |
The email address of the author who edited the comment. | |
| Body | String | False | Common |
The body of the comment. | ||
| RenderedBody | String | True | Common |
The rendered body of the comment. | ||
| Created | Datetime | True | Common |
The date the comment was created. | ||
| Updated | Datetime | True | Common |
The date the comment was updated. | ||
| VisibilityType | String | False | Common |
The visibility type of the comment. | ||
| VisibilityValue | String | False | Common |
The visibility value of the comment. | ||
| AuthorAccountName | String | True | Server |
The name of the author who made the comment. | ||
| AuthorAccountKey | String | True | Server |
The key of the author who made the comment. | ||
| UpdateAuthorAccountKey | String | True | Server |
The Id of the author who edited the comment. | ||
| UpdateAuthorAccountName | String | True | Server |
The name of the author who edited the comment. | ||
| AuthorAccountId | String | True |
Users.AccountId | Cloud |
The name of the author who made the comment. | |
| UpdateAuthorAccountId | String | True |
Users.AccountId | Cloud |
The Id of the author who edited the comment. | |
| ItemURL | String | True | Common |
A browsable link of the comment. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| JQL | String |
JQL (Jira Query Language) allows you to build structured queries. |
Create, modify, delete and query Issues in Jira.
このテーブルをクエリするときにカスタムフィールドのカラムと値(Sprint、Epic など)を動的に取得するためには、IncludeCustomFields 接続プロパティを'True' に設定する必要があります。
SQL とJQL (Jira Query Language) を使用して、Issues を検索できます。
SELECT * FROM Issues WHERE JQL = ' project = "New project" AND Status WAS "open" '
SELECT * FROM Issues WHERE ProjectId > 10001 OR Updated <= '2016/03/29 15:00'Sync App はJira API を使用して一部のフィルタを処理します。Sync App はクライアント側でSync App 内で他のフィルタを処理します。SupportEnhancedSQL をfalse に設定することで、クエリのクライアント側の実行をオフにできます。その場合、その他のカラムを参照する検索条件は一致しないデータを生成します。 例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Issues WHERE ProjectName = 'New project' AND JQL = ' status WAS "open" '
時間、日、週、分などを指定して、TimeSpent、OriginalEstimate、RemainingEstimate などの時間間隔のフィールドをフィルタリングします。
SELECT * FROM Issues WHERE RemainingEstimate = '1m 2d' AND TimeSpent = '3m 2w'
プロジェクトで新しい課題を作成します。挿入には、Project(ProjectId またはProjectKey を指定)、IssueType(IssueTypeId またはIssueTypeName を指定)、およびSummary が必要です。ProjectName を指定することもできますが、ProjectKey が属する値を見つけるためにサーバーへの追加リクエストが発生します。Project やIssueType によっては、さらに多くのフィールドが必要な場合があります。
INSERT INTO Issues (ProjectId, Summary, IssueTypeId, CustomField1) VALUES (10000, 'Desc from prod', 10100, 'test')
INSERT INTO Issues (ProjectKey, Summary, IssueTypeName, CustomField1) VALUES ('PROD', 'Desc from prod', 'Task', 'test')
ID を入力して既存の課題の情報を更新します。
UPDATE Issues SET Summary = 'Desc FROM prod', CustomField1 = 'ValidValue' WHERE Id = '10003'
また、特定の課題の集計フィールドを変更することもできます。FixVersionsAggregate、AffectedVersionsAggregate、ComponentsAggregate、およびIssueLinksAggregate を変更できます。これらのカラムの特別な入力を使用して、課題の適切なフィールドを割り当て、削除、および更新できます。 プロバイダークエリで使用するには、Jira アプリケーションで先にオブジェクトを作成しておく必要があります。NOTE:IssuelinksAggregate フィールドは入力の要件がわずかに異なります。以下で概要を説明します。
修正バージョンを追加する構造:
{ "add": {"name":"example"} }
or
{ "add": {"id":"1234"} }
サンプルクエリ:
UPDATE Issues SET FixVersionsAggregate = '{"add":{"name":"extra"}}' WHERE Id = 19683
一度に追加できるオブジェクトは1つのみですが、set コマンドを使用すると、複数のオブジェクトを割り当てることができます。
重要:set コマンドは、以前のすべてのオブジェクトを上書きします。つまり、以前のエントリは破棄され、
set コマンドで指定されたオブジェクトのみが課題に保存されます。set コマンドの後ろには配列が必要です。
{ "set": [ {"name":"New Component 1"}, {"name":"Old Component 2"} ] }
or
{ "set": [ {"id":"1234"}, {"name":"Old Component 2"} ] }
サンプルクエリは次のようになります。
UPDATE Issues SET ComponentsAggregate = '{ "set": [ {"id":"1234"}, {"name":"Old Components 2"} ] }' WHERE Id = 19683
remove コマンドを使用して、エントリを一度に1つずつ削除することもできます。
{ "remove": {"name":"example"} }
or
{ "remove": {"id":"1234"} }
UPDATE Issues SET AffectedVersionsAggregate = '{"remove":{"name":"extra"}}' WHERE id = 19683
これらのコマンドは、新しい課題を挿入するときにも適用されます。
INSERT INTO Issues (ProjectId, Summary, IssueTypeId, FixVersionsAggregate) VALUES (10000, 'Desc from prod', 10100, '{"add":{"name":"Example1"}}')
INSERT INTO Issues (ProjectId, Summary, IssueTypeId, FixVersionsAggregate) VALUES (10000, 'Desc from prod', 10100, '{"set":[{"name":"Example1"}]}')
IssueLinksAggregate では'add' 操作のみがサポートされており、リンクのタイプおよびリンクの方向('outwardIssue' か'inwardIssue' のいずれか1つ)を指定する必要があります。
使用可能なリンクタイプはBlocks、RootCause、Relates、Duplicate、およびCloners です。
{ "add":
{ "outwardIssue":
{"key":"COB-15"},
"type":
{"name":"Cloners"}
}
}
or
{ "add":
{ "inwardIssue":
{"key":"FIL-78"},
"type":
{"name":"Blocks"}
}
}
INSERT INTO Issues (ProjectId, Summary, IssueTypeId, FixVersionsAggregate) VALUES (10000, 'Desc from prod', 10100, '{"add":{"outwardIssue":{"key":"COB-15"},"type":{"name":"Cloners"}}}')
"UPDATE Issues SET IssuelinksAggregate = '{"add":{"inwardIssue":{"key":"FIL-1"},"type":{"name":"Blocks"}}}' WHERE Id = '22204'"
ID を指定して課題を削除します。完了していないサブタスクも削除されることに注意してください。
DELETE FROM Issues WHERE Id = '10003'
| Name | Type | ReadOnly | References | SupportedOperators | Platform | Description |
| Id [KEY] | Int | True | =,!=,>,>=,<,<=,IN,NOT IN | Common |
The Id of the issue. | |
| Key | String | True | =,!=,>,>=,<,<=,IN,NOT IN | Common |
The key of the issue. | |
| IssueTypeId | String | False | =,!=,IS,IS NOT,IN,NOT IN | Common |
The issue type Id. | |
| IssueTypeName | String | True | =,!=,IS,IS NOT,IN,NOT IN | Common |
The issue type name. | |
| ProjectId | String | False | =,!=,IS,IS NOT,IN,NOT IN | Common |
The project Id of the issue. | |
| ProjectName | String | True | =,!=,IS,IS NOT,IN,NOT IN | Common |
The project name of the issue. | |
| ProjectKey | String | False | =,!=,IS,IS NOT,IN,NOT IN | Common |
The project key of the issue. | |
| ParentId | Int | False | =,!=,IN,NOT IN | Common |
The Id of the issue's parent if the issue is a subtask. | |
| ParentKey | String | True | =,!=,IN,NOT IN | Common |
The key of the issue's parent if the issue is a subtask. | |
| ParentIssueTypeId | String | True | Common |
The issue type id of the issue's parent. | ||
| ParentIssueTypeName | String | True | Common |
The issue type name of the issue's parent. | ||
| ParentStatusId | String | True | Common |
The status id of the issue's parent. | ||
| ParentStatusName | String | True | Common |
The status name of the issue's parent. | ||
| ResolutionId | String | True | =,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common |
The resolution Id of the issue. | |
| ResolutionName | String | True | =,!=,IS,IS NOT,IN,NOT IN | Common |
The resolution name of the issue. | |
| ResolutionDescription | String | True | Common |
The resolution description of the issue. | ||
| ResolutionDate | Datetime | True | =,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common |
The resolution date of the issue. | |
| Workratio | Long | True | =,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common |
The work ratio of the issue. | |
| LastViewed | Datetime | True | =,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common |
The last time that the issue was viewed. | |
| WatchCount | Int | True | =,!=,>,>=,<,<=,IN,NOT IN | Common |
The number of watches of the issue. | |
| IsWatching | Bool | True | Common |
Whether the currently authenticated user is watching the issue. | ||
| Created | Datetime | True | =,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common |
The creation date of the issue. | |
| PriorityId | String | False | =,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common |
The priority Id of the issue. | |
| PriorityName | String | True | =,!=,IS,IS NOT,IN,NOT IN | Common |
The priority name of the issue. | |
| TimeSpentSeconds | Long | True | Common |
The time spent in seconds on the issue. | ||
| TimeSpent | String | True | =,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common |
The time spent on the issue. | |
| RemainingEstimateSeconds | Long | True | Common |
The time estimate in seconds of the issue. | ||
| RemainingEstimate | String | False | =,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common |
The time estimate of the issue. | |
| OriginalEstimateSeconds | Long | True | Common |
The original time estimate in seconds of the issue. | ||
| OriginalEstimate | String | False | =,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common |
The original time estimate of the issue. | |
| AggregateTimeSpent | Long | True | Common |
The aggregate time spent of the issue. | ||
| AggregateTimeOriginalEstimate | Long | True | Common |
The original aggregate time estimate of the issue. | ||
| AggregateTimeEstimate | Long | True | Common |
The aggregate time estimate of the issue. | ||
| AssigneeDisplayName | String | True | Common |
Assignee display name. | ||
| AssigneeKey | String | True | =,!=,IS,IS NOT,IN,NOT IN | Common |
[DEPRECATED] The assignee key of the issue. | |
| AssigneeAccountId | String | False | =,!=,IS,IS NOT,IN,NOT IN | Common |
The assignee account id. | |
| AssigneeName | String | False | =,!=,IS,IS NOT,IN,NOT IN | Common |
The assignee name of the issue. | |
| AssigneeEmail | String | True | =,!=,IS,IS NOT,IN,NOT IN | Common |
The assignee email of the issue. | |
| Updated | Datetime | True | =,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common |
The updated date of the issue. | |
| StatusId | String | True | =,!=,IS,IS NOT,IN,NOT IN | Common |
The status Id of the issue. | |
| StatusName | String | True | =,!=,IS,IS NOT,IN,NOT IN | Common |
The status name of the issue. | |
| StatusCategoryId | String | True | =,!=,IS,IS NOT,IN,NOT IN | Common |
The status category id of the issue. | |
| StatusCategoryKey | String | True | =,!=,IS,IS NOT,IN,NOT IN | Common |
The status category key of the issue. | |
| StatusCategoryName | String | True | =,!=,IS,IS NOT,IN,NOT IN | Common |
The status category name of the issue. | |
| Description | String | False | IS,IS NOT | Common |
The description of the issue. | |
| Summary | String | False | IS,IS NOT | Common |
The summary of the issue. | |
| CreatorDisplayName | String | True | Common |
Issue creator display name. | ||
| CreatorName | String | True | =,!=,IS,IS NOT,IN,NOT IN | Common |
The creator name of the issue. | |
| CreatorAccountId | String | True | =,!=,IS,IS NOT,IN,NOT IN | Common |
The creator account id. | |
| CreatorKey | String | True | =,!=,IS,IS NOT,IN,NOT IN | Common |
[DEPRECATED] The creator key of the issue. | |
| CreatorEmail | String | True | =,!=,IS,IS NOT,IN,NOT IN | Common |
The creator email of the issue. | |
| ReporterDisplayName | String | True | Common |
Issue reporter display name. | ||
| ReporterName | String | False | =,!=,IS,IS NOT,IN,NOT IN | Common |
The reporter name of the issue. | |
| ReporterKey | String | True | =,!=,IS,IS NOT,IN,NOT IN | Common |
[DEPRECATED]The reporter key of the issue. | |
| ReporterAccountId | String | False | =,!=,IS,IS NOT,IN,NOT IN | Common |
The reporter account id. | |
| ReporterEmail | String | True | =,!=,IS,IS NOT,IN,NOT IN | Common |
The reporter email of the issue. | |
| AggregateProgress | Long | True | Common |
The aggregate progress of the issue. | ||
| TotalProgress | Long | True | Common |
The aggregate total progress of the issue. | ||
| Votes | Int | True | =,!=,>,>=,<,<=,IN,NOT IN | Common |
Votes of the issue. | |
| HasVotes | Bool | True | Common |
The vote status of the issue. | ||
| DueDate | Date | False | =,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common |
The due date of the issue. | |
| Labels | String | False | =,!=,IS,IS NOT,IN,NOT IN | Common |
The labels of an issue. | |
| Environment | String | False | LIKE,NOT LIKE,IS,IS NOT | Common |
The environment of an issue. | |
| SecurityLevel | String | False | =,!=,IS,IS NOT,IN, NOT IN | Common |
The security level of an issue. | |
| FixVersionsAggregate | String | False | Common |
The fix versions of the issue | ||
| ComponentsAggregate | String | False | Common |
Aggregate list of components included in the issue. | ||
| IssueLinksAggregate | String | False | Common |
The issue links of the issue. | ||
| AffectedVersionsAggregate | String | False | Common |
The affected versions of the issue. | ||
| SubtasksAggregate | String | True | Common |
The subtasks of the issue. | ||
| CustomField1 | Any | False | Common |
A custom field created for the Issues. The custom fields will be listed if the 'IncludeCustomFields' connection property is set to true. | ||
| CustomField2 | Any | False | Common |
A custom field created for the Issues. The custom fields will be listed if the 'IncludeCustomFields' connection property is set to true. | ||
| ItemURL | String | True | Common |
A browsable link of the issue. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| JQL | String |
JQL (Jira Query Language) allows you to build structured queries. |
| Attachments | String |
Search for issues that have or do not have attachments. This column can be queried with IS EMPTY or IS NOT EMPTY. |
| Comment | String |
Search for issues that have a comment that contains particular text. |
| Category | String |
Search for issues that belong to projects in a particular category. |
| SprintId | Integer |
Search for issues that belongs to a specific sprint, by specifying the Id of the Sprint. |
| SprintName | String |
Search for issues that belongs to a specific sprint, by specifying the name of the Sprint. |
| Filter | String |
Search for issues of saved filters. This column can be queried with filter name or filter id. |
Query the available Issue Types in Jira.
Sync App はJira API を使用して一部のフィルタを処理します。
Sync App は他のフィルタをSync App 内で処理します。
SELECT * FROM IssueTypes WHERE Id = 3
挿入するにはName が必要です。次のクエリは、新しい課題タイプを作成します。
INSERT INTO IssueTypes (Name, Description, Subtask) VALUES ('Issue type name 3', 'test description', false)
課題タイプId を指定して更新できます。
UPDATE IssueTypes SET Name = 'Updated Name 3', Description = 'Updated description' WHERE Id = 10306
課題タイプId を指定して課題タイプを削除します。
DELETE FROM IssueTypes WHERE Id = 10306
| Name | Type | ReadOnly | References | SupportedOperators | Platform | Description |
| Id [KEY] | String | True | = | Common |
The Id of the issue type. | |
| Name | String | False | Common |
The name of the issue type. | ||
| Description | String | False | Common |
The description of the issue type. | ||
| Subtask | Boolean | False | Common |
The subtask of the issue type. Not applicable for update. | ||
| HierarchyLevel | Int | False | Cloud |
Hierarchy level of the issue type. | ||
| IconUrl | String | True | Common |
The icon URL of the issue type. | ||
| EntityId | String | True | Cloud |
Unique ID for next-gen projects. | ||
| Self | String | True | Common |
The URL of these issue type details. | ||
| Scope | String | True | Cloud |
Details of the next-gen projects the issue type is available in. | ||
| AvatarId | Int | True | Common |
The ID of the issue type's avatar. |
Query, create, modify, and delete the available Components of a project in Jira.
Sync App はJira API を使用して一部のフィルタを処理します。Sync App は他のフィルタをSync App 内で処理します。
例えば、次のクエリはサーバー側で処理されます。
各プロジェクトのコンポーネントを取得
SELECT * FROM ProjectComponents
コンポーネントのId 、またはコンポーネントが含まれているプロジェクトでフィルタリングすることもできます。
SELECT * FROM ProjectComponents WHERE Id = 10022
ProjectId の使用:
SELECT * FROM ProjectComponents WHERE ProjectId = 10027
ProjectKey の使用:
SELECT * FROM ProjectComponents WHERE ProjectKey = 'QMTH'
プロジェクトの新しいコンポーネントを作成します。ProjectKey およびName カラムが必須です。
INSERT INTO ProjectComponents (ProjectKey, Name, AssigneeType) VALUES ('COB', 'Testing Component', 'PROJECT_LEAD')
変更するコンポーネントのId カラムを指定して、プロジェクトコンポーネントを変更します。
UPDATE ProjectComponents SET LeadKey = 'newlead' WHERE Id = 10065
Id を指定して、プロジェクトのコンポーネントを削除します。
DELETE FROM ProjectComponents WHERE Id = 10065
| Name | Type | ReadOnly | References | SupportedOperators | Platform | Description |
| Id [KEY] | Integer | True | = | Common |
The Id of the component. | |
| ProjectId | Integer | True |
Projects.Id | =,IN | Common |
The selected project's id. |
| ProjectKey | String | False | =,IN | Common |
The selected project's key. | |
| Name | String | False | Common |
The name of the component. | ||
| Description | String | False | Common |
The description of the component. | ||
| LeadDisplayName | String | True | Common |
The display name of the component's lead. | ||
| LeadKey | String | False | Common |
The key of the component's lead. | ||
| AssigneeType | String | False | Common |
The type of the component's default assignee. 使用できる値は次のとおりです。PROJECT_DEFAULT, COMPONENT_LEAD, PROJECT_LEAD, UNASSIGNED | ||
| AssigneeDisplayName | String | True | Common |
The display name of the component's default assignee. | ||
| AssigneeKey | String | True | Common |
The key of the component's default assignee. | ||
| IsAssigneeTypeValid | Boolean | True | Common |
Whether the assignee type is valid. |
Query the actors who act in a role for specific projects in Jira.
The Sync App will use the Jira API to process filters that refer to ProjectId, ProjectKey and RoleId while the rest of the filter is executed client side within the Sync App. The Jira APIs support filters using the equals (=) and IN operator with ProjectId, ProjectKey and RoleId. Note that either ProjectId, ProjectKey or RoleId must be specified with a comparison type of equals (=) for SELECT SQL statement.
For example, the following queries are processed server side:
Retrieve all actors for a specific project:
SELECT * FROM ProjectRoleActors WHERE ProjectId = '10650'
SELECT * FROM ProjectRoleActors WHERE ProjectKey = 'MYP'
Retrieve all actors for a specific role in all projects:
SELECT * FROM ProjectRoleActors WHERE RoleId = '10329'
Retrieve all actors for a specific project:
SELECT * FROM ProjectRoleActors WHERE RoleId = '10329' AND ProjectId = '10650'
Retrieve all actors for specific projects:
SELECT * FROM ProjectRoleActors WHERE RoleId = '10329' AND ProjectId IN ('10650', '10651', '10652')
Retrieve all actors for specific roles in a project:
SELECT * FROM ProjectRoleActors WHERE RoleId IN ('10329', '10330', '10331') AND ProjectId = '10650'
Add a user as an actor to a role in a specific project by specifying the user's account Id.
INSERT INTO ProjectRoleActors (ProjectId, RoleId, ActorUserAccountId) VALUES ('10650', '10329', '63acbf336f068efec8f6e0c3')
Add a group as an actor to a role in a specific project by either specifying the group's Id or name.
INSERT INTO ProjectRoleActors (ProjectId, RoleId, ActorGroupGroupId) VALUES ('10650', '10329', '0eed15e3-80cc-41d0-ba1a-b408658caf4d')
INSERT INTO ProjectRoleActors (ProjectId, RoleId, ActorGroupName) VALUES ('10650', '10329', 'JohnTest1')
Add a user as an actor to a role by specifying the project, role and user's name.
INSERT INTO ProjectRoleActors (ProjectId, RoleId, UserName) VALUES ('10000', '10101', 'myuser')
Add a group as an actor to a role by specifying the project, role and group's name.
INSERT INTO ProjectRoleActors (ProjectId, RoleId, GroupName) VALUES ('10000', '10101', 'test-group')
Delete an actor from a role by specifying the project, role and the user's account Id, the group's name or the group's Id.
DELETE FROM ProjectRoleActors WHERE ProjectId = '10650' AND RoleId = '10329' AND ActorUserAccountId = '63acbf336f068efec8f6e0c3'
DELETE FROM ProjectRoleActors WHERE ActorGroupGroupId = '0eed15e3-80cc-41d0-ba1a-b408658caf4d' AND ProjectId = '10650' AND RoleId = '10330'
DELETE FROM ProjectRoleActors WHERE ActorGroupName = 'JohnTest1' AND ProjectId = '10650' AND RoleId = '10330'
Delete a default actor from a role by specifying the user's name or the group's name.
DELETE FROM ProjectRoleActors WHERE ProjectId = '10000' AND RoleId = '10101' AND UserName = 'myuser'
DELETE FROM ProjectRoleActors WHERE ProjectId = '10000' AND RoleId = '10101' AND GroupName = 'test-group'
| Name | Type | ReadOnly | References | SupportedOperators | Platform | Description |
| Id [KEY] | Long | False | Common |
The ID of the role actor. | ||
| DisplayName | String | False | Common |
The display name of the role actor. For users, depending on the user?s privacy setting, this may return an alternative value for the user's name. | ||
| Type | String | False | Common |
The type of role actor. | ||
| Name | String | False | Server |
The name of the role. | ||
| AvatarUrl | String | False | Common |
The avatar of the role actor. | ||
| ActorUserAccountId | String | False | Cloud |
Details of the user associated with the role. The account ID of the user, which uniquely identifies the user across all Atlassian products. | ||
| ActorGroupName | String | False | Cloud |
Details of the group associated with the role. The name of the group. As a group's name can change, use of groupId is recommended to identify the group. | ||
| ActorGroupDisplayName | String | False | Cloud |
Details of the group associated with the role. The display name of the group. | ||
| ActorGroupGroupId | String | False | Cloud |
Details of the group associated with the role. The ID of the group. | ||
| RoleId | Long | False |
Roles.Id | =,IN | Common |
The Id of the role. |
| ProjectId | Integer | False |
Projects.Id | =,IN | Common |
The Id of the project associated with the role. |
| ProjectKey | String | False |
Projects.Key | =,IN | Common |
The key of the project associated with the role. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| UserName | String |
Server platform only. Input for Insert and Delete statements. Details of the user associated with the role. The name of the user. |
| GroupName | String |
Server platform only. Input for Insert and Delete statements. Details of the group associated with the role. The name of the group. |
Query, update, insert and delete the available Projects in Jira.
Sync App はJira API を使用して一部のフィルタを処理します。
Sync App は他のフィルタをSync App 内で処理します。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Projects WHERE Id = 10000
挿入には、Key、Name、LeadName、およびProjectTypeKey が必要です。次のクエリは、新しいプロジェクトを作成します。
INSERT INTO Projects (Key, Name, LeadName, ProjectTypeKey, Description) VALUES ('EXE4', 'Inserted Project 4', 'admin', 'business', 'New business project.')
Id かKey のいずれかを指定して更新できます。
UPDATE Projects SET Description = 'Updated description', AssigneeType = 'UNASSIGNED', LeadName = 'admin2' WHERE Key = 'EXE4'
Id かKey のいずれかを指定してプロジェクトを削除できます。
DELETE FROM Projects WHERE Key = 'EXE4'
| Name | Type | ReadOnly | References | SupportedOperators | Platform | Description |
| Id [KEY] | Int | True | = | Common |
The Id of the project. | |
| Key | String | False | = | Common |
The key of the project. | |
| Name | String | False | Common |
The name of the project. | ||
| Description | String | False | Common |
The description of the project. | ||
| LeadEmailAddress | String | True |
Users.EmailAddress | Common |
The email address of the project lead. | |
| LeadDisplayName | String | True |
Users.DisplayName | Common |
The display name of the project lead. | |
| ComponentsAggregate | String | True | Common |
The components of the project. | ||
| IssueTypesAggregate | String | True | Common |
The issue types of the project. | ||
| Url | String | True | Common |
The URL of the project. | ||
| String | True | Common |
The email of the project. | |||
| AssigneeType | String | False | Common |
The assignee type of the project. | ||
| VersionsAggregate | String | True | Common |
The versions of the project. | ||
| RolesAggregate | String | True | Common |
The roles of the project. | ||
| ProjectKeysAggregate | String | True | Common |
The project keys of the project. | ||
| ProjectCategoryId | String | False | Common |
The Id of the project category. | ||
| ProjectCategoryName | String | True | Common |
The name of the project category. | ||
| ProjectCategoryDescription | String | True | Common |
The description of the project category. | ||
| ProjectTypeKey | String | False | Common |
The key of the project type. Not applicable for update. | ||
| LeadAccountId | String | False |
Users.AccountId | Cloud |
The Id of the project lead. | |
| LeadAccountKey | String | True |
Users.Key | Server |
The Key of the project lead. | |
| LeadAccountName | String | False |
Users.Name | Server |
The user name of the project lead. | |
| Simplified | Boolean | True | Cloud |
Whether the project is team-managed or not. | ||
| ItemURL | String | True | Common |
A browsable link of the project. |
Query,create, modify and delete the available Versions of a project in Jira.
Sync App はJira API を使用して一部のフィルタを処理します。Sync App は他のフィルタをSync App 内で処理します。 例えば、次のクエリはサーバー側で処理されます。
すべてのプロジェクトのバージョンを取得:
SELECT * FROM ProjectVersions
Id、ProjectKey、またはProjectId でフィルタをかけることもできます。次に例を示します。
SELECT * FROM ProjectVersions WHERE Id = 10022
ProjectId の使用:
SELECT * FROM ProjectVersions WHERE ProjectId = 10022
ProjectKey の使用:
SELECT * FROM ProjectVersions WHERE ProjectKey = 'QMTH'
プロジェクト全体で使用する新しいバージョンを作成します。Name と、ProjectId またはProjectKey いずれかのカラムが必須です。
INSERT INTO ProjectVersions (ProjectId, Name, Description, ReleaseDate, StartDate) VALUES ('10000', 'HR Component', 'Example version description', '2018-04-04', '2018-02-02')
変更するバージョンのId カラムを指定して、プロジェクトバージョンを変更します。
UPDATE ProjectVersions SET Released = 'true' WHERE Id = 10065
Id カラムを指定して、プロジェクトのバージョンを削除します。
DELETE FROM ProjectVersions WHERE Id = 10065
| Name | Type | ReadOnly | References | SupportedOperators | Platform | Description |
| Id [KEY] | Integer | True | = | Common |
The Id of the version. | |
| ProjectId | Integer | False |
Projects.Id | =,IN | Common |
The selected project's id. |
| ProjectKey | String | False | =,IN | Common |
The selected project's key. | |
| Name | String | False | Common |
The name of the version. | ||
| Description | String | False | Common |
The description of the version. | ||
| Released | Boolean | False | Common |
Whether the version has been released. | ||
| ReleaseDate | Date | False | Common |
Release date of the version. | ||
| StartDate | Date | False | Common |
Optional start date of the version. | ||
| UserStartDate | Date | False | Common |
The date on which work on this version is expected to start. | ||
| UserReleaseDate | Date | False | Common |
The date on which work on this version is expected to finish. | ||
| Overdue | Boolean | True | Common |
Whether the version is overdue for release. | ||
| Archived | Boolean | False | Common |
Whether the version has been archived. When a new version is created, this field is always set to False. |
Query the default actors for project roles in Jira.
The Sync App will use the Jira API to process filters that refer to RoleId while the rest of the filter is executed client side within the Sync App. The Jira APIs support filters using the equals (=) and IN operator with RoleId.
For example, the following queries are processed server side:
Retrieve all the default actors for all roles:
SELECT * FROM RoleActors
Retrieve all the default actors for a specific role:
SELECT * FROM RoleActors WHERE RoleId = '10002'
Add a user as a default actor to a role by specifying the user's account Id.
INSERT INTO RoleActors (ActorUserAccountId, RoleId) VALUES ('63acbf336f068efec8f6e0c3', '10326')
Add a group as a default actor to a role by either specifying the group's Id or name.
INSERT INTO RoleActors (ActorGroupGroupId, RoleId) VALUES ('ad8da7e1-7b66-408e-a61c-c4c8383ca5d1', '10326')
INSERT INTO RoleActors (ActorGroupName, RoleId) VALUES ('testGroupName', '10326')
Add a user as a default actor to a role by specifying the user's key.
INSERT INTO RoleActors (RoleId, UserKey) VALUES ('10102', 'JIRAUSER10001')
Add a group as a default actor to a role by specifying the group's name.
INSERT INTO RoleActors (RoleId, GroupName) VALUES ('10102', 'test-group')
Delete a default actor from a role by specifying the RoleId and the user's account Id, the group's name or the group's Id.
DELETE FROM RoleActors WHERE RoleId = '10326' AND ActorUserAccountId = '63acbf336f068efec8f6e0c3'
DELETE FROM RoleActors WHERE RoleId = '10325' AND ActorGroupName = 'Developers'
DELETE FROM RoleActors WHERE RoleId = '10325' AND ActorGroupGroupId = '6dd7f7e1-77f0-4cd1-b8e1-a069830a8f1d'
Delete a default actor from a role by specifying the user's key or the group's name.
DELETE FROM RoleActors WHERE RoleId = '10102' AND UserKey = 'JIRAUSER10001'
DELETE FROM RoleActors WHERE RoleId = '10102' AND GroupName = 'test-group'
| Name | Type | ReadOnly | References | SupportedOperators | Platform | Description |
| Id [KEY] | Long | False | Common |
The ID of the role actor. | ||
| DisplayName | String | False | Common |
The display name of the role actor. For users, depending on the user?s privacy setting, this may return an alternative value for the user's name. | ||
| Type | String | False | Common |
The type of role actor. | ||
| AvatarUrl | String | False | Common |
The avatar of the role actor. | ||
| ActorUserAccountId | String | False |
Users.AccountId | Cloud |
Details of the user associated with the role. The account ID of the user, which uniquely identifies the user across all Atlassian products. | |
| ActorGroupName | String | False |
Groups.Name | Cloud |
Details of the group associated with the role. The name of the group. As a group's name can change, use of groupId is recommended to identify the group. | |
| ActorGroupDisplayName | String | False | Cloud |
Details of the group associated with the role. The display name of the group. | ||
| ActorGroupGroupId | String | False |
Groups.Id | Cloud |
Details of the group associated with the role. The ID of the group. | |
| Name | String | False | Server |
The name of the role. | ||
| RoleId | Long | False |
Roles.Id | =,IN | Common |
The Id of the role. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| UserKey | String |
Server platform only. Input for Insert and Delete statements. Details of the user associated with the role. The key of the user. |
| GroupName | String |
Server platform only. Input for Insert and Delete statements. Details of the group associated with the role. The name of the group. |
Query the available roles in Jira.
Sync App はJira API を使用してId を参照するフィルタを処理します。その他のフィルタはクライアント側でSync App 内部で処理されます。Jira API は、Id でイコール(=)演算子を使用するフィルタをサポートしています。
例えば、次のクエリはサーバー側で処理されます。
すべての利用可能なロールを取得する:
SELECT * FROM Roles
特定のロールを取得する:
SELECT * FROM Roles WHERE Id = '10002'
ロールId を指定して、ロールの名前と説明を更新します。
UPDATE Roles SET Description = 'test_updated', Name = 'test_updated' WHERE Id = 10002
Id を指定して、ロールを削除します。
DELETE FROM Roles WHERE Id = '10002'
| Name | Type | ReadOnly | References | SupportedOperators | Platform | Description |
| Id [KEY] | Long | False | = | Common |
The Id of the role. | |
| Name | String | False | Common |
The name of the role. | ||
| Description | String | False | Common |
The description of the role. | ||
| Actors | String | False | Common |
The list of users who act in this role. | ||
| Scope | String | False | Cloud |
The scope of the role. | ||
| IsAdmin | Boolean | False | Cloud |
Whether this role is the admin role for the project. | ||
| IsDefault | Boolean | False | Cloud |
Whether this role is the default role for the project. |
Query,create, modify and delete the agile Sprints in Jira.
Jira アカウントのSprints のリストを取得するには、BoardSprints ビューをクエリできます。
Sync App はJira API を使用して一部のフィルタを処理します。Sync App はその他のフィルタをクライアント側で内部で実行します。例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Sprints WHERE Id = 122
SELECT * FROM Sprints WHERE Id IN ('1', '2', '3')
新しいスプリントを作成して、ボードにリンクします。新しいスプリントの挿入には、OriginBoardId およびName カラムが必須です。
INSERT INTO Sprints (OriginBoardId, Name, Goal, StartDate, EndDate) VALUES ('1', 'Inserted Sprint', 'Complete target', '2018-02-02', '2018-04-04')
スプリントのId を指定してスプリントを変更します。
UPDATE Sprints SET State = 'active' WHERE Id = 305
Id を指定して、スプリントを削除します。
DELETE FROM Sprints WHERE Id = 305
| Name | Type | ReadOnly | References | SupportedOperators | Platform | Description |
| Id [KEY] | Integer | True | =,IN | Common |
The Id of the sprint. | |
| Name | String | False | Common |
The name of the sprint. | ||
| State | String | False | = | Common |
The state of the sprint. A newly created sprint starts in the 'future' state. The state can only transition from 'future' to 'active', and from 'active' to 'closed' 使用できる値は次のとおりです。future, active, closed | |
| Goal | String | False | Common |
The goal assigned for the sprint. | ||
| OriginBoardId | Integer | False |
Boards.Id | Common |
The board Id the sprint originated from. This field cannot be updated | |
| StartDate | Datetime | False | Common |
The date when the sprint was started. | ||
| EndDate | Datetime | False | Common |
The date when the sprint has ended. | ||
| CompleteDate | Datetime | True | Common |
The date when the sprint was completed. |
Query the available Users in Jira.
Name、DisplayName、およびEmailAddress を一度に1つずつ指定します。
Jira はこれらのカラムに基づいたフィルタをActive またはIncludeInactive カラムと組み合わせてサポートします。例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Users WHERE Name LIKE '%John%' AND Active = false AND IncludeInactive = true
GroupName もしくはGroupId を指定して、特定のグループに属するユーザーをクエリします。
SELECT * FROM Users WHERE GroupName = 'Testing team' SELECT * FROM Users WHERE GroupId = '3dd7e7a1-77f7-4ac1-b8e1-a069830a7f1d'
すべてのグループとそのメンバーのリストを取得することもできます。
SELECT * FROM Users WHERE GroupName IN (SELECT Name FROM Groups)
IssueKey およびProjectKey 疑似カラムを使用して、特定の課題またはプロジェクト内の任意の課題を閲覧できるユーザーを検索します。
SELECT * FROM Users WHERE IssueKey = 'PRJ-1' SELECT * FROM Users WHERE ProjectKey = 'PRJ'
INSERT INTO Users(EmailAddress) VALUES ('[email protected]')
| Name | Type | ReadOnly | References | SupportedOperators | Platform | Description |
| GroupName | String | True | =,IN | Common |
The name of the group the user is part of. | |
| GroupId | String | True | =,IN | Common |
The Id of the group the user is part of. | |
| DisplayName | String | False | = | Common |
The display name of the user. | |
| EmailAddress | String | False | = | Common |
The email address of the user. | |
| Active | Bool | True | Common |
Indicates whether the user is active. | ||
| TimeZone | String | True | Common |
The time zone specified in the user's profile. | ||
| Locale | String | True | Common |
The locale of the user. | ||
| AccountId [KEY] | String | True | Cloud |
The accountId of the user, which uniquely identifies the user across all Atlassian products. | ||
| AccountType | String | False | Cloud |
The accountType of the user. | ||
| Products | String | False |
A delimited string of jira products to which the user has access to, ex: jira-core,jira-servicedesk,jira-product-discovery,jira-software | |||
| Key [KEY] | String | True | Server |
The key of the user. | ||
| Name | String | False | Server |
The name of the user. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| IssueKey | String |
Search for users who can browse a specific issue. |
| ProjectKey | String |
Search for users who can browse any issue in a project. |
Query the available Workflows in Jira.
Most filters are processed client side, though there are a few exceptions to this:
For example, the following queries are executed server side:
SELECT * FROM Workflows WHERE Name = 'abc'
SELECT * FROM Workflows WHERE Name IN ('abc','def','ghi')
SELECT * FROM Workflows WHERE IsActive = true AND Query = 'flow'
The Scope, Statuses, and Workflows columns accept aggregate values and are only used for inserting to and updating Workflows.
INSERT INTO Workflows(Scope, Statuses, Workflows) VALUES ('{"type":"GLOBAL"}', '[{"description":"","name":"To Do #2","statusCategory":"TODO","statusReference":"f0b24de5-25e7-4fab-ab94-63d81db6c0c0"}]', '[{"description":"","name":"Software workflow 1","startPointLayout":{"x":-100.00030899047852,"y":-153.00020599365235},"statuses":[{"layout":{"x":114.99993896484375,"y":-16},"properties":{},"statusReference":"f0b24de5-25e7-4fab-ab94-63d81db6c0c0"}],"transitions":[{"actions":[],"description":"","from":[],"id":"1","name":"Create","properties":{},"to":{"statusReference":"f0b24de5-25e7-4fab-ab94-63d81db6c0c0"},"triggers":[],"type":"INITIAL","validators":[]}]}]')", true)
| Name | Type | ReadOnly | References | SupportedOperators | Platform | Description |
| Id | String | False |
The entity ID of the workflow. | |||
| Name | String | False | IN |
The name of the workflow. | ||
| Description | String | False |
The description of the workflow. | |||
| Created | String | False |
The date when the workflow was created. | |||
| Updated | String | False |
The date when the workflow was updated. | |||
| IsDefault | Boolean | False |
Boolean indicating if the workflow is set as the default. | |||
| CanDelete | Boolean | False |
Boolean indicating whether the workflow can be deleted. | |||
| CanEdit | Boolean | False |
Boolean indicating whether the workflow can be edited. | |||
| IsActive | Boolean | False | = |
Filters active and inactive workflows. | ||
| Query | String | False | = |
String used to perform a case-insensitive partial match with workflow name. | ||
| Scope | String | False |
A JSON aggregate outlining the scope of the workflow. This column used exclusively for inserting to and updating workflows (does not return in SELECT query results). | |||
| Statuses | String | False |
A JSON aggregate outlining the statuses to associate with the workflows. This column used exclusively for inserting to and updating workflows (does not return in SELECT query results). | |||
| Workflows | String | False |
The details of the workflows to create. This column used exclusively for inserting to and updating workflows (does not return in SELECT query results). |
Create, modify, delete and query the available workflow schemes in Jira.
Note: This table is available only in the Jira Cloud version.
The Sync App will use the Jira API to process filters that refer to Id while the rest of the filter is executed client side within the Sync App. The Jira APIs support filters using the equals (=) operator with Id.
For example, the below queries are processed server side.
Retrieve all the available workflow schemes:
SELECT * FROM WorkflowSchemes
Retrieve a specific workflow scheme by Id:
SELECT * FROM WorkflowSchemes WHERE Id = 10400
Name is required to insert. The following query creates a new workflow scheme:
INSERT INTO WorkflowSchemes (name, Description, DefaultWorkflow, IssueTypeMappingsAggregate) VALUES('Jira Service Management IT Support Workflow', 'Incident Management workflow for Jira Service Management.', 'jira', '{"10201": "jira"}')
You can update by specifying the workflow scheme Id:
UPDATE WorkflowSchemes SET Name = 'Jira Updated Service Management IT Support Workflow', Description='Updated incident Management workflow for Jira Service Management.' WHERE Id =11526
Delete a workflow scheme by specifying the workflow scheme Id:
DELETE WorkflowSchemes WHERE Id=11526
| Name | Type | ReadOnly | References | SupportedOperators | Platform | Description |
| Id [KEY] | Integer | True | = | Cloud |
The ID of the workflow scheme. | |
| Name | String | False | Cloud |
The name of the workflow scheme. | ||
| Description | String | False | Cloud |
The description of the workflow scheme. | ||
| IssueTypeMappingsAggregate | String | False | Cloud |
The issue type to workflow mappings aggregate, where each mapping is an issue type ID and workflow name pair. | ||
| DefaultWorkflow | String | False | Cloud |
The name of the default workflow for the workflow scheme. | ||
| Self | String | True | Cloud |
The self/url column. |
Create, modify, delete and query the available Worklogs in Jira.
You can query this table to retrieve worklogs of Jira projects. The Sync App will use the Jira APIs to process filters based on the following columns and operators. The Sync App will execute other filters client-side. The below example queries are processed server side.
To retrieve worklogs linked to a specific issue, query the
Worklogs table by specifying either the IssueId or IssueKey column.
SELECT * FROM Worklogs WHERE IssueId = 123
To retrieve worklogs linked to issues within a specific project, query the
Worklogs table by specifying either the ProjectId or ProjectName column.
SELECT * FROM Worklogs WHERE ProjectId = 10100
IssueId, Started, and TimeSpentSeconds are required to insert. The following query logs work done for an issue:
INSERT INTO Worklogs (IssueId, Started, TimeSpentSeconds) VALUES (10003, '2017-03-20 20:00:00', 10000)
Both the worklog Id and IssueId are required to modify the worklog:
UPDATE Worklogs SET TimeSpentSeconds = 200000 WHERE Id = 10602 AND IssueId = 10003
Delete a worklog of an issue by providing the Id and IssueId:
DELETE FROM Worklogs WHERE Id = 10602 AND IssueId = 10003
This retrieves Ids of the deleted worklogs:
GETDELETED FROM Worklogs
| Name | Type | ReadOnly | References | SupportedOperators | Platform | Description |
| Id [KEY] | String | True | = | Common |
The Id of the worklog. | |
| IssueId [KEY] | Integer | False |
Issues.Id | =,<>,>,>=,<,<=,IN,NOT IN | Common |
The issue Id of the worklog. |
| IssueKey | String | False |
Issues.Key | =,IN,NOT IN | Common |
The key of the issue. |
| ProjectId | Integer | True |
Projects.Id | =,IS,IS NOT,IN,NOT IN | Common |
The project Id of the worklog's issue. |
| ProjectName | String | True | =,IS,IS NOT,IN,NOT IN | Common |
The project name of the worklog's issue. | |
| IssueCreatedDate | Datetime | True | =,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common |
The date the worklogs's issue was created. | |
| IssueUpdatedDate | Datetime | True | =,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common |
The date the worklogs's issue was last updated. | |
| AuthorDisplayName | String | True |
Users.DisplayName | =,!=,IS,IS NOT,IN,NOT IN | Common |
The display name of the author of the worklog. |
| UpdateAuthorDisplayName | String | True |
Users.DisplayName | Common |
The display name of the author who has updated the worklog. | |
| Comment | String | False | LIKE,NOT LIKE | Common |
The comment of the worklog. | |
| Created | Datetime | True | =,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common |
The date the worklog was created. | |
| Updated | Datetime | True | Common |
The update date of the worklog. | ||
| VisibilityType | String | False | Common |
The visibility type of the worklog. | ||
| VisibilityValue | String | False | Common |
The visibility value of the worklog. | ||
| Started | Datetime | False | Common |
The start date of the worklog. | ||
| TimeSpent | String | False | Common |
The spent time of the worklog. | ||
| TimeSpentSeconds | Long | False | Common |
The time spent in seconds for the worklog. | ||
| AuthorAccountId | String | True |
Users.AccountId | =,!=,IS,IS NOT,IN,NOT IN | Cloud |
The name of the author of the worklog. |
| UpdateAuthorAccountId | String | True |
Users.AccountId | Cloud |
The name of the author who has updated the worklog. | |
| AuthorAccountKey | String | True |
Users.Key | Server |
The key of the author of the worklog. | |
| AuthorAccountName | String | True |
Users.Name | =,!=,IS,IS NOT,IN,NOT IN | Server |
The name of the author of the worklog. |
| UpdateAuthorAccountKey | String | True |
Users.Key | Server |
The key of the author who has updated the worklog. | |
| UpdateAuthorAccountName | String | True |
Users.Name | Server |
The name of the author who has updated the worklog. | |
| ItemURL | String | True |
A browsable link of the worklog. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| Name | Description |
| AdvancedSettings | Query the application properties that are accessible on the Advanced Settings page. |
| ApplicationRoles | Query all application roles. In Jira, application roles are managed using the Application access configuration page. |
| Audit | Query the audit log of your Jira account. |
| BoardConfiguration | Query the agile Board Configuration in Jira. |
| BoardIssues | Query the agile Board Issues in Jira. |
| BoardSprints | Query the agile Sprints related to a Jira Board. |
| Configuration | Query the available Configurations in Jira. |
| CustomFieldContext | Returns a list of contexts for a custom field in Jira. |
| Dashboards | Query the available Dashboards in Jira. |
| Epics | Query all the Epics. |
| FavouriteFilters | Query the favourite Filters in Jira. |
| Fields | Query the available System and Custom Fields in Jira. |
| Filters | Query the set up Filters in Jira. This table is not available in Jira Server. |
| FiltersUsers | Query the users that filters are shared with. |
| Groups | Query the available Groups in Jira. |
| GroupsUsers | Query the users available in Jira and their associated groups. |
| IssueAffectedVersions | Query the Affected Versions of an issue in Jira. |
| IssueChangelogs | Query the available IssueChangelogs in Jira. |
| IssueComponents | Query the available IssueComponents in Jira. |
| IssueCustomFieldOptions | Query the set up Issue Custom Field Options in Jira. This resource is not available when using OAuth authentication. Specifying at least CUSTOMFIELDID, or ID is required. |
| IssueCustomFields | Query the available Custom Fields in Jira. |
| IssueFixVersions | Query the available IssueFixVersions in Jira. |
| IssueLinks | Query the available IssueLinks in Jira. |
| IssueLinkTypes | Lists all the issue link types. |
| IssueNavigatorDefaultColumns | Query the default issue navigator columns. |
| IssuePriorities | Query the list of all issue priorities. |
| IssueResolutions | Query the list of all issue resolution values. |
| IssueSecurityLevelMembers | Query the members of issue security level entities. |
| IssueSubtasks | Query the available IssueSubtasks in Jira. |
| IssueTransitions | Query the available IssueTransitions in Jira. |
| MyPermissions | Query the available Permissions of the current user in Jira. |
| PermissionGrants | Query the available permission grants for a permission scheme in Jira. |
| Permissions | Query the available Permissions in Jira. |
| PermissionSchemes | Query the available permission schemes in Jira. |
| ProjectCategories | Query all the project categories. |
| ProjectRoles | Query roles for all projects in Jira. |
| ProjectsIssueTypes | Query the available Issue Types of projects. |
| ProjectsPermissionScheme | Query the available permissions schemes for a project in Jira. |
| ProjectTypes | Query the list of all issue priorities. |
| SecurityLevels | Query all the created security levels. |
| SecuritySchemes | Query all the created security schemes. |
| SprintIssues | Query the agile Sprint Issues in Jira. |
| Statuses | Query the possible Statuses in Jira. |
| TimeTrackingProviders | Query the list of all time tracking providers. |
| Votes | Query the available Votes in Jira. |
| Watchers | Query the available Watchers in Jira. |
| WorkflowStatusCategories | Query the list of all status categories. |
| WorkflowStatuses | Query the list of all statuses associated with workflows. |
| WorklogDeleted | Queries the deleted worklogs in your Jira account. |
Query the application properties that are accessible on the Advanced Settings page.
SELECT * FROM AdvancedSettings
| Name | Type | References | SupportedOperators | Platform | Description |
| Id [KEY] | String | = | Common | The ID of the application property. | |
| Name | String | Common | The name of the application property. | ||
| Description | String | Common | The description of the application property. | ||
| Type | String | Common | The data type of the application property. | ||
| Value | String | Common | The new value. | ||
| DefaultValue | String | Common | The default value of the application property. | ||
| AllowedValues | String | Common | The allowed values, if applicable. |
Query all application roles. In Jira, application roles are managed using the Application access configuration page.
The Sync App uses the Jira API to process some of the filters.
The Sync App processes other filters within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM ApplicationRoles WHERE Key = 'jira-software'
| Name | Type | References | SupportedOperators | Platform | Description |
| Key [KEY] | String | = | Common | The key of the application role. | |
| Name | String | Common | The display name of the application role. | ||
| Groups | String | Common | The groups associated with the application role. | ||
| DefaultGroups | String | Common | The groups that are granted default access for this application role. | ||
| SelectedByDefault | Boolean | Common | Determines whether this application role should be selected by default on user creation. | ||
| NumberOfSeats | Integer | Common | The maximum count of users on your license. | ||
| RemainingSeats | Integer | Common | The count of users remaining on your license. | ||
| UserCount | Integer | Common | The number of users counting against your license. | ||
| UserCountDescription | String | Common | The type of users being counted against your license. | ||
| HasUnlimitedSeats | Boolean | Common | Determines whether this application role has unlimited seats. | ||
| Platform | Boolean | Common | Indicates if the application role belongs to Jira platform (jira-core). |
Query the audit log of your Jira account.
Sync App はJira API を使用して一部のフィルタを処理します。
Sync App は他のフィルタをSync App 内で処理します。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Audit WHERE Filter = 'ab'
| Name | Type | References | SupportedOperators | Platform | Description |
| RecordId | Integer | Common | The Id of the audit record. | ||
| Summary | String | Common | Summary of the change. | ||
| RemoteAddress | String | Common | The remote address of the record. | ||
| AuthorKey | String | Common | Key of the author that made the change. | ||
| Created | Datetime | Common | Date on when the change was made. | ||
| Category | String | Common | Category of the change. | ||
| EventSource | String | Common | What triggered the event. | ||
| Description | String | Common | Description of the change. | ||
| ItemId | String | Common | Unique identifier of the object item. | ||
| ItemName | String | Common | Name of the object item. | ||
| ItemTypeName | String | Common | Typename of the object item. | ||
| ItemParentId | String | Common | Identifier of the parent of the object item. | ||
| ItemParentName | String | Common | Parent name of the object item. | ||
| FieldName | String | Common | The name of the changed field. | ||
| ChangedFrom | String | Common | The updated value. | ||
| ChangedTo | String | Common | The previous value. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| Filter | String | Containing a string in at least one field. For example, providing up will return all audit records where one or more fields contains words such as update. |
Query the agile Board Configuration in Jira.
| Name | Type | References | SupportedOperators | Platform | Description |
| BoardId [KEY] | Integer |
Boards.Id | =,IN | The Id of the board. | |
| ColumnConfig | String | The column configuration lists the columns for the board, in the order defined in the column configuration. For each column, it shows the issue status mapping as well as the constraint type (Valid values: none, issueCount, issueCountExclSubs) for the min/max number of issues. | |||
| Filter | String | Reference to the filter used by the given board. | |||
| Name | String | The Name of the board. | |||
| CustomFieldIdRank | Integer | The CustomFieldId ranking. | |||
| Self | String | The self/url column. | |||
| SubQuery | String | JQL subquery used by the given board. | |||
| Type | String | The type of the board. | |||
| EstimationDisplayName | String | Display name of the field used for estimation. | |||
| EstimationFieldId | String | The Id of the field used for estimation. | |||
| EstimationType | String | Contains information about type of estimation used for the board. Valid values: none, issueCount, field. If the estimation type is |
Query the agile Board Issues in Jira.
Sync App はJira API を使用して一部のフィルタを処理します。 Sync App は他のフィルタをSync App 内で処理します。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM BoardIssues WHERE BoardId = '1' SELECT * FROM BoardIssues WHERE BoardId IN (70, 215)
| Name | Type | References | SupportedOperators | Platform | Description |
| Id [KEY] | Integer |
Issues.Id | =,IN | Common | The Id of the issue. |
| Key | String |
Issues.Key | =,IN | Common | The key of the issue. |
| BoardId [KEY] | Integer |
Boards.Id | =,IN | Common | The board the issue is included in. |
| IssueTypeId | String |
IssueTypes.Id | =,!=,IS,IS NOT,IN,NOT IN | Common | The issue type Id. |
| IssueTypeName | String | =,!=,IS,IS NOT,IN,NOT IN | Common | The issue type name. | |
| StatusId | Integer |
Statuses.Id | =,!=,IS,IS NOT,IN,NOT IN | Common | The issue status Id. |
| StatusName | String | =,!=,IS,IS NOT,IN,NOT IN | Common | The issue status name. | |
| ProjectId | Integer |
Projects.Id | =,!=,IS,IS NOT,IN,NOT IN | Common | The project Id of the issue. |
| ProjectKey | String |
Projects.Key | =,!=,IS,IS NOT,IN,NOT IN | Common | The project key of the issue. |
| ProjectName | String | =,!=,IS,IS NOT,IN,NOT IN | Common | The project name of the issue. | |
| ClosedSprintsAggregate | String | Common | The issue's previous sprints that have been closed. | ||
| Created | Datetime | =,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common | The creation date of the issue. | |
| Updated | Datetime | =,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common | The updated date of the issue. |
Query the agile Sprints related to a Jira Board.
Sync App はJira API を使用して一部のフィルタを処理します。Sync App は他のフィルタをSync App 内で処理します。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM BoardSprints WHERE BoardId = 122
BoardId の使用:
SELECT * FROM BoardSprints WHERE BoardId IN (12, 42)
かんばんタイプのボードはスプリントをサポートしていないため、次のようなクエリを使用すると、すべてのスプリントをより速く取得できます。
SELECT * FROM BoardSprints WHERE BoardId IN (SELECT Id FROM Boards WHERE Type != 'kanban')
| Name | Type | References | SupportedOperators | Platform | Description |
| Id [KEY] | Integer | Common | The Id of the sprint. | ||
| BoardId [KEY] | Integer |
Boards.Id | =,IN | Common | The board Id the sprint is in. |
| Name | String | Common | The name of the sprint. | ||
| State | String | = | Common | The state of the sprint. The sprint state can only transition from 'future' to 'active', and from 'active' to 'close'
使用できる値は次のとおりです。future, active, closed | |
| Goal | String | Common | The goal assigned for the sprint. | ||
| OriginBoardId | Integer |
Boards.Id | = | Common | The board Id the sprint originated from. This field cannot be updated |
| StartDate | Datetime | Common | The date when the sprint was started. | ||
| EndDate | Datetime | Common | The date when the sprint has ended. | ||
| CompleteDate | Datetime | Common | The date when the sprint was completed. |
Query the available Configurations in Jira.
Sync App は、このテーブルで指定されたすべてのフィルタをクライアント側でSync App 内で処理します。
SELECT * FROM Configuration
| Name | Type | References | SupportedOperators | Platform | Description |
| VotingEnabled | Boolean | Common | Configuration for voting. | ||
| WatchingEnabled | Boolean | Common | Configuration for watching. | ||
| UnassignedIssuesAllowed | Boolean | Common | Configuration to allow unassigned issues. | ||
| SubTasksEnabled | Boolean | Common | Configuration to enable subtasks. | ||
| IssueLinkingEnabled | Boolean | Common | Configuration to enable issue linking. | ||
| TimeTrackingEnabled | Boolean | Common | Configuration to enable time tracking. | ||
| AttachmentsEnabled | Boolean | Common | Configuration to enable attachments. | ||
| WorkingHoursPerDay | Double | Common | Configuration of the working hours per day. | ||
| WorkingDaysPerWeek | Double | Common | Configuration of the working days per week. | ||
| TimeFormat | String | Common | Configuration of the time format. | ||
| DefaultUnit | String | Common | Configuration of the default unit. |
Returns a list of contexts for a custom field in Jira.
| Name | Type | References | SupportedOperators | Platform | Description |
| Id [KEY] | String | The Id of the context. | |||
| CustomFieldId | String | = | The CustomFieldId. | ||
| Name | String | The Name of the context. | |||
| Description | String | The Description of the context. | |||
| IsGlobalContext | Boolean | Whether the context is global. | |||
| IsAnyIssueType | Boolean | Whether the context apply to all issue types. |
Query the available Dashboards in Jira.
Sync App はJira API を使用して一部のフィルタを処理します。Jira はId およびFilter カラムをサポートしますが、両方同時にはサポートしません。
Sync App は他のフィルタをSync App 内で処理します。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Dashboards WHERE Id = 10001疑似カラムFilter でフィルタをかけることもできます。
SELECT * FROM Dashboards WHERE Filter = 'favourite'
| Name | Type | References | SupportedOperators | Platform | Description |
| Id [KEY] | String | = | Common | The Id of the dashboard. | |
| Name | String | Common | The name of the dashboard | ||
| View | String | Common | The view URL of the dashboard. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| Filter | String | This is used to filter data. Valid values include favourite and my.
使用できる値は次のとおりです。favourite, my |
Query all the Epics.
Sync App はJira API を使用して一部のフィルタを処理します。
Sync App は他のフィルタをSync App 内で処理します。
例えば、次のクエリはサーバー側でフィルタリングされます。
SELECT * FROM Epics WHERE BoardId = 1
SELECT * FROM Epics WHERE BoardId IN (1, 2, 3)
特定のエピックのId またはKey を指定:
SELECT * FROM Epics WHERE Id = 10000
SELECT * FROM Epics WHERE Id IN (10000, 10001)
SELECT * FROM Epics WHERE Key = 'TSS-9151'
SELECT * FROM Epics WHERE Key IN ('TSS-9151', 'TSS-9152')
| Name | Type | References | SupportedOperators | Platform | Description |
| Id [KEY] | Integer | =,IN | Common | The Id of the Epic. | |
| Key [KEY] | String | =,IN | Common | The key of the Epic. | |
| BoardId [KEY] | Integer |
Boards.Id | =,IN | Common | The board Id the Epic is in. |
| Name | String | Common | The name of the Epic. | ||
| Done | Boolean | Common | Whether or not the Epic is done. | ||
| ColorKey | String | Common | The key of the Epic's color. | ||
| Summary | String | Common | A brief summary for the Epic. |
Query the favourite Filters in Jira.
| Name | Type | References | SupportedOperators | Platform | Description |
| Id [KEY] | Integer | Common | The Id of the favourite filter. | ||
| Name | String | Common | The name assigned to the favourite filter. | ||
| JQLExpression | String | Common | The JQL by which the favourite filter will search issues by. | ||
| Description | String | Common | The description given to the favourite filter. | ||
| OwnerDisplayName | String | Common | The display name of the user who owns the favourite filter. | ||
| OwnerAccountId | String | Cloud | The account ID of the user who owns the favourite filter. | ||
| Count | Integer | Cloud | How many users have this filter as a favourite. | ||
| OwnerKey | String | Server | The key of the user who owns the favourite filter. |
Query the available System and Custom Fields in Jira.
| Name | Type | References | SupportedOperators | Platform | Description |
| Id [KEY] | String | Common | The Id of the field. | ||
| Key | String | Common | The key of the field. | ||
| Name | String | Common | The name of the field. | ||
| Custom | Boolean | Common | A boolean indicating if the field is custom. | ||
| Orderable | Boolean | Common | A boolean indicating if the field is orderable. | ||
| Navigable | Boolean | Common | A boolean indicating if the field is navigable. | ||
| Searchable | Boolean | Common | A boolean indicating if the field is searchable. |
Query the set up Filters in Jira. This table is not available in Jira Server.
Sync App はJira API を使用して一部のフィルタを処理します。
Sync App は他のフィルタをSync App 内で処理します。
すべてのフィルタを取得:
SELECT * FROM Filters
特定のフィルタのId を指定:
SELECT * FROM Filters WHERE Id = 10001
| Name | Type | References | SupportedOperators | Platform | Description |
| Id [KEY] | Integer | = | Cloud | The Id of the filter. | |
| Name | String | Cloud | The name assigned to the filter. | ||
| JQLExpression | String | Cloud | The JQL by which the filter will search issues by. | ||
| Description | String | Cloud | The description given to the filter. | ||
| OwnerDisplayName | String | = | Cloud | The board Id the sprint originated from. | |
| Favourite | Boolean | Cloud | Whether you have set this filter as a favourite. | ||
| FavouritedCount | Integer | Cloud | How many users have this filter as a favourite. | ||
| SubscriptionsAggregate | String | Cloud | Collection of user subscriptions to the filter . | ||
| SharePermissionsAggregate | String | Cloud | Aggregate of share permissions to the filter. |
Query the users that filters are shared with.
| Name | Type | References | SupportedOperators | Platform | Description |
| AccountId [KEY] | String | = | The accountId of the user, which uniquely identifies the user across all Atlassian products. | ||
| FilterId [KEY] | String |
Filters.Id | = | The key of the project. | |
| DisplayName | String | = | The display name of the user. | ||
| EmailAddress | String | = | The email address of the user. | ||
| Active | Bool | Indicates whether the user is active. | |||
| TimeZone | String | The time zone specified in the user's profile. | |||
| Locale | String | The locale of the user. | |||
| AccountType | String | The accountType of the user. |
Query the available Groups in Jira.
Sync App はJira API を使用して一部のフィルタを処理します。Sync App は他のフィルタをSync App 内で処理します。
SELECT * FROM GROUPS WHERE Name <> 'administrator' AND CONTAINS(Name, 'jira')
| Name | Type | References | SupportedOperators | Platform | Description |
| Id [KEY] | String | Common | The Id of the group. | ||
| Name | String | =,!=,CONTAINS | Common | The name of the group. | |
| Html | String | Common | The HTML of the group. | ||
| LabelsAggregate | String | Common | The labels of the group. |
Query the users available in Jira and their associated groups.
The Sync App utilizes the Jira API to process WHERE clause conditions that include the following columns and supported operators. Any remaining filters are applied client-side by the Sync App.
To effectively query the GroupsUsers view, you must specify a value for either the GroupName column or the GroupId column (the latter is exclusive to cloud instances). If neither GroupName nor GroupId is provided, the Sync App will automatically iterate through all groups to retrieve all associated users, which may result in increased query times.
As shown in the examples below, to retrieve users who belong to a specific group, include either the GroupName or GroupId in your query.
SELECT * FROM GroupsUsers WHERE GroupId = '37f2babd-27ef-442e-8642-15b6cafba31c'
SELECT * FROM GroupsUsers WHERE GroupName = 'jira-software-users'
| Name | Type | References | SupportedOperators | Platform | Description |
| AccountId [KEY] | String | Cloud | The accountId of the user, which uniquely identifies the user across all Atlassian products. | ||
| Key [KEY] | String | Server | The key of the user. | ||
| GroupId [KEY] | String | = | Cloud | The group Id the user is part of. | |
| GroupName [KEY] | String | = | Common | The group name the user is part of. | |
| Name | String | Server | The name of the user. | ||
| DisplayName | String | Common | The display name of the user. | ||
| EmailAddress | String | Common | The email address of the user. | ||
| Active | Bool | Common | Indicates whether the user is active. | ||
| TimeZone | String | Common | The time zone specified in the user's profile. | ||
| Locale | String | Cloud | The locale of the user. | ||
| AccountType | String | Cloud | The accountType of the user. | ||
| Products | String | Cloud | A delimited string of jira products to which the user has access to, ex: jira-core,jira-servicedesk,jira-product-discovery,jira-software |
Query the Affected Versions of an issue in Jira.
SQL とJQL (Jira Query Language) を使用して、IssueAffectedVersions を検索できます。
Sync App はJira API を使用して一部のフィルタを処理します。
Sync App は他のフィルタをSync App 内で処理します。
IssueAffectedVersions で使用可能なカラムは、IssueId、IssueKey、およびJQL です次に例を示します。
SELECT * FROM IssueAffectedVersions WHERE IssueId > 10022 AND IssueId < 10090
| Name | Type | References | SupportedOperators | Platform | Description |
| VersionId [KEY] | String | =,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common | The Id of the affected version. | |
| IssueId [KEY] | Integer |
Issues.Id | =,<>,>,>=,<,<=,IN,NOT IN | Common | The issue Id of the affected version. |
| IssueKey | String |
Issues.Key | =,<>,>,>=,<,<=,IN,NOT IN | Common | The issue key of the affected version. |
| IssueCreatedDate | Datetime | =,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common | The date the affected version's issue was created. | |
| IssueUpdatedDate | Datetime | =,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common | The date the affected version's issue was last updated. | |
| Name | String | Common | The name of the affected version. | ||
| Archived | Boolean | Common | A boolean indicating if the affected is archived. | ||
| Released | Boolean | Common | A boolean indicating if the affected is released. | ||
| ReleaseDate | Date | Common | The release date. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| JQL | String | JQL (Jira Query Language) allows you to build structured queries. |
Query the available IssueChangelogs in Jira.
SQL とJQL (Jira Query Language) を使用して、IssueChangelogs を検索できます。
Sync App はJira API を使用して一部のフィルタを処理します。
Sync App は他のフィルタをSync App 内で処理します。
IssueChangelogs のサーバー側のフィルタリングで使用可能なカラムは、IssueId、IssueKey、ProjectId、ProjectKey、ProjectName およびJQL です。次に例を示します。
SELECT * FROM IssueChangelogs WHERE IssueId<>10022 SELECT * FROM IssueChangelogs WHERE ProjectKey = 'PRJ'
| Name | Type | References | SupportedOperators | Platform | Description |
| HistoryId | Integer | Common | The Id of the change. | ||
| IssueId | Integer |
Issues.Id | =,<>,>,>=,<,<=,IN,NOT IN | Common | The Id of the issue. |
| IssueKey | String |
Issues.Key | =,<>,>,>=,<,<=,IN,NOT IN | Common | The key of the issue. |
| Created | Datetime | Common | The creation date of the change. | ||
| IssueCreatedDate | Datetime | =,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common | The date the change's issue was created. | |
| IssueUpdatedDate | Datetime | =,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common | The date the change's issue was last updated. | |
| ItemField | String | Common | The item field of the change. | ||
| ItemFieldType | String | Common | The item field type of the change. | ||
| ItemFrom | String | Common | The item the issue changed from. | ||
| ItemFromString | String | Common | The description of the item the issue changed from. | ||
| ItemTo | String | Common | The item the issue changed to. | ||
| ItemToString | String | Common | The description of the item the issue changed to. | ||
| AuthorDisplayName | String | Common | The display name of the author who has updated the change. | ||
| AuthorAccountId | String | Cloud | The author name of the change. | ||
| AuthorName | String | Cloud | The author name of the change. | ||
| AuthorAccountKey | String | Server | The key of the author of the change. | ||
| AuthorAccountName | String | Server | The name of the author who has updated the change. | ||
| ProjectId | Integer |
Projects.Id | =,!=,IS,IS NOT,IN,NOT IN | Common | The project Id of the issue. |
| ProjectKey | String |
Projects.Key | =,!=,IS,IS NOT,IN,NOT IN | Common | The project key of the issue. |
| ProjectName | String | =,!=,IS,IS NOT,IN,NOT IN | Common | The project name of the issue. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| JQL | String | JQL (Jira Query Language) allows you to build structured queries. |
Query the available IssueComponents in Jira.
SQL とJQL (Jira Query Language) を使用して、IssueComponents を検索できます。
Sync App はJira API を使用して一部のフィルタを処理します。
Sync App は他のフィルタをSync App 内で処理します。
IssueComponents で使用可能なカラムは、IssueId、IssueKey、およびJQL です。次に例を示します。
SELECT * FROM IssueComponents WHERE IssueId > 10022 AND IssueId < 10090
| Name | Type | References | SupportedOperators | Platform | Description |
| Id [KEY] | String | =,<>,IS,IS NOT,IN,NOT IN | Common | The Id of the component. | |
| Name | String | Common | The name of the component. | ||
| IssueId [KEY] | Integer |
Issues.Id | =,<>,>,>=,<,<=,IN,NOT IN | Common | The issue Id of the component. |
| IssueKey | String |
Issues.Key | =,<>,>,>=,<,<=,IN,NOT IN | Common | The issue key of the component. |
| IssueCreatedDate | Datetime | =,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common | The date the component's issue was created. | |
| IssueUpdatedDate | Datetime | =,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common | The date the component's issue was last updated. | |
| Description | String | Common | The description of the component. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| JQL | String | JQL (Jira Query Language) allows you to build structured queries. |
Query the set up Issue Custom Field Options in Jira. This resource is not available when using OAuth authentication. Specifying at least CUSTOMFIELDID, or ID is required.
| Name | Type | References | SupportedOperators | Platform | Description |
| OptionId [KEY] | String | = | The ID of the custom field option. | ||
| Name | String | The Name of the custom field option. | |||
| CustomFieldId | String |
IssueCustomFields.CustomId | = | The ID of the custom field. | |
| Context | String | =,IN | The context of the custom field option. | ||
| Disabled | Boolean | Whether the option is disabled. |
Query the available Custom Fields in Jira.
| Name | Type | References | SupportedOperators | Platform | Description |
| Id [KEY] | String | Common | The Id of the custom field. | ||
| Key | String | Common | The key of the custom field. | ||
| CustomId | Long | The custom ID of the field. | |||
| Name | String | Common | The name of the custom field. | ||
| CDataName | String | Common | The name of the custom field on the Issues table provided by CData, when IncludeCustomFields=true | ||
| Orderable | Boolean | Common | A boolean indicating if the field is orderable. | ||
| Navigable | Boolean | Common | A boolean indicating if the field is navigable. | ||
| Searchable | Boolean | Common | A boolean indicating if the field is searchable. |
Query the available IssueFixVersions in Jira.
SQL とJQL (Jira Query Language) を使用して、IssueFixVersions を検索できます。
Sync App はJira API を使用して一部のフィルタを処理します。
Sync App は他のフィルタをSync App 内で処理します。
IssueFixVersions で使用可能なカラムは、IssueId、IssueKey、およびJQL です。次に例を示します。
SELECT * FROM IssueFixVersions WHERE IssueId > 10022 AND IssueId < 10090
| Name | Type | References | SupportedOperators | Platform | Description |
| VersionId [KEY] | String | =,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common | The Id of the fix version. | |
| IssueId [KEY] | Integer |
Issues.Id | =,<>,>,>=,<,<=,IN,NOT IN | Common | The issue Id of the fix version. |
| IssueKey | String |
Issues.Key | =,<>,>,>=,<,<=,IN,NOT IN | Common | The issue key of the fix version. |
| IssueCreatedDate | Datetime | =,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common | The date the fix version's issue was created. | |
| IssueUpdatedDate | Datetime | =,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common | The date the fix version's issue was last updated. | |
| Name | String | Common | The name of the fix version. | ||
| Archived | Boolean | Common | A boolean indicating if the fix is archived. | ||
| Released | Boolean | Common | A boolean indicating if the fix is released. | ||
| ReleaseDate | Datetime | Common | The release date. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| JQL | String | JQL (Jira Query Language) allows you to build structured queries. |
Query the available IssueLinks in Jira.
SQL とJQL (Jira Query Language) を使用して、IssueLinks を検索できます。
Sync App はJira API を使用して一部のフィルタを処理します。
Sync App は他のフィルタをSync App 内で処理します。
IssueLinks で使用可能なカラムは、IssueId、IssueKey、およびJQL です。次に例を示します。
SELECT * FROM IssueLinks WHERE IssueId > 10022 AND IssueId < 10090
| Name | Type | References | SupportedOperators | Platform | Description |
| Id [KEY] | String | Common | The Id of the link. | ||
| InwardIssueId | Integer |
Issues.Id | Common | The Id of the issue targeting this issue in the link. | |
| InwardIssueKey | String |
Issues.Key | Common | The Key of the issue targeting this issue in the link. | |
| OutWardIssueId | Integer |
Issues.Id | Common | The Id of the issue this link is targeting. | |
| OutwardIssueKey | String |
Issues.Key | Common | The Key of the issue this link is targeting. | |
| IssueId [KEY] | Integer |
Issues.Id | =,<>,>,>=,<,<=,IN,NOT IN | Common | The link's original issue Id. |
| IssueKey | String |
Issues.Key | =,<>,>,>=,<,<=,IN,NOT IN | Common | The link's original issue Key. |
| IssueCreatedDate | Datetime | =,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common | The date the link's issue was created. | |
| IssueUpdatedDate | Datetime | =,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common | The date the links's issue was last updated. | |
| TypeId | Id | Common | The Id of the link type. | ||
| TypeName | String | Common | The Name of the link type. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| JQL | String | JQL (Jira Query Language) allows you to build structured queries. |
Lists all the issue link types.
Sync App はJira API を使用して、Id カラムを参照するフィルタを処理します。
Sync App はその他のフィルタをクライアント側で内部で実行します。例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM IssueLinkTypes WHERE Id = '10003'
SELECT * FROM IssueLinkTypes WHERE Id IN ('10002', '10000')
| Name | Type | References | SupportedOperators | Platform | Description |
| Id [KEY] | String | =,IN | Common | Unique identifier of the issue link type. | |
| Name | String | Common | The name of the issue link type. | ||
| Inward | String | Common | The description of the issue link type inward link. | ||
| Outward | String | Common | The description of the issue link type outward link. |
Query the list of all issue priorities.
The Sync App uses the Jira API to process some of the filters.
The Sync App processes other filters within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM IssuePriorities WHERE Id = 1
| Name | Type | References | SupportedOperators | Platform | Description |
| Id [KEY] | String | = | Common | The ID of the issue priority. | |
| Name | String | Common | The name of the issue priority. | ||
| Description | String | Common | The description of the issue priority. | ||
| URL | String | Common | The URL of the issue priority. | ||
| StatusColor | String | Common | The color used to indicate the issue priority. | ||
| IconUrl | String | Common | The URL of the icon for the issue priority. |
Query the list of all issue resolution values.
The Sync App uses the Jira API to process some of the filters.
The Sync App processes other filters within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM IssueResolutions WHERE Id = 10000
| Name | Type | References | SupportedOperators | Platform | Description |
| Id [KEY] | String | = | Common | The ID of the issue resolution. | |
| Name | String | Common | The name of the issue resolution. | ||
| Description | String | Common | The description of the issue resolution. | ||
| URL | String | Common | The URL of the issue resolution. |
Query the members of issue security level entities.
| Name | Type | References | SupportedOperators | Platform | Description |
| Id [KEY] | String | = | The ID of the issue security level member. | ||
| IssueSecurityLevelId | String | = | The ID of the issue security level. | ||
| IssueSecuritySchemeId | String | = | The ID of the issue security scheme. | ||
| HolderParameter | String | As a group's name can change, use of value is recommended. The identifier associated with the type value that defines the holder of the permission. | |||
| HolderType | String | The type of the permission holder. | |||
| HolderValue | String | The identifier associated with the type value that defines the holder of the permission. |
Query the available IssueSubtasks in Jira.
SQL とJQL (Jira Query Language) を使用して、IssueSubtasks を検索できます。
Sync App はJira API を使用して一部のフィルタを処理します。
Sync App は他のフィルタをSync App 内で処理します。
IssueSubtasks で使用可能なカラムは、IssueId、IssueKey、およびJQL です。次に例を示します。
SELECT * FROM IssueSubtasks WHERE IssueId = 10009 AND JQL = 'creator = john'
| Name | Type | References | SupportedOperators | Platform | Description |
| SubtaskId [KEY] | String | Common | The Id of the subtask. | ||
| SubtaskKey | String | Common | The key of the subtask. | ||
| IssueId | Integer |
Issues.Id | =,<>,>,>=,<,<=,IN,NOT IN | Common | The Id of the parent issue. |
| IssueKey | String |
Issues.Key | =,<>,>,>=,<,<=,IN,NOT IN | Common | The key of the parent issue. |
| IssueCreatedDate | Datetime | =,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common | The date the subtask's issue was created. | |
| IssueUpdatedDate | Datetime | =,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common | The date the subtask's issue was last updated. | |
| Summary | String | Common | The summary of the subtask. | ||
| TypeId | String |
IssueTypes.Id | Common | The issue type Id of the subtask. | |
| TypeName | String |
IssueTypes.Name | Common | The issue type name of the subtask. | |
| TypeDescription | String |
IssueTypes.Description | Common | The issue type description of the subtask. | |
| TypeSubtask | Boolean |
IssueTypes.Subtask | Common | A boolean indicating if the issue is a subtask. | |
| PriorityId | String | Common | The priority Id of the subtask. | ||
| PriorityName | String | Common | The priority name of the subtask. | ||
| StatusId | String | Common | The status Id of the subtask. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| JQL | String | JQL (Jira Query Language) allows you to build structured queries. |
Query the available IssueTransitions in Jira.
SQL とJQL (Jira Query Language) を使用して、IssueTransitions を検索できます。
Sync App はJira API を使用して一部のフィルタを処理します。
Sync App は他のフィルタをSync App 内で処理します。
IssueTransitions で使用可能なカラムは、IssueId、IssueKey、およびJQL です。次に例を示します。
SELECT * FROM IssueTransitions WHERE JQL = 'id=10022'
| Name | Type | References | SupportedOperators | Platform | Description |
| Id [KEY] | String | Common | The Id of the transition. | ||
| IssueId [KEY] | Integer |
Issues.Id | =,<>,>,>=,<,<=,IN,NOT IN | Common | The Id of the issue. |
| IssueKey | String |
Issues.Key | =,<>,>,>=,<,<=,IN,NOT IN | Common | The key of the issue. |
| IssueCreatedDate | Datetime | =,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common | The date the transition's issue was created. | |
| IssueUpdatedDate | Datetime | =,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common | The date the transition's issue was last updated. | |
| HasScreen | String | Common | Whether the transition has a screen. | ||
| Name | String | Common | The name of the transition. | ||
| ToDescription | String | Common | The description of the status the issue is transitioning to. | ||
| ToId | String | Common | The Id of the status the issue is transitioning to. | ||
| ToName | String | Common | The name of the status the issue is transitioning to. | ||
| StatusCategoryId | String | Common | The status category Id of the transition. | ||
| StatusCategoryKey | String | Common | The status category key of the transition. | ||
| StatusCategoryName | String | Common | The status category name of the transition. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| JQL | String | JQL (Jira Query Language) allows you to build structured queries. |
Query the available Permissions of the current user in Jira.
Sync App は、このテーブルで指定されたすべてのフィルタをクライアント側でSync App 内で処理します。
SELECT * FROM MyPermissions
| Name | Type | References | SupportedOperators | Platform | Description |
| Id [KEY] | Integer | Common | The Id of the permission. | ||
| Key [KEY] | String | Common | The key of the permission. | ||
| Name | String | Common | The name of the permission. | ||
| Type | String | Common | The type of the permission. | ||
| Description | String | Common | The description of the permission. | ||
| HavePermission | Boolean | Common | Boolean indicating if the permission is set or not. | ||
| DeprecatedKey | Boolean | Common | Boolean indicating if the permission is deprecated. | ||
| Permissions | String | = | Common | Permissions as comma seperated values. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| ProjectKey | String | The key of the project associated with the permission. | |
| ProjectId | String | The Id of the project associated with the permission. | |
| IssueKey | String | The key of the issue associated with the permission. | |
| IssueId | String | The Id of the issue associated with the permission. |
Query the available permission grants for a permission scheme in Jira.
| Name | Type | References | SupportedOperators | Platform | Description |
| PermissionSchemeId [KEY] | String | = | The ID of the permission scheme. | ||
| Id [KEY] | String | = | The ID of the permission granted details. | ||
| Permission | String | The permission to grant. | |||
| HolderParameter | String | As a group's name can change, use of value is recommended. The identifier associated with the type value that defines the holder of the permission. | |||
| HolderType | String | The type of the permission holder. | |||
| HolderValue | String | The identifier associated with the type value that defines the holder of the permission. |
Query the available Permissions in Jira.
| Name | Type | References | SupportedOperators | Platform | Description |
| Key [KEY] | String | Common | The key of the permission. | ||
| Name | String | Common | The name of the permission. | ||
| Type | String | Common | The type of the permission. | ||
| Description | String | Common | The description of the permission. |
Query the available permission schemes in Jira.
| Name | Type | References | SupportedOperators | Platform | Description |
| Id | String | = | The ID of the permission scheme. | ||
| Name | String | The name of the permission scheme. | |||
| Description | String | A description for the permission scheme. | |||
| ScopeType | String | The type of the scope. | |||
| ScopeProjectId | String | The id of the project the item has scope in. |
Query all the project categories.
| Name | Type | References | SupportedOperators | Platform | Description |
| Id [KEY] | Integer | = | Common | Unique identifier of the project category. | |
| Name | String | Common | Name of the project category. | ||
| Description | String | Common | Description of the project category. | ||
| Link | String | Common | Link to this project category. |
Query roles for all projects in Jira.
The Sync App will use the Jira API to process filters that refer to ProjectId and ProjectKey while the rest of the filter is executed client side within the Sync App. The Jira APIs support filters using the equals (=) or IN operator with ProjectId and ProjectKey.
For example, the following queries are processed server side:
Retrieve all roles for each project:
SELECT * FROM ProjectRoles
Retrieve all roles for a specific project:
SELECT * FROM ProjectRoles WHERE ProjectId = '10000'
| Name | Type | References | SupportedOperators | Platform | Description |
| RoleId [KEY] | Long |
Roles.Id | Common | The Id of the role. | |
| RoleName | String |
Roles.Name | Common | The name of the role. | |
| ProjectId [KEY] | Integer |
Projects.Id | =,IN | Common | The Id of the project associated with the role. |
| ProjectKey [KEY] | String |
Projects.Key | =,IN | Common | The key of the project associated with the role. |
Query the available Issue Types of projects.
| Name | Type | References | SupportedOperators | Platform | Description |
| Id [KEY] | String | The Id of the issue type. | |||
| ProjectId [KEY] | Int |
Projects.Id | The Id of the project. | ||
| ProjectName | String |
Projects.Name | The name of the project | ||
| Name | String | The name of the issue type. | |||
| Description | String | The description of the issue type. | |||
| Subtask | Boolean | The subtask of the issue type. Not applicable for update. | |||
| IconUrl | String | The icon URL of the issue type. | |||
| AvatarId | String | The id of the avatar |
Query the available permissions schemes for a project in Jira.
| Name | Type | References | SupportedOperators | Platform | Description |
| ProjectId | Int64 | = | The project ID. | ||
| ProjectKey | String | = | The project key. | ||
| Id | String | The ID of the permission scheme. | |||
| Name | String | The name of the permission scheme. | |||
| Description | String | The description of the permission scheme. |
Query the list of all issue priorities.
The Sync App uses the Jira API to process some of the filters.
The Sync App processes other filters within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM ProjectTypes WHERE Key = 'software'
| Name | Type | References | SupportedOperators | Platform | Description |
| Key [KEY] | String | = | Common | The key of the project type. | |
| DescriptionKey | String | Common | The key of the project type's description. | ||
| Icon | String | Common | The icon of the project type. | ||
| Color | String | Common | The color of the project type. |
Query all the created security levels.
| Name | Type | References | SupportedOperators | Platform | Description |
| Id [KEY] | Integer | Common | The ID of the issue level security item. | ||
| SecuritySchemeId | Long | =,IN | Common | Link to this security level. | |
| Name | String | Common | The name of the issue level security item. | ||
| Description | String | Common | The description of the issue level security item. |
Query all the created security schemes.
| Name | Type | References | SupportedOperators | Platform | Description |
| Id [KEY] | Long | = | Common | The ID of the issue security scheme. | |
| Name | String | Common | The name of the issue security scheme. | ||
| Description | String | Common | The description of the issue security scheme. | ||
| DefaultSecurityLevelId | Long | Common | The ID of the default security level. |
Query the agile Sprint Issues in Jira.
Jira API は、SprintId のフィルタでIN 演算子をサポートしています。Sync App はその他のフィルタをクライアント側で内部で実行します。例えば、次のクエリのフィルタはサーバー側で処理されます。
SELECT * FROM SprintIssues WHERE SprintId = '1'
IN 演算子の使用:
SELECT * FROM SprintIssues WHERE SprintId IN (70, 215)
かんばんタイプのボードはスプリントをサポートしていないことに注意してください。次のようなフィルタを使用すると、スプリントのすべての課題をより速く取得できます。
SELECT * FROM SprintIssues WHERE SprintId IN (SELECT Id FROM BoardSprints WHERE BoardId IN (SELECT Id FROM Boards WHERE Type != 'kanban'))
| Name | Type | References | SupportedOperators | Platform | Description |
| Id [KEY] | Integer |
Issues.Id | Common | The Id of the issue. | |
| Key | String |
Issues.Key | = | Common | The key of the issue. |
| SprintId [KEY] | Integer |
Sprints.Id | =,IN | Common | The sprint the issue is assigned to. |
| IssueTypeId | String |
IssueTypes.Id | =,!=,IS,IS NOT,IN,NOT IN | Common | The issue type Id. |
| IssueTypeName | String | =,!=,IS,IS NOT,IN,NOT IN | Common | The issue type name. | |
| StatusId | Integer |
Statuses.Id | =,!=,IS,IS NOT,IN,NOT IN | Common | The issue status Id. |
| StatusName | String | =,!=,IS,IS NOT,IN,NOT IN | Common | The issue status name. | |
| ProjectId | Integer |
Projects.Id | =,!=,IS,IS NOT,IN,NOT IN | Common | The project Id of the issue. |
| ProjectKey | String |
Projects.Key | =,!=,IS,IS NOT,IN,NOT IN | Common | The project key of the issue. |
| ProjectName | String | =,!=,IS,IS NOT,IN,NOT IN | Common | The project name of the issue. | |
| ClosedSprintsAggregate | String | Common | The issue's previous sprints that have been closed. | ||
| Created | Datetime | =,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common | The creation date of the issue. | |
| Updated | Datetime | =,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common | The updated date of the issue. |
Query the possible Statuses in Jira.
Sync App はJira API を使用して、Id またはName カラムを参照するフィルタを処理します。Name カラムの検索では、大文字と小文字が区別されます。
Sync App はその他のフィルタをクライアント側で内部で実行します。例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Statuses WHERE Id = '10003' SELECT * FROM Statuses WHERE Name = 'Closed'
| Name | Type | References | SupportedOperators | Platform | Description |
| Id [KEY] | Integer | = | Common | The Id of the status. | |
| Name | String | = | Common | The name of the status. | |
| Description | String | Common | The description of the status. | ||
| CategoryId | Integer | Common | The Category Id of the status. | ||
| CategoryKey | String | Common | The Category Key of the status. |
Query the list of all time tracking providers.
SELECT * FROM TimeTrackingProviders
| Name | Type | References | SupportedOperators | Platform | Description |
| Key [KEY] | String | = | Cloud | The key for the time tracking provider. For example, Jira. | |
| Name | String | Cloud | The name of the time tracking provider. For example, Jira provided time tracking. | ||
| URL | String | Cloud | The URL of the configuration page for the time tracking provider app. For example, /example/config/url. This property is only returned if the adminPageKey property is set in the module descriptor of the time tracking provider app. |
Query the available Votes in Jira.
Sync App は、次のフィルタ以外のフィルタを、クライアント側で 内部で実行します。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Votes WHERE IssueId = 10100 SELECT * FROM Votes WHERE IssueKey = 'MKY-1'
| Name | Type | References | SupportedOperators | Platform | Description |
| DisplayName | String | Common | The display name of the vote. | ||
| Active | Boolean | Common | Boolean indicating if the vote is active. | ||
| AccountId | String | Common | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. | ||
| IssueId | String | = | Common | The issue Id of the vote. | |
| IssueKey | String | = | Common | The issue key of the vote. |
Query the available Watchers in Jira.
Sync App は、Jira API を使用してIssueId またはIssueKey に基づいてフィルタを処理します。結果を取得するためには、いずれか1つが必要です。IssueId およびIssueKey は、イコール演算子(=) でのみ使用できます。
Sync App は、他のフィルタをクライアント側で内部で実行します。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Watchers WHERE IssueId = '10100' SELECT * FROM Watchers WHERE IssueKey = 'PRJ-1'
| Name | Type | References | SupportedOperators | Platform | Description |
| DisplayName | String | Common | The displayed name of the watcher. | ||
| EmailAddress | String | Common | The email address of the watcher. | ||
| AccountId [KEY] | String | Cloud | The accountId of the watcher. | ||
| Key [KEY] | String | Server | The key of the watcher. | ||
| Name | String | Server | The name of the watcher. | ||
| IssueId | String | = | Common | The issue Id of the watcher. | |
| IssueKey | String | = | Common | The issue key of the watcher. |
Query the list of all status categories.
The Sync App uses the Jira API to process some of the filters.
The Sync App processes other filters within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkflowStatusCategories WHERE Id = 1 SELECT * FROM WorkflowStatusCategories WHERE Key = 'undefined'
| Name | Type | References | SupportedOperators | Platform | Description |
| Id [KEY] | Long | = | Common | The ID of the status category. | |
| Key | String | = | Common | The key of the status category. | |
| Name | String | Common | The name of the status category. | ||
| ColorName | String | Common | The name of the color used to represent the status category. | ||
| URL | String | Common | The URL of the status category. |
Query the list of all statuses associated with workflows.
The Sync App uses the Jira API to process some of the filters.
The Sync App processes other filters within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkflowStatuses WHERE Id = 1 SELECT * FROM WorkflowStatuses WHERE Name = 'Open'
| Name | Type | References | SupportedOperators | Platform | Description |
| Id [KEY] | String | = | Common | The ID of the status. | |
| StatusCategoryId | Long | Common | The ID of the status category. | ||
| Name | String | = | Common | The name of the status. | |
| Description | String | Common | The description of the status. | ||
| URL | String | Common | The description of the status. | ||
| IconUrl | String | Common | The URL of the icon used to represent the status. |
Queries the deleted worklogs in your Jira account.
| Name | Type | References | SupportedOperators | Platform | Description |
| Id | String | The Id of the audit record. | |||
| Updated | Datetime | >=,> | The date on when the change was made. | ||
| Properties | String | The properties of the deleted Worklog. |
Sync App は、データソースの型を、スキーマで使用可能な対応するデータ型にマッピングします。以下のテーブルはこれらのマッピングを説明します。
| Jira | CData スキーマ |
| Assets | string |
| Checkbox | string |
| Date of First Response | datetime |
| Date Picker | date |
| Date Time Picker | datetime |
| Days since last comment | string |
| Domain of Assignee | string |
| Domain of Reporter | string |
| Group Picker (multiple groups) | string |
| Group Picker (single group) | string |
| Labels | string |
| Last commented by a User Flag | string |
| Last public comment date | string |
| Message Custom Field (for edit) | string |
| Message Custom Field (for view) | string |
| Number Field | decimal |
| Number of attachments | string |
| Number of comments | string |
| Parent Link | string |
| Participants of an issue | string |
| Project Picker (single project) | string |
| Radio Buttons | string |
| Select List (cascading) | string |
| Select List (multiple choices) | string |
| Select List (single choice) | string |
| Team | string |
| Text Field (multi-line) | string |
| Text Field (read only) | string |
| Text Field (single line) | string |
| Time in Status | string |
| URL Field | string |
| User Picker (multiple users) | string |
| User Picker (single user) | string |
| User Property Field | string |
| Username of last updater or commenter | string |
| Version Picker (multiple versions) | string |
| Version Picker (single version) | string |
| プロパティ | 説明 |
| AuthScheme | Jira に接続する際に使用する認証の種類。 |
| URL | Jira エンドポイントへのURL。 |
| User | 認証するJira ユーザーアカウントのユーザーID を指定します。 |
| Password | 認証するユーザーアカウントのパスワードを指定します。 |
| APIToken | 現在の認証ユーザーのAPI トークン。 |
| PAT | 現在の認証ユーザーの個人用アクセストークン。 |
| プロパティ | 説明 |
| SSOLoginURL | ID プロバイダーのログインURL。 |
| SSOProperties | ID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。 |
| SSOExchangeUrl | SAML 応答を処理してサービスの資格情報と交換するために使用するURL。 |
| SSOAppName | アプリ名を必要とするSSO のIdP で使用されるアプリ名. |
| SSOAppPassword | アプリパスワードを必要とするSSO のIdP で使用されるアプリパスワード。 |
| プロパティ | 説明 |
| OAuthVersion | 使われているOAuth のバージョン。 |
| OAuthClientId | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthClientSecret | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| Scope | This determines the scopes that the OAuth application requests from Jira. The default scopes are: read:jira-work manage:jira-project manage:jira-configuration read:jira-user write:jira-work manage:jira-data-provider read:board-scope:jira-software write:board-scope:jira-software read:board-scope.admin:jira-software read:epic:jira-software read:sprint:jira-software write:sprint:jira-software delete:sprint:jira-software read:project:jira read:issue-details:jira read:jql:jira offline_access. |
| AuthToken | OAuth アクセストークンをリクエストおよび取得するために使用される認証トークン。 |
| AuthKey | OAuth アクセストークンをリクエストおよび取得するために使用される認証シークレット。 |
| CertificateStoreType | Jira プライベートアプリケーション認証で使用される証明書ストアの種類。 |
| CertificateStore | Jira 認証に使用される証明書ストア。 |
| CertificateSubject | Jira プライベートアプリケーション認証で使用される証明書のサブジェクト。 |
| CertificateStorePassword | Jira 認証で使用される証明書ストアのパスワード。 |
| プロパティ | 説明 |
| SSLClientCert | SSL クライアント認証(2-way SSL)のためのTLS/SSL クライアント証明書ストアを指定します。このプロパティは、他のSSL 関連プロパティと連動して、セキュアな接続を確立します。 |
| SSLClientCertType | SSL クライアント認証用のTLS/SSL クライアント証明書を格納するキーストアの種類を指定します。プラットフォームや証明書のソースに応じて、さまざまなキーストア形式から選択できます。 |
| SSLClientCertPassword | TLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。 |
| SSLClientCertSubject | TLS/SSL クライアント証明書のサブジェクトを指定し、証明書ストアで場所を検索します。 CN=www.server.com, C=US のように、識別名フィールドのカンマ区切りのリストを使用します。ワイルドカード * は、ストアの先頭の証明書を選択します。 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| AcceptLanguage | Set this Property to send the Accept-Language request header. The accepted values follow the IETF BCP 47 standard for language tags and if is set to a unknown locale it will be ignored. |
| IncludeCustomFields | A boolean indicating whether custom fields should be included in the column listing of the Issues table. |
| IncludeMetadataDescription | Set this property to Columns to retrieve descriptions for custom fields. If retrieval of descriptions for custom fields fails (e.g., due to permission restrictions), the driver will revert to the default behavior (Descriptions will be null) and log the reason for failure. |
| KeyColumnOperators | Specifies how to handle logical and comparison operators applied to Id and Key columns when constructing JQL filters. This property helps manage cases where invalid Id or Key values in JQL filters might otherwise lead to errors or unexpected results, particularly when paired with the UseJqlSearchEndpoint connection property on Jira Cloud. |
| MaxRows | 集計やGROUP BY を使用しないクエリで返される最大行数を指定します。 |
| MaxThreads | コンカレントリクエスト数を指定します。 |
| Other | 特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。 |
| Pagesize | Jira から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
| Timezone | Specify the timezone of the Jira instance in order to use the datetime filters accordingly and retrieve the results according to your timezone. An example of a timezone would be America/New_York. |
| UseDefaultOrderBy | Indicates if a default order by should be applied if none is specified in the query. |
| UseDisplayNames | Boolean determining if the display names for custom fields should be used instead of the API names. |
| UseJqlSearchEndpoint | Enables the use of the new /rest/api/2/search/jql endpoint for querying issues and related entities in Jira Cloud. |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
| UseSimpleNames | テーブルとカラムに簡略名を使用するかどうかを決定するboolean。 |
Jira に接続する際に使用する認証の種類。
Jira エンドポイントへのURL。
Jira エンドポイントへのURL。例えば、https://yoursitename.atlassian.net です。
現在の認証ユーザーのAPI トークン。
現在の認証ユーザーのAPI トークン。
現在の認証ユーザーの個人用アクセストークン。
現在の認証ユーザーの個人用アクセストークン。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSO プロパティの全リストを提供します。
| プロパティ | 説明 |
| SSOLoginURL | ID プロバイダーのログインURL。 |
| SSOProperties | ID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。 |
| SSOExchangeUrl | SAML 応答を処理してサービスの資格情報と交換するために使用するURL。 |
| SSOAppName | アプリ名を必要とするSSO のIdP で使用されるアプリ名. |
| SSOAppPassword | アプリパスワードを必要とするSSO のIdP で使用されるアプリパスワード。 |
ID プロバイダーのログインURL。
ID プロバイダーのログインURL。
ID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。
ID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。SSOLoginURL と一緒に使用します。
SSO 設定については、 で詳しく説明します。
SAML 応答を処理してサービスの資格情報と交換するために使用するURL。
CData Sync App はここで指定されたURL を使用してSAML 応答を処理し、サービスの資格情報と交換します。 取得した資格情報はSSO 接続時の最後の情報であり、Jira との通信に使用されます。
アプリ名を必要とするSSO のIdP で使用されるアプリ名.
SSOAppPassword とともに、SSO IdP で設定されたアプリを識別して認証するために指定できます。 現在、クラウドのみサポートしています。
アプリパスワードを必要とするSSO のIdP で使用されるアプリパスワード。
SSOAppName とともに、SSO IdP で設定されたアプリを識別して認証するために指定できます。 現在、クラウドのみサポートしています。
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthVersion | 使われているOAuth のバージョン。 |
| OAuthClientId | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthClientSecret | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| Scope | This determines the scopes that the OAuth application requests from Jira. The default scopes are: read:jira-work manage:jira-project manage:jira-configuration read:jira-user write:jira-work manage:jira-data-provider read:board-scope:jira-software write:board-scope:jira-software read:board-scope.admin:jira-software read:epic:jira-software read:sprint:jira-software write:sprint:jira-software delete:sprint:jira-software read:project:jira read:issue-details:jira read:jql:jira offline_access. |
| AuthToken | OAuth アクセストークンをリクエストおよび取得するために使用される認証トークン。 |
| AuthKey | OAuth アクセストークンをリクエストおよび取得するために使用される認証シークレット。 |
| CertificateStoreType | Jira プライベートアプリケーション認証で使用される証明書ストアの種類。 |
| CertificateStore | Jira 認証に使用される証明書ストア。 |
| CertificateSubject | Jira プライベートアプリケーション認証で使用される証明書のサブジェクト。 |
| CertificateStorePassword | Jira 認証で使用される証明書ストアのパスワード。 |
使われているOAuth のバージョン。
使われているOAuth のバージョン。次のオプションが利用可能です:1.0,2.0
カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。
カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。
This determines the scopes that the OAuth application requests from Jira. The default scopes are: read:jira-work manage:jira-project manage:jira-configuration read:jira-user write:jira-work manage:jira-data-provider read:board-scope:jira-software write:board-scope:jira-software read:board-scope.admin:jira-software read:epic:jira-software read:sprint:jira-software write:sprint:jira-software delete:sprint:jira-software read:project:jira read:issue-details:jira read:jql:jira offline_access.
スコープは、認証ユーザーがどのようなアクセス権を持つかを定義するために設定されます。例えば、読み取り、読み取りと書き込み、機密情報への制限付きアクセスなどです。システム管理者は、スコープを使用して機能またはセキュリティクリアランスによるアクセスを選択的に有効化できます。
InitiateOAuth がGETANDREFRESH に設定されている場合、要求するスコープを変更したい場合はこのプロパティを使用する必要があります。 InitiateOAuth がREFRESH またはOFF のいずれかに設定されている場合、要求するスコープを変更したい場合は、このプロパティまたはScope 入力を使用する必要があります。
By default the Sync App will request that the user authorize all available scopes. If you want to override this, you can set this property to a space-separated list of OAuth scopes.
OAuth アクセストークンをリクエストおよび取得するために使用される認証トークン。
このプロパティは、OAuth 1.0でヘッドレス認証を実行する場合にのみ必要です。これは、GetOAuthAuthorizationUrl ストアドプロシージャから取得できます。
GetOAuthAccessToken ストアドプロシージャでAuthKey とともに指定して、OAuthAccessToken を取得できます。
OAuth アクセストークンをリクエストおよび取得するために使用される認証シークレット。
このプロパティは、OAuth 1.0でヘッドレス認証を実行する場合にのみ必要です。これは、GetOAuthAuthorizationUrl ストアドプロシージャから取得できます。
GetOAuthAccessToken ストアドプロシージャでAuthToken とともに指定して、OAuthAccessToken を取得できます。
Jira プライベートアプリケーション認証で使用される証明書ストアの種類。
Jira プライベートアプリケーション認証で使用されるクライアント証明書の証明書ストアの名前。 Jira プライベートアプリケーション認証では、デジタル証明書によるSSL クライアント認証が使用されます。
CertificateStoreType プロパティは次のいずれかの値をとります。
| User - デフォルト | Windows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。 Note:この種類はJava では利用できません。 |
| Machine | Windows の場合、この証明書ストアがシステムストアであることを指定します。 Note:この種類はJava では利用できません。 |
| PFXFile | この証明書ストアは、証明書を含むPFX(PKCS12)ファイルの名前です。 |
| PFXBlob | この証明書ストアは、PFX(PKCS12)形式の証明書ストアを表すBase-64でエンコードされた文字列です。 |
| JKSFile | この証明書ストアは、証明書を含むJava key store(JKS)ファイルの名前です。 Note:この種類はJava のみで利用できます。 |
| JKSBlob | この証明書ストアは、Java key store(JKS)形式の証明書ストアを表すBase-64でエンコードされた文字列です。 Note:この種類はJava のみで利用できます。 |
| PEMKeyFile | この証明書ストアは、秘密キーと任意の証明書を含むPEM でエンコードされたファイルの名前です。 |
| PublicKeyFile | この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むファイルの名前です。 |
| PublicKeyBlob | この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むBase-64でエンコードされた文字列です。 |
| SSHPublicKeyBlob | この証明書ストアは、SSH 公開キーを含むBase-64でエンコードされた文字列です。 |
| P7BFile | この証明書ストアは、証明書を含むPKCS7 ファイルの名前です。 |
| SSHPublicKeyFile | この証明書ストアは、SSH 公開キーを含むファイルの名前です。 |
| PPKFile | この証明書ストアは、PuTTY 秘密キー(PPK)を含むファイルの名前です。 |
| XMLFile | この証明書ストアは、XML 形式の証明書を含むファイルの名前です。 |
| XMLBlob | この証明書ストアは、XML 形式の証明書を含む文字列の名前です。 |
プライベート証明書を指定するには、CertificateStoreType に加えて次のプロパティを設定する必要があります。
Jira 認証に使用される証明書ストア。
Jira アプリケーション認証で使用されるクライアント証明書の証明書ストアの場所。
Jira プライベートアプリケーション認証で使用される証明書のサブジェクト。
Jira プライベートアプリケーション認証で使用されるクライアント証明書のサブジェクト。
Jira プライベートアプリケーション認証では、デジタル証明書によるSSL クライアント認証が使用されます。
証明書のサブジェクトは、証明書をロードするときにストア内の証明書を検索するために使用されます。
証明書のサブジェクトは識別の名前フィールドおよび値のカンマ区切りのリストです。 例えば、"CN=www.server.com, OU=test, C=US, [email protected]"。共通のフィールドとその説明は以下のとおりです。
| フィールド | 説明 |
| CN | 共通名。一般的には、www.server.com のようなホスト名です。 |
| O | 法人名 |
| OU | 法人の部署名 |
| L | 法人の住所(市町村名) |
| S | 法人の住所(都道府県) |
| C | 国名 |
| E | E メールアドレス |
Note:フィールド値にカンマが含まれている場合は、それを引用符で囲む必要があります。
プライベート証明書を指定するには、CertificateSubject を設定し、さらに次のプロパティを設定する必要があります。
Jira 認証で使用される証明書ストアのパスワード。
証明書ストアでパスワードが必要である場合、このプロパティを使用してパスワードを指定し、証明書ストアにアクセスできます。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
| プロパティ | 説明 |
| SSLClientCert | SSL クライアント認証(2-way SSL)のためのTLS/SSL クライアント証明書ストアを指定します。このプロパティは、他のSSL 関連プロパティと連動して、セキュアな接続を確立します。 |
| SSLClientCertType | SSL クライアント認証用のTLS/SSL クライアント証明書を格納するキーストアの種類を指定します。プラットフォームや証明書のソースに応じて、さまざまなキーストア形式から選択できます。 |
| SSLClientCertPassword | TLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。 |
| SSLClientCertSubject | TLS/SSL クライアント証明書のサブジェクトを指定し、証明書ストアで場所を検索します。 CN=www.server.com, C=US のように、識別名フィールドのカンマ区切りのリストを使用します。ワイルドカード * は、ストアの先頭の証明書を選択します。 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
SSL クライアント認証(2-way SSL)のためのTLS/SSL クライアント証明書ストアを指定します。このプロパティは、他のSSL 関連プロパティと連動して、セキュアな接続を確立します。
このプロパティは、SSL クライアント認証のためのクライアント証明書ストアを指定します。 このプロパティは、証明書ストアの種類を定義するSSLClientCertType、およびパスワードで保護されたストア用のパスワードを指定するSSLClientCertPassword と一緒に使用します。 SSLClientCert が設定され、SSLClientCertSubject が設定されている場合、ドライバーは指定されたサブジェクトに一致する証明書を検索します。
証明書ストアの指定はプラットフォームによって異なります。 Windowsでは、証明書ストアはMY(個人証明書)などの名前で識別されますが、Java では、証明書ストアは通常、証明書とオプションの秘密キーを含むファイルです。
Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。
| MY | 個人証明書と関連付けられた秘密キーを格納している証明書ストア。 |
| CA | 証明機関の証明書。 |
| ROOT | ルート証明書。 |
| SPC | ソフトウェア発行元証明書。 |
PFXFile タイプの場合、このプロパティをファイル名に設定します。PFXBlob タイプの場合は、このプロパティをPKCS12 形式のファイルのバイナリコンテンツに設定します。
SSL クライアント認証用のTLS/SSL クライアント証明書を格納するキーストアの種類を指定します。プラットフォームや証明書のソースに応じて、さまざまなキーストア形式から選択できます。
このプロパティは、クライアント証明書を指定するために使用されるキーストアの形式と場所を決定します。 サポートされている値には、プラットフォーム固有およびユニバーサルなキーストア形式があります。 有効な値と使用方法は以下のとおりです。
| USER - デフォルト | Windows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。この種類はJava では利用できませんので注意してください。 |
| MACHINE | Windows の場合、この証明書ストアがシステムストアであることを指定します。この種類はJava では利用できませんので注意してください。 |
| PFXFILE | この証明書ストアは、証明書を含むPFX(PKCS12)ファイルの名前です。 |
| PFXBLOB | この証明書ストアは、PFX(PKCS12)形式の証明書ストアを表すBase-64でエンコードされた文字列です。 |
| JKSFILE | この証明書ストアは、証明書を含むJava key store(JKS)ファイルの名前です。この種類はJava でのみ利用できますので注意してください。 |
| JKSBLOB | この証明書ストアは、Java key store(JKS)形式の証明書ストアを表すBase-64でエンコードされた文字列です。この種類はJava でのみ利用できますので注意してください。 |
| PEMKEY_FILE | この証明書ストアは、秘密キーと任意の証明書を含むPEM でエンコードされたファイルの名前です。 |
| PEMKEY_BLOB | この証明書ストアは、秘密キーと任意の証明書を含むBase-64でエンコードされた文字列です。 |
| PUBLIC_KEY_FILE | この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むファイルの名前です。 |
| PUBLIC_KEY_BLOB | この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むBase-64でエンコードされた文字列です。 |
| SSHPUBLIC_KEY_FILE | この証明書ストアは、SSH 公開キーを含むファイルの名前です。 |
| SSHPUBLIC_KEY_BLOB | この証明書ストアは、SSH 公開キーを含むBase-64でエンコードされた文字列です。 |
| P7BFILE | この証明書ストアは、証明書を含むPKCS7 ファイルの名前です。 |
| PPKFILE | この証明書ストアは、PuTTY 秘密キー(PPK)を含むファイルの名前です。 |
| XMLFILE | この証明書ストアは、XML 形式の証明書を含むファイルの名前です。 |
| XMLBLOB | この証明書ストアは、XML 形式の証明書を含む文字列の名前です。 |
| BCFKSFILE | この証明書ストアは、Bouncy Castle キーストアを含むファイルの名前です。 |
| BCFKSBLOB | この証明書ストアは、Bouncy Castle キーストアを含む文字列(Base-64エンコード)です。 |
TLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。
このプロパティは、パスワードで保護された証明書ストアを開くために必要なパスワードを指定します。 このプロパティは、PFX やJKS タイプのストアによく推奨されるように、復号化のためにパスワードを必要とする証明書ストアを使用する場合に必要です。
証明書ストアの種類がパスワードを必要としない場合(Windows のUSER やMACHINE など)、このプロパティは空白のままにできます。 認証エラーを回避するため、パスワードが指定された証明書ストアに関連付けられたものと一致していることを確認してください。
TLS/SSL クライアント証明書のサブジェクトを指定し、証明書ストアで場所を検索します。 CN=www.server.com, C=US のように、識別名フィールドのカンマ区切りのリストを使用します。ワイルドカード * は、ストアの先頭の証明書を選択します。
このプロパティは、サブジェクトに基づいてロードするクライアント証明書を決定します。Sync App は、指定されたサブジェクトに完全に一致する証明書を検索します。 完全に一致するものが見つからない場合、Sync App はサブジェクトの値を含む証明書を検索します。 一致する証明書がない場合、証明書は選択されません。
サブジェクトは、識別名フィールドと値のカンマ区切りリストという標準の形式に従うべきです。 例えば、CN=www.server.com, OU=Test, C=US です。一般的なフィールドには以下のものが含まれます。
| フィールド | 説明 |
| CN | 共通名。一般的には、www.server.com のようなホスト名です。 |
| O | 法人名 |
| OU | 法人の部署名 |
| L | 法人の住所(市町村名) |
| S | 法人の住所(都道府県) |
| C | 国名 |
| E | E メールアドレス |
Note: フィールドにカンマなどの特殊文字が含まれている場合は、値を引用符で囲む必要があります。例:CN="Example, Inc.", C=US。
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 | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
Note:デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。
次の表は、サポートされている各プロトコルのポート番号情報です。
| プロトコル | デフォルトポート | 説明 |
| TUNNEL | 80 | Sync App がJira への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。 |
| SOCKS4 | 1080 | Sync App がJira への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。 |
| SOCKS5 | 1080 | Sync App がJira にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで使用するTCP ポートを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします(プロキシサーバーの詳細を手動で入力する必要はありません)。
この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を手動で構成する場合は、False に設定します。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。
クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーポートを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。
その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
認証タイプは次のいずれかです。
"NONE" 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyUser に設定する値 |
| BASIC | プロキシサーバーに登録されているユーザーのユーザー名。 |
| DIGEST | プロキシサーバーに登録されているユーザーのユーザー名。 |
| NEGOTIATE | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NTLM | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。
ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyPassword に設定する値 |
| BASIC | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| DIGEST | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| NEGOTIATE | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NTLM | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。
ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。
| AUTO | デフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。 |
| ALWAYS | 接続は、常にSSL 有効となります。 |
| NEVER | 接続は、SSL 有効になりません。 |
| TUNNEL | 接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。
このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。 ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。 各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。
例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。 複数のモジュールを含めるには、次のように名前をセミコロンで区切ります:INFO;EXEC;SSL。
Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。 利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。
利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログ の「高度なログの記録」セクションを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は%APPDATA%\\CData\\JIRA Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます:
| プラットフォーム | %APPDATA% |
| Windows | APPDATA 環境変数の値 |
| Linux | ~/.config |
レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。
レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。
データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| AcceptLanguage | Set this Property to send the Accept-Language request header. The accepted values follow the IETF BCP 47 standard for language tags and if is set to a unknown locale it will be ignored. |
| IncludeCustomFields | A boolean indicating whether custom fields should be included in the column listing of the Issues table. |
| IncludeMetadataDescription | Set this property to Columns to retrieve descriptions for custom fields. If retrieval of descriptions for custom fields fails (e.g., due to permission restrictions), the driver will revert to the default behavior (Descriptions will be null) and log the reason for failure. |
| KeyColumnOperators | Specifies how to handle logical and comparison operators applied to Id and Key columns when constructing JQL filters. This property helps manage cases where invalid Id or Key values in JQL filters might otherwise lead to errors or unexpected results, particularly when paired with the UseJqlSearchEndpoint connection property on Jira Cloud. |
| MaxRows | 集計やGROUP BY を使用しないクエリで返される最大行数を指定します。 |
| MaxThreads | コンカレントリクエスト数を指定します。 |
| Other | 特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。 |
| Pagesize | Jira から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
| Timezone | Specify the timezone of the Jira instance in order to use the datetime filters accordingly and retrieve the results according to your timezone. An example of a timezone would be America/New_York. |
| UseDefaultOrderBy | Indicates if a default order by should be applied if none is specified in the query. |
| UseDisplayNames | Boolean determining if the display names for custom fields should be used instead of the API names. |
| UseJqlSearchEndpoint | Enables the use of the new /rest/api/2/search/jql endpoint for querying issues and related entities in Jira Cloud. |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
| UseSimpleNames | テーブルとカラムに簡略名を使用するかどうかを決定するboolean。 |
Set this Property to send the Accept-Language request header. The accepted values follow the IETF BCP 47 standard for language tags and if is set to a unknown locale it will be ignored.
Set this Property to send the Accept-Language request header. The accepted values follow the IETF BCP 47 standard for language tags and if is set to a unknown locale it will be ignored. Example values: fr, fr-CA, ja, ja-JP, de, etc.
A boolean indicating whether custom fields should be included in the column listing of the Issues table.
Enabling this option includes custom fields in the column listing of the Issues table but may slightly impact performance when retrieving metadata.
Set this property to Columns to retrieve descriptions for custom fields. If retrieval of descriptions for custom fields fails (e.g., due to permission restrictions), the driver will revert to the default behavior (Descriptions will be null) and log the reason for failure.
Set this property to Columns to get custom field descriptions. This Property will take effect only if IncludeCustomFields=True. Note: Administrator access in Jira is required to retrieve custom field descriptions and extra API calls will be executed in cases when this property is set to Columns. If the operation for obtaining custom fields fails, the driver will fall back to the default behavior and log the failure reason in the log file.
Specifies how to handle logical and comparison operators applied to Id and Key columns when constructing JQL filters. This property helps manage cases where invalid Id or Key values in JQL filters might otherwise lead to errors or unexpected results, particularly when paired with the UseJqlSearchEndpoint connection property on Jira Cloud.
This property determines whether certain logical and comparison operators are processed on the server or handled client-side for Id and Key columns.
When set to Server-Side (default):
When set to Client-Side, the following operators are handled client-side rather than being included in the JQL sent to the Jira API:
This avoids inconsistencies caused by strict server-side filtering, such as entire queries failing or getting 0 results if a single invalid key is included in an IN clause.
Additionally, when using the IN operator on Id or Key, the query will be split into multiple individual requests, one per value. For example:
SELECT * FROM Issues WHERE Id IN (111, 112, 113)
will result in three separate API calls, one for each Id. This ensures valid results are returned even if some values are invalid.
However, this client-side handling may result in longer query times due to:
集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
このプロパティは、集計やGROUP BY 句を含まないクエリに対してSync App が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。
コンカレントリクエスト数を指定します。
このプロパティを使用すると複数のリクエストを同時に発行できるため、パフォーマンスが向上します。
特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティをセミコロン区切りのリストで定義できます。
Note: 特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。
複数のプロパティをセミコロン区切りリストで指定します。
| DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
| ConvertDateTimeToGMT=True | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換します。デフォルト値はFalse(ローカルタイムを使用)です。 |
| RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
Jira から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
クエリする特定のオブジェクトやサービスエンドポイントの結果を最適化するために、デフォルトのページサイズを調整したい場合があります。 ページサイズを大きくするとパフォーマンスが向上するかもしれませんが、ページあたりのメモリ消費量が増える可能性もあることに注意してください。
テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。
個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"
すべてのテーブルのすべての擬似カラムを含めるには、次のようにします:"*=*"
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
このプロパティは、Sync App が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、Sync App は操作をキャンセルして例外をスローします。
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。
Specify the timezone of the Jira instance in order to use the datetime filters accordingly and retrieve the results according to your timezone. An example of a timezone would be America/New_York.
Note: You can find the timezone in your Jira Cloud by navigating to Settings -> System -> General configuration -> Default user time zone
Indicates if a default order by should be applied if none is specified in the query.
By default, the CData Sync App applies an order by when none is specified. This ensures that duplicate records do not get output when returning data. However, this will have a significant impact on performance for very large tables. If your use case can handle the possibility of duplicate primary keys, it is recommended to turn this off if you would like to have better performance.
Boolean determining if the display names for custom fields should be used instead of the API names.
Boolean determining if the display names for custom fields should be used instead of the API names.
Enables the use of the new /rest/api/2/search/jql endpoint for querying issues and related entities in Jira Cloud.
This connection property controls whether the driver uses the newer /rest/api/2/search/jql endpoint for executing JQL-based queries in Jira Cloud. This property is enabled by default (true), as the legacy /rest/api/2/search endpoints (GET and POST) are deprecated and scheduled for removal on May 1st.
When set to true, the driver routes search requests through the new /search/jql endpoint for querying not only Issues, but also related entities, including:
This ensures forward compatibility with Jira Cloud's evolving API standards. However, performance may be slower in some scenarios due to changes in how data is paginated in the new endpoint.
When set to false, the driver falls back to using the older /search endpoint.
This property has no effect when connecting to Jira Data Center, where the existing endpoints remain valid.
カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
このプロパティを使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。次に例を示します。
{
"MyView": {
"query": "SELECT * FROM Projects WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。 例:UserDefinedViews=C:\Path\To\UserDefinedViews.json。 このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
詳しくは、ユーザー定義ビュー を参照してください。
テーブルとカラムに簡略名を使用するかどうかを決定するboolean。
Jira テーブルおよびカラムでは、 通常のデータベースでは使うことが認められていない特殊記号・文字を名前に使うことができます。UseSimpleNames を使用すると、Sync App を従来のデータベースツールでより簡単に使用できるようになります。
UseSimpleNames をtrue に設定し、返されるテーブル名およびカラム名をシンプルにします。表示されるテーブル名 およびカラム名においてアルファベット文字およびアンダースコアのみを有効とするネーミングスキームを強制します。 英数字以外の文字はすべて、アンダースコアに変換されます。