1. ホームページ
  2. Jira Connector

  3. Jira Connector リファレンス

All Connectors

Jira Connector 1.2 リファレンス - Mule 4

Jira 用 Anypoint Connector (Jira Connector) を使用すると、Jira API を直接操作することなく Jira プラットフォームと連携できます。

設定

パラメーター

名前 型 説明 デフォルト値 必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

x

Connection (接続)

この設定に指定できる接続種別。

x

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

1

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

MINUTES (分)

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

AUTO

Name (名前)

String (文字列)

この要素の ID。他のコンポーネントでこの要素を参照するために使用します。

x

Expiration Policy (有効期限ポリシー)

Expiration Policy (有効期限ポリシー)

動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Mule Runtime で期限切れに相当するとみなされます。インスタンスが期限切れとみなされた瞬間にインスタンスが期限切れになるという意味ではありません。必要に応じて、インスタンスがパージされます。

接続種別

Jira Connector では、個人アクセストークン (PAT) を介した認証はサポートされていません。

Basic Auth Connection Provider (基本認証接続プロバイダー)

名前 型 説明 デフォルト値 必須

Default Headers (デフォルトヘッダー)

Default Header (デフォルトヘッダー)​ の配列

Query Parameters (クエリパラメーター)

Default Query Param (デフォルトクエリパラメーター)​ の配列

Connection Timeout (接続タイムアウト)

Number (数値)

リモートサービスへの接続を確立するためのタイムアウト。

30

Connection Timeout Unit (接続タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Connection Timeout (接続タイムアウト)​ の時間単位。

SECONDS (秒)

Use Persistent Connections (永続接続を使用)

Boolean (ブール)

false の場合、各接続は最初の要求が完了すると終了します。

true

Max Connections (最大接続数)

Number (数値)

同時に開いておくことができるアウトバウンド接続の最大数。

-1

Connection Idle Timeout (接続アイドルタイムアウト)

Number (数値)

接続が終了するまでのアイドル状態を維持できる時間のタイムアウト。

30

Connection Idle Timeout Unit (接続アイドルタイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Connection Idle Timeout (接続アイドルタイムアウト)​ の時間単位。

SECONDS (秒)

Proxy Config (プロキシ設定)

Proxy (プロキシ)

プロキシ経由のアウトバウンド接続の再利用可能な設定要素。

Stream Response (応答のストリーミング)

Boolean (ブール)

受信した応答ストリーミングするかどうか。

false

Response Buffer Size (応答バッファサイズ)

Number (数値)

HTTP 応答が保存されるバッファの領域 (バイト)。

-1

Username (ユーザー名)

String (文字列)

要求の認証に使用するユーザー名。

API Token (API トークン)

String (文字列)

要求の認証に使用する API トークン。

Base Uri (ベース URI)

String (文字列)

パラメーターのベース URI。各インスタンスまたはテナントが独自のベース URI を取得します。

Protocol (プロトコル)

Enumeration (列挙)。次のいずれかになります。

  • HTTP

  • HTTPS

通信に使用するプロトコル。有効な値は HTTP と HTTPS です。

HTTP

TLS Configuration (TLS 設定)

TLS

Reconnection (再接続)

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Oauth2 Connection Provider (OAuth2 接続プロバイダー)

OAuth 2.0 を使用して、ユーザーアカウントをホストするサービスにユーザー認証を委任します。詳細は、​「コネクタの OAuth 2.0 の設定」​または​「CloudHub でのコネクタの OAuth 2.0 の設定」​を参照してください。

名前 型 説明 デフォルト値 必須

Default Headers (デフォルトヘッダー)

Default Header (デフォルトヘッダー)​ の配列

Query Parameters (クエリパラメーター)

Default Query Param (デフォルトクエリパラメーター)​ の配列

Connection Timeout (接続タイムアウト)

Number (数値)

リモートサービスへの接続を確立するためのタイムアウト。

30

Connection Timeout Unit (接続タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Connection Timeout (接続タイムアウト)​ の時間単位。

SECONDS (秒)

Use Persistent Connections (永続接続を使用)

Boolean (ブール)

false の場合、各接続は最初の要求が完了すると終了します。

true

Max Connections (最大接続数)

Number (数値)

同時に開いた状態にできるアウトバウンド接続の最大数。

-1

Connection Idle Timeout (接続アイドルタイムアウト)

Number (数値)

接続が終了するまでのアイドル状態を維持できる時間のタイムアウト。

30

Connection Idle Timeout Unit (接続アイドルタイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Connection Idle Timeout (接続アイドルタイムアウト) の時間単位。

SECONDS (秒)

Proxy Config (プロキシ設定)

Proxy (プロキシ)

プロキシ経由のアウトバウンド接続の再利用可能な設定要素。

Stream Response (応答のストリーミング)

Boolean (ブール)

受信応答をストリーミングする必要があるかどうか。

false

Response Buffer Size (応答バッファサイズ)

Number (数値)

HTTP 応答が保存されるバッファの領域 (バイト)。

-1

Base Uri (ベース URI)

String (文字列)

パラメーターのベース URI。各インスタンス/テナントが独自のベース URI を取得します。

https://api.atlassian.com/ex/jiraLeaving the Site

Audience (対象者)

String (文字列)

Atlassian API のベース URL。

api.atlassian.com

Prompt (要求メッセージ)

String (文字列)

consent (同意) に設定し、ユーザーにアクセス権を付与するように求める画面が表示されるようにします。

consent (同意)

State (状態)

String (文字列)

認証 URL に誘導するユーザーに関連付けられた値 (ユーザーのセッション ID のハッシュなど) に設定します。

Domain URL (ドメイン URL)

String (文字列)

クラウド ID を取得する JIRA のインスタンス。要求を行うには、ベース URI がデフォルトの場合のみドメイン URL を指定する必要があります。

Protocol (プロトコル)

Enumeration (列挙)。次のいずれかになります。

  • HTTP

  • HTTPS

通信に使用するプロトコル。有効な値は HTTP と HTTPS です。

HTTP

TLS Configuration (TLS 設定)

TLS

Reconnection (再接続)

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Consumer Key (コンシューマーキー)

String (文字列)

サービスプロバイダーに登録されている OAuth コンシューマーキー。

x

Consumer Secret (コンシューマーシークレット)

String (文字列)

サービスプロバイダーに登録されている OAuth コンシューマーシークレット。

x

Authorization Url (認証 URL)

String (文字列)

サービスプロバイダーの認証エンドポイント URL。

https://auth.atlassian.com/authorizeLeaving the Site

Access Token Url (アクセストークン URL)

String (文字列)

サービスプロバイダーの accessToken エンドポイント URL。

https://auth.atlassian.com/oauth/tokenLeaving the Site

Scopes (スコープ)

String (文字列)

OAuth ダンス時に要求する OAuth スコープ。指定しない場合、デフォルトのアノテーションの範囲になります。

* read:jira-user * read:jira-work * write:jira-work * manage:jira-project * manage:jira-configuration offline_access

Resource Owner Id (リソースオーナー ID)

String (文字列)

リソースオーナー ID が他で参照されない場合に各コンポーネントで使用する必要があるリソースオーナー ID。

Before (前)

String (文字列)

OAuth ダンスを開始する直前に実行するフローの名前。

After (後)

String (文字列)

アクセストークンが受信された直後に実行するフローの名前。

リスナー設定

String (文字列)

アクセストークンコールバックエンドポイントを受信するリスナーの作成に使用する <http:listener-config /> への参照。

x

Callback Path (コールバックパス)

String (文字列)

アクセストークンコールバックエンドポイントのパス。

x

Authorize Path (認証パス)

String (文字列)

OAuth ダンスをトリガーするローカル HTTP エンドポイントのパス。

x

External Callback Url (外部コールバック URL)

String (文字列)

コールバックエンドポイントがプロキシの背後にあるか、直接 URL 以外でアクセスする必要がある場合、このパラメーターを使用して OAuth プロバイダーに、コールバックへのアクセスに使用すべき URL を指示します。

Object Store (オブジェクトストア)

String (文字列)

各リソースオーナー ID のデータの保存に使用するオブジェクトストアへの参照。この値を指定しない場合、Mule で自動的にデフォルトのオブジェクトストアがプロビジョニングされます。

操作

操作

Get Comments By Ids

<jira:create-rest-api3-comment-list>

コメント ID で指定されたコメントのリストに対して、コメントのみのページ分割されたリストを返します。この操作には匿名でアクセスできます。

必要な権限:

コメントが返される条件:

  • ユーザーに、コメントを含むオブジェクトに対する​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​がある。

  • 課題レベルのセキュリティLeaving the Site​が設定されている場合、課題を表示する課題レベルのセキュリティ権限。

  • コメントの表示制限がある場合、グループに属しているか、表示が制限されているロールがある。

この操作では、/rest/api/3/comment/list エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

expand (展開)

String (文字列)

expand​ を使用して、コメントに関する追加情報を応答に含めます。このパラメーターは、カンマ区切りのリストを受け入れます。expand (展開) には次のオプションがあります。

  • renderedBody​: HTML で表示されるコメント本文を返します。

  • properties​: コメントのプロパティを返します。

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Create Component

<jira:create-rest-api3-component>

コンポーネントを作成します。コンポーネントを使用して、プロジェクト内の課題のコンテナを提供します。この操作には匿名でアクセスできます。

必要な権限:

  • コンポーネントが作成されるプロジェクトに対する​「Administer projects (プロジェクトの管理)」 プロジェクト権限Leaving the Site​。

  • 「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/component エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Create Custom Field Options

<jira:create-rest-api3-custom-field-option-by-field-id>

この操作は廃止されており、2021 年 5 月 8 日に使用できなくなりました。代わりに、 Create custom field options (context)Leaving the Site​ を使用してください。詳細は、 「Deprecation of custom field options (カスタム項目オプションの廃止)」Leaving the Site​を参照してください。

オプションを作成し、カスタム選択項目のデータ型が​選択リスト (カスケード)​ の場合、カスタム選択項目のオプションをカスケードします。オプションは、項目のグローバルコンテキストに追加されます。この操作は、​Jira で作成されたか、[Issue custom field options](#api-group-Issue-custom-field-options) リソースからの操作を使用して作成された課題項目選択リストオプションでのみ機能します​。Connect アプリケーションによって作成された課題項目選択リストオプションでは使用できません。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/customField/{fieldId}/option エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Id (項目 ID)

Number (数値)

カスタム項目の ID。注意: これは、項目 ID の数値部分です。たとえば、ID ​customfield\_10075​ の項目には ​10075​ を使用します。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Create Dashboard

<jira:create-rest-api3-dashboard>

ダッシュボードを作成します。

必要な権限:

なし。

この操作では、/rest/api/3/dashboard エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Copy Dashboard

<jira:create-rest-api3-dashboard-copy-by-id>

ダッシュボードをコピーします。​dashboard​ パラメーターで指定された値により、コピーしたダッシュボードの値が置き換えられます。

必要な権限:

なし

コピーするダッシュボードは、ユーザーが所有しているか、ユーザーと共有されている必要があります。この操作では、/rest/api/3/dashboard/{id}/copy エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

id

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Analyse Expression

<jira:create-rest-api3-expression-analyse>

Jira 式を分析および検証します。実験的機能として、この操作で式の型チェックを試みることもできます。Jira 式についての詳細は、 ドキュメントLeaving the Site​を参照してください。

必要な権限:

なし。

この操作では、/rest/api/3/expression/analyse エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

オン

Enumeration (列挙)。次のいずれかになります。

  • SYNTAX

  • TYPE (種別)

  • COMPLEXITY

実行するチェック:

  • syntax​: 各式の構文がチェックされ、式を解析できることが確認されます。また、構文上の制限が検証されます。たとえば、式の長さなど。

  • type​: 実験的。各式の型がチェックされ、式の最終的な型が推定されます。実行時に式の失敗を引き起こす型のエラーが報告されます。たとえば、存在しないプロパティにアクセスしたり、関数に間違った数の引数を渡したりした場合に報告されます。また、構文チェックも実行されます。

  • complexity​: 実験的。数式の各式で実行可能な 負荷のかかる操作Leaving the Site​の数を決定します。

SYNTAX

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Evaluate Jira Expression

<jira:create-rest-api3-expression-eval>

Jira 式を評価し、その値を返します。このリソースは、他の場所で使用する予定の Jira 式をテストしたり、柔軟な方法でデータを取得したりするために使用できます。詳細は、 Jira 式のドキュメントLeaving the Site​を参照してください。

コンテキスト変数

次のコンテキスト変数は、このリソースによって評価される Jira 式で使用できます。これらの存在はさまざまな要因に依存します。通常、ペイロードで送信されるコンテキストオブジェクトでそれらを手動で要求する必要がありますが、特定の条件下では自動的に追加される場合もあります。

  • user​ ( UserLeaving the Site​): 現在のユーザー。常に使用可能で、要求が匿名の場合は ​null​ です。

  • app​ ( AppLeaving the Site​): 要求を行った Connect アプリケーション。Connect アプリケーションによって行われた認証済み要求でのみ使用可能 (詳細は 「Authentication for Connect apps (Connect アプリケーションの認証)」Leaving the Site​を参照)。

  • issue​ ( IssueLeaving the Site​): 現在の課題。課題が要求コンテキストオブジェクトで提供されている場合にのみ使用可能。

  • issues​ ( IssuesLeaving the Site​ の ListLeaving the Site​): JQL クエリに一致する課題のコレクション。JQL が要求コンテキストオブジェクトで提供されている場合にのみ使用可能。

  • project​ ( ProjectLeaving the Site​): 現在のプロジェクト。プロジェクトが要求コンテキストオブジェクトで提供されている場合にのみ使用可能。

  • sprint​ ( SprintLeaving the Site​): 現在のスプリント。スプリントが要求コンテキストオブジェクトで提供されている場合にのみ使用可能。

  • board​ ( BoardLeaving the Site​): 現在のボード。ボードが要求コンテキストオブジェクトで提供されている場合にのみ使用可能。

  • serviceDesk​ ( ServiceDeskLeaving the Site​): 現在のサービスデスク。サービスデスクが要求コンテキストオブジェクトで提供されている場合にのみ使用可能。

  • customerRequest​ ( CustomerRequestLeaving the Site​): 現在の顧客要求。顧客要求が要求コンテキストオブジェクトで提供されている場合にのみ使用可能。この操作には匿名でアクセスできます。

必要な権限:

なし。

ただし、式はユーザーの権限に応じてユーザーごとに異なる結果を返す場合があります。たとえば、異なるユーザーには同じ課題に関する異なるコメントが表示される場合があります。Jira Software のコンテキスト変数 (​board​ および ​sprint​) または項目 (​issue.sprint​ など) にアクセスするには、Jira Software へのアクセス権が必要です。

この操作では、/rest/api/3/expression/eval エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

expand (展開)

String (文字列)

expand​ を使用して、追加情報を応答に含めます。このパラメーターは、式の複雑さに関する情報を返す ​meta.complexity​ を受け入れます。たとえば、式で使用される負荷のかかる操作の数、式が[複雑さの制限](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#restrictionsLeaving the Site) にどの程度近づいているかなど。式を設計およびデバッグするときに役立ちます。

Body (本文)

Any (任意)

使用するコンテンツ。

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Create Custom Field

<jira:create-rest-api3-field>

カスタム項目を作成します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/field エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Create Custom Field Context

<jira:create-rest-api3-field-context-by-field-id>

カスタム項目コンテキストを作成します。​projectIds​ が空の場合、グローバルコンテキストが作成されます。グローバルコンテキストは、すべてのプロジェクトに適用されるコンテキストです。​issueTypeIds​ が空の場合、コンテキストはすべての課題種別に適用されます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/field/{fieldId}/context エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Id (項目 ID)

String (文字列)

カスタム項目の ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Remove Issue Types From Context

<jira:create-rest-api3-field-context-issuetype-remove-by-field-id-context-id>

カスタム項目コンテキストから課題種別を削除します。課題種別のないカスタム項目コンテキストは、すべての課題種別に適用されます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/field/{fieldId}/context/{contextId}/issuetype/remove エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Id (項目 ID)

String (文字列)

カスタム項目の ID。

x

Context Id (コンテキスト ID)

Number (数値)

コンテキストの ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Custom Field Contexts For Projects And Issue Types

<jira:create-rest-api3-field-context-mapping-by-field-id>

プロジェクトと課題種別のマッピングのページ分割されたリスト、および各マッピングでプロジェクトと課題種別に適用される カスタム項目コンテキストLeaving the Site​の ID を返します。そのプロジェクトにカスタム項目コンテキストが割り当てられていない場合、すべてのプロジェクトに適用されるカスタム項目コンテキストが存在し、それがその課題種別またはすべての課題種別にも適用される場合は、そのコンテキストが返されます。カスタム項目コンテキストが見つからない場合、返されるカスタム項目コンテキスト ID は ​null​ です。重複するプロジェクトと課題種別のマッピングを要求で提供することはできません。返される値の順序は、要求で提供された順序と同じです。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/field/{fieldId}/context/mapping エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Id (項目 ID)

String (文字列)

カスタム項目の ID。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

* Any の配列

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Create Custom Field Option

<jira:create-rest-api3-field-context-option-by-field-id-context-id>

オプションを作成し、カスタム選択項目のデータ型が選択リスト (カスケード) の場合、カスタム選択項目のオプションをカスケードします。オプションは、項目のコンテキストに追加されます。要求ごとに作成できるオプションの最大数は 1000 個で、各項目には最大 10000 個のオプションを含めることができます。この操作は、Jira で作成されたカスタム項目オプションまたはこのリソースからの操作で機能します。問課題項目を操作するには、Connect アプリケーション用に作成されたリストオプションを選択し、​Issue custom field options​ 操作を使用します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/field/{fieldId}/context/{contextId}/option エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Id (項目 ID)

String (文字列)

カスタム項目の ID。

x

Context Id (コンテキスト ID)

Number (数値)

コンテキストの ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Remove Custom Field Context From Projects

<jira:create-rest-api3-field-context-project-remove-by-field-id-context-id>

プロジェクトからカスタム項目コンテキストを削除します。プロジェクトのないカスタム項目コンテキストは、すべてのプロジェクトに適用されます。カスタム項目コンテキストからすべてのプロジェクトを削除すると、すべてのプロジェクトに適用されます。要求内のプロジェクトがコンテキストに割り当てられていない場合、または操作によって項目に 2 つのグローバルコンテキストが発生する場合、操作は失敗します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/field/{fieldId}/context/{contextId}/project/remove エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Id (項目 ID)

String (文字列)

カスタム項目の ID。

x

Context Id (コンテキスト ID)

Number (数値)

コンテキストの ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Create Issue Field Option

<jira:create-rest-api3-field-option-by-field-key>

選択リスト課題項目のオプションを作成します。この操作は、​Connect アプリケーションで追加された課題項目選択リストオプションでのみ機能します​。Jira で作成されたか、[Issue custom field options](#api-group-Issue-custom-field-options) リソースからの操作を使用して作成された課題項目選択リストオプションでは使用できません。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

項目を提供するアプリケーションでは、Jira 権限は必要ありません。

この操作では、/rest/api/3/field/{fieldKey}/option エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Key (項目キー)

String (文字列)

項目キーは次の形式で指定されます: $(app-key)\​\​$(field-key)​。例: example-add-on\_\_example-issue-field​。​fieldKey​ 値を決定するには、次のいずれかを実行します。

  • アプリケーションのプラグイン記述子を開く。​app-key​ は上部にあるキーで、​field-key​ は ​jiraIssueFields​ モジュール内のキーです。 app-key​ は、Atlassian Universal Plugin Manager のアプリケーションリストにもあります。

  • [Get fields](#api-rest-api-3-field-get) を実行する。項目の詳細で、値が ​key​ 内で返されます。(例: "key": "teams-add-on__team-issue-field"​)。

x

Body (本文)

Any (任意)

使用するコンテンツ。

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Create Filter

<jira:create-rest-api3-filter>

検索条件を作成します。検索条件は [default share scope](#api-rest-api-3-filter-post) に従って共有されます。検索条件はお気に入りとして選択されていません。

必要な権限:

Jira にアクセスするための権限。

この操作では、/rest/api/3/filter エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

expand (展開)

String (文字列)

expand​ を使用して、検索条件に関する追加情報を応答に含めます。このパラメーターは、カンマ区切りのリストを受け入れます。expand (展開) には次のオプションがあります。

  • sharedUsers​: 検索条件が共有されているユーザーを返します。これには、検索条件が共有されているプロジェクトを参照できるユーザーが含まれます。​sharedUsers​ を指定しない場合、​sharedUsers​ オブジェクトは返されますが、ユーザーはリストされません。返されるユーザーのリストは 1000 個に制限され、追加ユーザーにアクセスするには、展開要求に ​[start-index:end-index]​ を追加します。たとえば、次の 1000 ユーザーにアクセスするには、​?expand=sharedUsers[1001:2000]​ を使用します。

  • subscriptions​: 検索条件にサブスクライブしているユーザーを返します。​subscriptions​ を指定しない場合、​subscriptions​ オブジェクトは返されますが、サブスクリプションはリストされません。返されるサブスクリプションのリストは 1000 個に制限され、追加サブスクリプションにアクセスするには、展開要求に ​[start-index:end-index]​ を追加します。たとえば、次の 1000 サブスクリプションにアクセスするには、​?expand=subscriptions[1001:2000]​ を使用します。

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Add Share Permission

<jira:create-rest-api3-filter-permission-by-id>

検索条件に共有権限を追加します。グローバル共有権限 (すべてのログインユーザーまたは公開用に 1 つ) を追加すると、検索条件のすべての共有権限が上書きされます。この操作では、[Update filter](#api-rest-api-3-filter-id-put) とは異なるオブジェクトを使用して共有権限を更新します。

必要な権限:

「Share dashboards and filters (ダッシュボードと検索条件の共有)」 グローバル権限Leaving the Site​。さらに、ユーザーが検索条件を所有する必要があります。

この操作では、/rest/api/3/filter/{id}/permission エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

検索条件の ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Create Group

<jira:create-rest-api3-group>

グループを作成します。

必要な権限:

サイト管理 (​site-admin​ [グループ](https://confluence.atlassian.com/x/24xjLLeaving the Site) のメンバー)。

この操作では、/rest/api/3/group エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Add User To Group

<jira:create-rest-api3-group-user>

グループにユーザーを追加します。

必要な権限:​ サイト管理 (​site-admin​ [グループ](https://confluence.atlassian.com/x/24xjLLeaving the Site) のメンバー)。

この操作では、/rest/api/3/group/user エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

groupname (グループ名)

String (文字列)

グループの名前 (大文字と小文字を区別)。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Create Issue

<jira:create-rest-api3-issue>

課題を作成するか、サブタスクを作成するオプションが Jira で有効になっている場合はサブタスクを作成します。移行を適用して、課題またはサブタスクをデフォルトの開始ステップ以外のワークフローステップに移動し、課題プロパティを設定できます。課題またはサブタスクのコンテンツは、​update​ および ​fields​ を使用して定義されます。課題またはサブタスクで設定できる項目は、[Get create issue metadata](#api-rest-api-3-issue-createmeta-get) を使用して決定されます。これらは、課題の作成画面に表示される項目と同じです。​description​、​environment​、および ​textarea​ 型のカスタム項目 (複数行のテキスト項目) は、Atlassian Document Format のコンテンツを使用します。単一行のカスタム項目 (​textfield​) は文字列を受け入れ、Atlassian Document Format のコンテンツを処理しません。

サブタスクの作成は、次のように課題の作成とは異なります。

  • issueType​ は、サブタスクの課題種別に設定する必要があります (サブタスクの課題種別を確認するには [Get create issue metadata](#api-rest-api-3-issue-createmeta-get) を使用)。

  • parent​ には、親の課題の ID またはキーが含まれる必要があります。次世代のプロジェクトでは、親と子が同じプロジェクトのメンバーである場合、課題が子になる可能性があります。従来のプロジェクトでは、親項目はサブタスクでのみ有効です。

必要な権限:

課題またはサブタスクが作成されるプロジェクトに対する​「Browse projects (プロジェクトの参照)」​および​「Create issues (課題の作成)」​[プロジェクト権限] (https://confluence.atlassian.com/x/yodKLg)。Leaving the Site

この操作では、/rest/api/3/issue エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Update History (履歴を更新)

Boolean (ブール)

Jira で ​[Projects (プロジェクト)]​ の下に表示されているように、課題が作成されたプロジェクトがユーザーの ​[Recently viewed (最近参照したデータ)]​ プロジェクトリストに追加されるかどうか。

false

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Add Attachment

<jira:create-rest-api3-issue-attachments-by-issue-id-or-key>

1 つ以上の添付ファイルを課題に追加します。添付ファイルはマルチパート/フォームデータ ([RFC 1867](https://www.ietf.org/rfc/rfc1867.txt)Leaving the Site) として投稿されます。

注意:

  • 要求には ​X-Atlassian-Token: no-check​ ヘッダーが必要です。このヘッダーがない場合はブロックされます。

  • 添付ファイルを含むマルチパート/フォームデータパラメーターの名前は、​file​ にする必要があります。次の例では、​myfile.txt​ というファイルを課題 ​TEST-123​ にアップロードします: curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: no-check" -F "file=@myfile.txt" https://your-domain.atlassian.net/rest/api/3/issue/TEST-123/attachmentsLeaving the Site​ ヒント: クライアントライブラリを使用します。多くのクライアントライブラリには、マルチパート POST 操作を処理するためのクラスがあります。たとえば、Java の Apache HTTP コンポーネントライブラリには、マルチパート POST 操作用の MultiPartEntityLeaving the Site​ クラスがあります。この操作には匿名でアクセスできます。

必要な権限:

  • 課題を含むプロジェクトに対する​「Browse Projects (プロジェクトの参照)」​および​「Create attachments (添付ファイルの作成)」 プロジェクト権限Leaving the Site​。

  • 課題レベルのセキュリティLeaving the Site​が設定されている場合、課題を表示する課題レベルのセキュリティ権限。

この操作では、/rest/api/3/issue/{issueIdOrKey}/attachments エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

添付ファイルが追加される課題の ID またはキー。

x

File Name (ファイル名)

String (文字列)

アップロードされた添付ファイルのファイル名。

x

Body (本文)

String (文字列)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Create Issues

<jira:create-rest-api3-issue-bulk>

課題を作成します。また、サブタスクを作成するオプションが Jira で有効になっている場合はサブタスクを作成します。移行を適用して、課題またはサブタスクをデフォルトの開始ステップ以外のワークフローステップに移動し、課題プロパティを設定できます。各課題またはサブタスクのコンテンツは、​update​ および ​fields​ を使用して定義されます。課題またはサブタスクで設定できる項目は、[Get create issue metadata](#api-rest-api-3-issue-createmeta-get) を使用して決定されます。これらは、課題の作成画面に表示される項目と同じです。​description​、​environment​、および ​textarea​ 型のカスタム項目 (複数行のテキスト項目) は、Atlassian Document Format のコンテンツを使用します。単一行のカスタム項目 (​textfield​) は文字列を受け入れ、Atlassian Document Format のコンテンツを処理しません。

サブタスクの作成は、次のように課題の作成とは異なります。

  • issueType​ は、サブタスクの課題種別に設定する必要があります (サブタスクの課題種別を確認するには [Get create issue metadata](#api-rest-api-3-issue-createmeta-get) を使用)。

  • parent​ には、親の課題の ID またはキーが含まれる必要があります。

必要な権限:

各課題またはサブタスクが作成されるプロジェクトに対する​「Browse projects (プロジェクトの参照)」​および​「Create issues (課題の作成)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/issue/bulk エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Add Comment

<jira:create-rest-api3-issue-comment-by-issue-id-or-key>

課題にコメントを追加します。この操作には匿名でアクセスできます。

必要な権限:

  • コメントを含む課題があるプロジェクトに対する​「Browse projects (プロジェクトの参照)」​および​「Add comments (コメントの追加)」 プロジェクト権限Leaving the Site​。

  • 課題レベルのセキュリティLeaving the Site​が設定されている場合、課題を表示する課題レベルのセキュリティ権限。

この操作では、/rest/api/3/issue/{issueIdOrKey}/comment エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

expand (展開)

String (文字列)

expand​ を使用して、コメントに関する追加情報を応答に含めます。このパラメーターは、HTML で表示されるコメント本文を返す ​renderedBody​ を受け入れます。

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

<jira:create-rest-api3-issue-link>

2 つの課題間のリンクを作成します。この操作を使用して、2 つの課題間のリレーションを示し、必要に応じてリンク元 (外向き) の課題にコメントを追加します。このリソースを使用するには、サイトで 課題のリンクLeaving the Site​が有効になっている必要があります。このリソースは、課題リンクの作成時に何も返しません。課題リンクの ID を取得するには、​リンクされた課題キーLeaving the Site​?fields=issuelinks​ を使用します。リンク要求でリンクが重複する場合、応答は課題リンクが作成されたことを示します。要求にコメントが含まれる場合、そのコメントが追加されます。この操作には匿名でアクセスできます。

必要な権限:

  • リンクされる課題を含むすべてのプロジェクトに対する​「Browse Projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

  • リンク元 (外向き) の課題を含むプロジェクトに対する​「Link issues (課題のリンク)」 プロジェクト権限Leaving the Site​。

  • 課題レベルのセキュリティLeaving the Site​が設定されている場合、課題を表示する課題レベルのセキュリティ権限。

  • コメントの表示制限がある場合、グループに属しているか、表示が制限されているロールがある。

この操作では、/rest/api/3/issueLink エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Create Issue Link Type

<jira:create-rest-api3-issue-link-type>

課題リンク種別を作成します。この操作を使用して、課題がリンクされている理由の説明を作成します。課題リンク種別は、リンクの内向きおよび外向きのリレーションの名前と説明で構成されます。この操作を使用するには、サイトで 課題のリンクLeaving the Site​が有効になっている必要があります。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/issueLinkType エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Notify

<jira:create-rest-api3-issue-notify-by-issue-id-or-key>

課題のメール通知を作成し、それをメールキューに追加します。

必要な権限:

この操作では、/rest/api/3/issue/{issueIdOrKey}/notify エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

通知が送信される課題の ID またはキー。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Bulk Set Issues Properties

<jira:create-rest-api3-issue-properties>

課題のエンティティプロパティの値を設定します。最大 10,000 個の課題に対して最大 10 個のエンティティプロパティをセットアップできます。リクエストボディの値は、 有効Leaving the Site​かつ空でない JSON である必要があります。1 つの課題プロパティ値の最大長は 32768 文字です。この操作には匿名でアクセスできます。

この操作は次の特性があります。

  • トランザクション。対象となるすべての課題ですべてのプロパティが更新されるか、エラーが発生した場合はプロパティが更新されません。

  • [非同期](#async)。応答の ​location​ リンクに従ってタスクの状況を確認し、[Get task](#api-rest-api-3-task-taskId-get) を使用して後続の更新を取得します。

必要な権限:

  • 課題を含むプロジェクトに対する​「Browse projects (プロジェクトの参照)」​および​「Edit issues (課題の編集)」 プロジェクト権限Leaving the Site​。

  • 課題レベルのセキュリティLeaving the Site​が設定されている場合、課題を表示する課題レベルのセキュリティ権限。

この操作では、/rest/api/3/issue/properties エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Create Or Update Remote Issue Link

<jira:create-rest-api3-issue-remotelink-by-issue-id-or-key>

課題のリモート課題リンクを作成または更新します。​globalId​ が指定され、そのグローバル ID を使用するリモート課題リンクが見つかった場合、そのリンクが更新されます。要求に値がない項目は null に設定されます。それ以外の場合、リモート課題リンクが作成されます。この操作には、 課題リンクがアクティブになっているLeaving the Site​必要があります。この操作には匿名でアクセスできます。

必要な権限:

  • 課題を含むプロジェクトに対する​「Browse projects (プロジェクトの参照)」​および​「Link issues (課題のリンク)」 プロジェクト権限Leaving the Site​。

  • 課題レベルのセキュリティLeaving the Site​が設定されている場合、課題を表示する課題レベルのセキュリティ権限。

この操作では、/rest/api/3/issue/{issueIdOrKey}/remotelink エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Do Transition

<jira:create-rest-api3-issue-transitions-by-issue-id-or-key>

課題の移行を実行し、移行に画面がある場合は、移行画面の項目を更新します。 移行画面の項目を更新するには、リクエストボディの ​fields​ または ​update​ パラメーターで項目を指定します。[Get transitions](#api-rest-api-3-issue-issueIdOrKey-transitions-get) と ​transitions.fields​ 展開を使用して、項目に関する詳細を取得します。この操作には匿名でアクセスできます。

必要な権限:

  • 課題を含むプロジェクトに対する​「Browse projects (プロジェクトの参照)」​および​「Transition issues (課題の移行)」 プロジェクト権限Leaving the Site​。

  • 課題レベルのセキュリティLeaving the Site​が設定されている場合、課題を表示する課題レベルのセキュリティ権限。

この操作では、/rest/api/3/issue/{issueIdOrKey}/transitions エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Add Vote

<jira:create-rest-api3-issue-votes-by-issue-id-or-key>

ユーザーの投票を課題に追加します。これは、ユーザーが Jira で課題に対する ​[Vote (投票)]​ をクリックするのと同じです。この操作には、​[Allow users to vote on issues (課題に対する投票をユーザーに許可)]​ オプションが ​[ON]​ になっている必要があります。このオプションは、Jira の [General (一般)] 設定で定義されます。詳細は、 「Configuring Jira application options (Jira アプリケーションオプションの設定)」Leaving the Site​を参照してください。

必要な権限:

この操作では、/rest/api/3/issue/{issueIdOrKey}/votes エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Add Watcher

<jira:create-rest-api3-issue-watchers-by-issue-id-or-key>

ユーザーのアカウント ID を渡すことで、課題のウォッチャーとしてユーザーを追加します。例: "123456789"​。ユーザーが指定されていない場合は、コール元ユーザーが追加されます。この操作には、​[Allow users to watch issues (課題の監視をユーザーに許可)]​ オプションが ​[ON]​ になっている必要があります。このオプションは、Jira の [General (一般)] 設定で定義されます。詳細は、 「Configuring Jira application options (Jira アプリケーションオプションの設定)」Leaving the Site​を参照してください。

必要な権限:

  • 課題を含むプロジェクトに対する​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

  • 課題レベルのセキュリティLeaving the Site​が設定されている場合、課題を表示する課題レベルのセキュリティ権限。

  • 自分以外のユーザーをウォッチリストに追加するには、課題を含むプロジェクトに対する​「Manage watcher list (ウォッチャーリストの管理)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/issue/{issueIdOrKey}/watchers エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

Body (本文)

String (文字列)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Add Worklog

<jira:create-rest-api3-issue-worklog-by-issue-id-or-key>

課題に作業ログを追加します。Jira でタイムトラッキングを有効にする必要があります。有効にしないと、この操作でエラーが返されます。詳細は、 「Configuring time tracking (タイムトラッキングの設定)」Leaving the Site​を参照してください。この操作には匿名でアクセスできます。

必要な権限:

  • 課題を含むプロジェクトに対する​「Browse projects (プロジェクトの参照)」​および​「Work on issues (課題の作業)」 プロジェクト権限Leaving the Site​。

  • 課題レベルのセキュリティLeaving the Site​が設定されている場合、課題を表示する課題レベルのセキュリティ権限。

この操作では、/rest/api/3/issue/{issueIdOrKey}/worklog エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

Notify Users (ユーザーに通知)

Boolean (ブール)

課題を監視しているユーザーにメールで通知するかどうか。

true

Adjust Estimate (見積を調整)

Enumeration (列挙)。次のいずれかになります。

  • NEW

  • LEAVE

  • MANUAL

  • AUTO

課題の時間の見積を更新する方法を定義します。オプションは次のとおりです。

  • new​: newEstimate​ で定義された特定の値に見積を設定します。

  • leave​: 見積は変更されません。

  • manual​: reduceBy​ で指定された量だけ見積を減らします。

  • auto​: 作業ログの ​timeSpent​ の値だけ見積を減らします。

AUTO

New Estimate (新規見積)

String (文字列)

課題の残り時間の見積として設定する値 (日 (#d)、時間 (\#h)、または分 (\#m or \#))。たとえば、​2d​ と指定します。​adjustEstimate​ が ​new​ の場合は必須です。

Reduce By (削減量)

String (文字列)

課題の残りの見積を減らす量 (日 (\#d)、時間 (\#h)、または分 (\#m))。たとえば、​2d​ と指定します。​adjustEstimate​ が ​manual​ の場合は必須です。

expand (展開)

String (文字列)

expand​ を使用して、作業ログに関する追加情報を応答に含めます。このパラメーターは、作業ログのプロパティを返す ​properties​ を受け入れます。

Override Editable Flag (編集可能なフラグを上書き)

Boolean (ブール)

jira.issue.editable が false に設定されているか欠落しているため、課題が編集可能でない場合でも、作業ログエントリを課題に追加するかどうか。たとえば、課題がクローズされている場合など。このフラグを使用できるのは、管理スコープ権限を持つ Connect アプリケーションユーザーのみです。

false

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Create Issue Type

<jira:create-rest-api3-issuetype>

課題種別を作成し、それをデフォルトの課題種別スキームに追加します。 必要な権限:​ ​「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/issuetype エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Create Issue Type Avatar

<jira:create-rest-api3-issuetype-avatar2-by-id>

課題種別のアバターを読み込みます。要求の本文でアバターのローカルファイルの場所を指定します。次のヘッダーも含めます。

  • X-Atlassian-Token: no-check​: XSRF 保護で要求がブロックされないようにします。詳細は、[「Special Headers (特殊なヘッダー)」](#special-request-headers)を参照してください。

  • Content-Type: image/image type​: 有効な画像の種類は、JPEG、GIF、または PNG です。例: curl --request POST \ --user email@example.com: \ --header 'X-Atlassian-Token: no-check' \ --header 'Content-Type: image/< image_type>' \ --data-binary "<@/path/to/file/with/your/avatar>" \ --url 'https://your-domain.atlassian.net/rest/api/3/issuetype/{issueTypeId}'This

アバターは正方形にトリミングされます。トリミングパラメーターが指定されていない場合、画像の左上から始まる正方形になります。正方形の辺の長さは、画像の高さまたは幅のいずれか小さい方に設定されます。トリミングされた画像は、16x16、24x24、32x32、48x48 のサイズのアバターを作成するために使用されます。アバターの作成後、[Update issue type](#api-rest-api-3-issuetype-id-put) を使用して、それを課題種別の表示アバターとして設定します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/issuetype/{id}/avatar2 エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

課題種別の ID。

x

x

Number (数値)

トリミング領域の左上隅の X 座標。

0

y

Number (数値)

トリミング領域の左上隅の Y 座標。

0

size (サイズ)

Number (数値)

トリミング領域の各辺の長さ。

x

Body (本文)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Create Issue Type Scheme

<jira:create-rest-api3-issuetypescheme>

課題種別スキームを作成します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/issuetypescheme エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Create Issue Type Screen Scheme

<jira:create-rest-api3-issuetypescreenscheme>

課題種別画面スキームを作成します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/issuetypescreenscheme エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Remove Mappings From Issue Type Screen Scheme

<jira:create-rest-api3-issuetypescreenscheme-mapping-remove-by-issue-type-screen-scheme-id>

課題種別画面スキームから、画面スキームに対する課題種別のマッピングを削除します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping/remove エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Type Screen Scheme Id (課題種別画面スキーム ID)

String (文字列)

課題種別画面スキームの ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Match Issues

<jira:create-rest-api3-jql-match>

1 つ以上の JQL クエリによって 1 つ以上の課題が返されるかどうかを確認します。

必要な権限:

なし。ただし、ユーザーが次の条件を満たす場合にのみ課題が JQL クエリに対して照合されます。

この操作では、/rest/api/3/jql/match エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Parse Jql Queries

<jira:create-rest-api3-jql-parse>

JQL クエリを解析して検証します。検証は、現在のユーザーのコンテキストで実行されます。この操作には匿名でアクセスできます。

必要な権限:

なし。

この操作では、/rest/api/3/jql/parse エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

検証

Enumeration (列挙)。次のいずれかになります。

  • STRICT

  • WARN

  • NONE

JQL クエリを検証し、その検証結果を処理する方法。次の検証オプションがあります。* ​strict​: すべてのエラーを返します。検証が失敗した場合、クエリ構造は返されません。​warn​: すべてのエラーを返します。検証は失敗しても JQL クエリが正しく形成されている場合、クエリ構造が返されます。 *​none​: 検証は実行されません。JQL クエリが正しく形成されている場合、クエリ構造が返されます。

STRICT

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Migrate Queries

<jira:create-rest-api3-jql-pdcleaner>

ユーザー ID (ユーザー名またはユーザーキー) を使用する 1 つ以上の JQL クエリを、アカウント ID を使用する同等の JQL クエリに変換します。システムに JQL クエリが保存され、それらを GDPR に準拠させる場合は、この操作を使用することをお勧めします。GDPR 関連の変更についての詳細は、 移行ガイドLeaving the Site​を参照してください。

必要な権限:

Jira にアクセスするための権限。

この操作では、/rest/api/3/jql/pdcleaner エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Bulk Permissions

<jira:create-rest-api3-permissions-check>

戻り:

  • グローバル権限のリストの場合、ユーザーに付与されたグローバル権限。

  • プロジェクト権限のリスト、およびプロジェクトと課題のリストの場合、各プロジェクト権限でユーザーがアクセスまたは操作できるプロジェクトと課題のリスト。アカウント ID が指定されていない場合、操作はログインユーザーの詳細を返します。無効なプロジェクトおよび課題 ID は無視されます。

  • 最大 1000 個のプロジェクトと 1000 個の課題を確認できます。

  • 入力で null 値が含まれる globalPermissions、projectPermissions、プロジェクト、権限、課題は無視されます。

  • 入力で空白文字列値が含まれる globalPermissions および権限は無視されます。この操作には匿名でアクセスできます。

必要な権限:

他のユーザーの権限を確認する場合は​「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​、それ以外の場合はなし。ただし、Connect アプリケーションは管理権限がなくても、アプリケーションサーバーからコールして任意のユーザーの権限の詳細を取得できます。この Connect アプリケーションの機能は、ブラウザーで AP.request() を使用して行われたコールには適用されません。

この操作では、/rest/api/3/permissions/check エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Permitted Projects

<jira:create-rest-api3-permissions-project>

ユーザーにプロジェクト権限のリストが付与されているすべてのプロジェクトを返します。この操作には匿名でアクセスできます。

必要な権限:

なし。

この操作では、/rest/api/3/permissions/project エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Create Permission Scheme

<jira:create-rest-api3-permissionscheme>

新しい権限スキームを作成します。権限セットの付与を定義するかどうかに関わらす、権限スキームを作成できます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/permissionscheme エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

expand (展開)

String (文字列)

expand (展開) を使用して、追加情報を応答に含めます。このパラメーターは、カンマ区切りのリストを受け入れます。値を指定すると、権限は常に含まれるます。expand (展開) には次のオプションがあります。

  • all​: すべての展開可能な情報を返します。

  • field​: 権限が付与されたカスタム項目に関する情報を返します。

  • group​: 権限が付与されたグループに関する情報を返します。

  • permissions​: 各権限スキームのすべての権限付与を返します。

  • projectRole​: 権限が付与されたプロジェクトロールに関する情報を返します。

  • user​: 権限が付与されたユーザーに関する情報を返します。

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Create Permission Grant

<jira:create-rest-api3-permissionscheme-permission-by-scheme-id>

権限スキームの権限付与を作成します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/permissionscheme/{schemeId}/permission エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Scheme Id (スキーム ID)

Number (数値)

新しい権限付与を作成する権限スキームの ID。

x

expand (展開)

String (文字列)

expand​ を使用して、追加情報を応答に含めます。このパラメーターは、カンマ区切りのリストを受け入れます。値を指定すると、権限は常に含まれるます。expand (展開) には次のオプションがあります。

  • permissions​: 各権限スキームのすべての権限付与を返します。

  • user​: 権限が付与されたユーザーに関する情報を返します。

  • group​: 権限が付与されたグループに関する情報を返します。

  • projectRole​: 権限が付与されたプロジェクトロールに関する情報を返します。

  • field​: 権限が付与されたカスタム項目に関する情報を返します。

  • all​: すべての展開可能な情報を返します。

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Create Project

<jira:create-rest-api3-project>

次の表に示すように、プロジェクトタイプテンプレートに基づいてプロジェクトを作成します。

プロジェクトタイプキー プロジェクトテンプレートキー

business

com.atlassian.jira-core-project-templates:jira-core-simplified-content-management​、​com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval​、​com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking​、​com.atlassian.jira-core-project-templates:jira-core-simplified-process-control​、​com.atlassian.jira-core-project-templates:jira-core-simplified-procurement​、​com.atlassian.jira-core-project-templates:jira-core-simplified-project-management​、​com.atlassian.jira-core-project-templates:jira-core-simplified-recruitment​、​com.atlassian.jira-core-project-templates:jira-core-simplified-task-tracking

service_desk

com.atlassian.servicedesk:simplified-it-service-desk​、​com.atlassian.servicedesk:simplified-internal-service-desk​、​com.atlassian.servicedesk:simplified-external-service-desk

software

com.pyxis.greenhopper.jira:gh-simplified-agility-kanban​、​com.pyxis.greenhopper.jira:gh-simplified-agility-scrum​、​com.pyxis.greenhopper.jira:gh-simplified-basic​、​com.pyxis.greenhopper.jira:gh-simplified-kanban-classic​、​com.pyxis.greenhopper.jira:gh-simplified-scrum-classic

プロジェクトタイプは、インストールされている Jira 機能に応じて次のように使用できます。

  • Jira Core (デフォルト): business​ プロジェクトが有効になります。

  • Jira Service Management: service_desk​ プロジェクトが有効になります。

  • Jira Software: software​ プロジェクトが有効になります。

インストールされている機能を判断するには、​[Jira settings (Jira 設定)]​ > ​[Apps (アプリケーション)]​ > ​[Manage apps (アプリケーションを管理)]​ に移動し、[System Apps (システムアプリケーション)] リストを確認します。Jira Software または Jira Service Management を JIRA インスタンスに追加するには、​[Jira settings (Jira 設定)]​ > ​[Apps (アプリケーション)]​ > ​[Finding new apps (新規アプリケーションの検索)]​ を使用します。詳細は、 「Managing add-ons (アドオンの管理)」Leaving the Site​を参照してください。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/project エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Archive Project

<jira:create-rest-api3-project-archive-by-project-id-or-key>

プロジェクトをアーカイブします。アーカイブされたプロジェクトは削除できません。アーカイブされたプロジェクトを削除するには、プロジェクトを復元してから削除します。プロジェクトを復元するには、Jira UI を使用します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/project/{projectIdOrKey}/archive エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Id Or Key (プロジェクト ID またはキー)

String (文字列)

プロジェクト ID またはプロジェクトキー (大文字と小文字を区別)。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Create Project Avatar

<jira:create-rest-api3-project-avatar2-by-project-id-or-key>

プロジェクトのアバターを読み込みます。要求の本文でアバターのローカルファイルの場所を指定します。次のヘッダーも含めます。

  • X-Atlassian-Token: no-check​: XSRF 保護で要求がブロックされないようにします。詳細は、[「Special Headers (特殊なヘッダー)」](#special-request-headers)を参照してください。

  • Content-Type: image/image type​: 有効な画像の種類は、JPEG、GIF、または PNG です。

例

curl --request POST ​--user email@example.com: ​--header 'X-Atlassian-Token: no-check' ​--header 'Content-Type: image/< image_type>' ​--data-binary "<@/path/to/file/with/your/avatar>" ​--url 'https://your-domain.atlassian.net/rest/api/3/project/{projectIdOrKey}/avatar2'

アバターは正方形にトリミングされます。トリミングパラメーターが指定されていない場合、画像の左上から始まる正方形になります。正方形の辺の長さは、画像の高さまたは幅のいずれか小さい方に設定されます。トリミングされた画像は、16x16、24x24、32x32、48x48 のサイズのアバターを作成するために使用されます。アバターの作成後、[Set project avatar](#api-rest-api-3-project-projectIdOrKey-avatar-put) を使用して、それをプロジェクトの表示アバターとして設定します。

必要な権限:​ ​「Administer projects (プロジェクトの管理)」

プロジェクト権限Leaving the Site

この操作では、/rest/api/3/project/{projectIdOrKey}/avatar2 エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Id Or Key (プロジェクト ID またはキー)

String (文字列)

プロジェクトの ID または (大文字と小文字を区別する) キー。

x

x

Number (数値)

トリミング領域の左上隅の X 座標。

0

y

Number (数値)

トリミング領域の左上隅の Y 座標。

0

size (サイズ)

Number (数値)

トリミング領域の各辺の長さ。

Body (本文)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Create Project Category

<jira:create-rest-api3-project-category>

プロジェクトカテゴリを作成します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/projectCategory エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Project Asynchronously

<jira:create-rest-api3-project-delete-by-project-id-or-key>

プロジェクトを非同期で削除します。この操作は次の特性があります。

  • トランザクション (削除の一部が失敗した場合、プロジェクトは削除されません)。

  • 非同期

応答の ​location​ リンクに従ってタスクの状況を確認し、[Get task](#api-rest-api-3-task-taskId-get) を使用して後続の更新を取得します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/project/{projectIdOrKey}/delete エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Id Or Key (プロジェクト ID またはキー)

String (文字列)

プロジェクト ID またはプロジェクトキー (大文字と小文字を区別)。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

restore

<jira:create-rest-api3-project-restore-by-project-id-or-key>

Jira のごみ箱からプロジェクトを復元します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/project/{projectIdOrKey}/restore エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Id Or Key (プロジェクト ID またはキー)

String (文字列)

プロジェクト ID またはプロジェクトキー (大文字と小文字を区別)。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Add Actor Users

<jira:create-rest-api3-project-role-by-project-id-or-key-id>

プロジェクトのプロジェクトロールにアクターを追加します。プロジェクトのすべてのアクターを置き換えるには、[Set actors for project role](#api-rest-api-3-project-projectIdOrKey-role-id-put) を使用します。この操作には匿名でアクセスできます。

必要な権限:

プロジェクトに対する​「Administer Projects (プロジェクトの管理)」 プロジェクト権限Leaving the Site​、または​「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/project/{projectIdOrKey}/role/{id} エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Id Or Key (プロジェクト ID またはキー)

String (文字列)

プロジェクト ID またはプロジェクトキー (大文字と小文字を区別)。

x

id

Number (数値)

プロジェクトロールの ID。[Get all project roles](#api-rest-api-3-role-get) を使用して、プロジェクトロール ID のリストを取得します。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Create Project Role

<jira:create-rest-api3-role>

[デフォルトアクター](#api-rest-api-3-resolution-get) のない新しいプロジェクトロールを作成します。[Add default actors to project role](#api-rest-api-3-role-id-actors-post) 操作を使用して、プロジェクトロールの作成後にデフォルトアクターをそのロールに追加します。

新しいプロジェクトロールは作成時にすべてのプロジェクトで使用できますが、プロジェクトロールに関連付けられたデフォルトアクターは、ロールが作成される前に存在していたプロジェクトには追加されません。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/role エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Add Project Role Actors To Role

<jira:create-rest-api3-role-actors-by-id>

ロールに [デフォルトアクター](#api-rest-api-3-resolution-get) を追加します。グループまたはユーザーを追加できますが、同じ要求にグループとユーザーを追加することはできません。プロジェクトロールのデフォルトアクターを変更しても、すでに作成されているプロジェクトのプロジェクトロールメンバーには影響しません。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/role/{id}/actors エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

プロジェクトロールの ID。[Get all project roles](#api-rest-api-3-role-get) を使用して、プロジェクトロール ID のリストを取得します。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Partial Update Project Role

<jira:create-rest-api3-role-by-id>

プロジェクトロールの名前または説明のいずれかを更新します。この操作を使用して、名前と説明の両方を同時に更新することはできません。名前と説明を含めて要求を送信した場合、名前のみが更新されます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/role/{id} エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

プロジェクトロールの ID。[Get all project roles](#api-rest-api-3-role-get) を使用して、プロジェクトロール ID のリストを取得します。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Create Screen

<jira:create-rest-api3-screens>

デフォルトの項目タブを含む画面を作成します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/screens エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Add Field To Default Screen

<jira:create-rest-api3-screens-add-to-default-by-field-id>

デフォルト画面のデフォルトタブに項目を追加します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/screens/addToDefault/{fieldId} エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Id (項目 ID)

String (文字列)

項目の ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Add Screen Tab

<jira:create-rest-api3-screens-tabs-by-screen-id>

画面のタブを作成します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/screens/{screenId}/tabs エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Screen Id (画面 ID)

Number (数値)

画面の ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Add Screen Tab Field

<jira:create-rest-api3-screens-tabs-fields-by-screen-id-tab-id>

画面タブに項目を追加します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/screens/{screenId}/tabs/{tabId}/fields エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Screen Id (画面 ID)

Number (数値)

画面の ID。

x

Tab Id (タブ ID)

Number (数値)

画面タブの ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Move Screen Tab Field

<jira:create-rest-api3-screens-tabs-fields-move-by-screen-id-tab-id-id>

画面タブ項目を移動します。要求で ​after​ および ​position​ が指定されている場合、​position​ は無視されます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/screens/{screenId}/tabs/{tabId}/fields/{id}/move エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Screen Id (画面 ID)

Number (数値)

画面の ID。

x

Tab Id (タブ ID)

Number (数値)

画面タブの ID。

x

id

String (文字列)

項目の ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Move Screen Tab

<jira:create-rest-api3-screens-tabs-move-by-screen-id-tab-id-pos>

画面タブを移動します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/screens/{screenId}/tabs/{tabId}/move/{pos} エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Screen Id (画面 ID)

Number (数値)

画面の ID。

x

Tab Id (タブ ID)

Number (数値)

画面タブの ID。

x

pos (位置)

Number (数値)

タブの位置。ベースインデックスは 0 です。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Create Screen Scheme

<jira:create-rest-api3-screenscheme>

画面スキームを作成します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/screenscheme エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Search For Issues Using Jql Post

<jira:create-rest-api3-search>

JQLLeaving the Site​ を使用して課題を検索します。このリソースの [GET](#api-rest-api-3-search-get) バージョンがあります。これは、より小さな JQL クエリ式に使用できます。この操作には匿名でアクセスできます。

必要な権限:

課題は、ユーザーが次の条件を満たす場合に応答に含まれます。

この操作では、/rest/api/3/search エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Cancel Task

<jira:create-rest-api3-task-cancel-by-task-id>

タスクをキャンセルします。

必要な権限:

次のいずれか。

この操作では、/rest/api/3/task/{taskId}/cancel エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Task Id (タスク ID)

String (文字列)

タスクの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Store Avatar

<jira:create-rest-api3-universal-avatar-type-owner-by-type-entity-id>

プロジェクトまたは課題種別のカスタムアバターを読み込みます。要求の本文でアバターのローカルファイルの場所を指定します。次のヘッダーも含めます。

  • X-Atlassian-Token: no-check​: XSRF 保護で要求がブロックされないようにします。詳細は、[「Special Headers (特殊なヘッダー)」](#special-request-headers)を参照してください。

  • Content-Type: image/image type​: 有効な画像の種類は、JPEG、GIF、または PNG です。

例

curl --request POST ​--user email@example.com: ​--header 'X-Atlassian-Token: no-check' ​--header 'Content-Type: image/< image_type>' ​--data-binary "<@/path/to/file/with/your/avatar>" ​--url 'https://your-domain.atlassian.net/rest/api/3/universal_avatar/type/{type}/owner/{entityId}'

アバターは正方形にトリミングされます。トリミングパラメーターが指定されていない場合、画像の左上から始まる正方形になります。正方形の辺の長さは、画像の高さまたは幅のいずれか小さい方に設定されます。トリミングされた画像は、16x16、24x24、32x32、48x48 のサイズのアバターを作成するために使用されます。

アバターの作成後、次の操作を使用します。

  • [Update issue type](#api-rest-api-3-issuetype-id-put) を使用して、それを課題種別の表示アバターとして設定します。

  • [Set project avatar](#api-rest-api-3-project-projectIdOrKey-avatar-put) を使用して、それをプロジェクトの表示アバターとして設定します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/universal_avatar/type/{type}/owner/{entityId} エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

type (型)

Enumeration (列挙)。次のいずれかになります。

  • PROJECT

  • ISSUETYPE

アバター種別。

x

Entity Id (エンティティ ID)

String (文字列)

アバターが関連付けられている項目の ID。

x

x

Number (数値)

トリミング領域の左上隅の X 座標。

0

y

Number (数値)

トリミング領域の左上隅の Y 座標。

0

size (サイズ)

Number (数値)

トリミング領域の各辺の長さ。

x

Body (本文)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Create User

<jira:create-rest-api3-user>

ユーザーを作成します。このリソースは、後方互換性のために保持されています。より適切な代替手段が使用可能になった直後に、このリソースは非推奨になるます。このオプションは、ユーザーのパスワードを設定または生成するために提供されています。

パスワードを生成するオプションを使用する場合は、要求から ​password​ を除外し、アカウントが作成されたことを通知するメールがユーザーに送信されるように ​"notification": "true"​ を含めます。このメールには、ユーザーがパスワードを設定するためのリンクが含まれます。生成されたパスワードの通知が送信されない場合、ユーザーは Jira からパスワードのリセット要求を送信する必要があります。ユーザーが存在し、Jira へのアクセス権がある場合、この操作で 201 の状況が返されます。ユーザーが存在し、Jira へのアクセス権がない場合、この操作で 400 の状況が返されます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/user エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Create Version

<jira:create-rest-api3-version>

プロジェクトバージョンを作成します。この操作には匿名でアクセスできます。

必要な権限:

バージョンを追加するプロジェクトに対する​「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​または​「Administer Projects (プロジェクトの管理)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/version エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Move Version

<jira:create-rest-api3-version-move-by-id>

プロジェクト内のバージョンのシーケンスを変更します。これは、Jira でのバージョンの表示順序に影響します。この操作には匿名でアクセスできます。

必要な権限:

バージョンを含むプロジェクトに対する​「Browse projects (プロジェクトの参照)」​プロジェクト権限。

この操作では、/rest/api/3/version/{id}/move エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

移動するバージョンの ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete And Replace Version

<jira:create-rest-api3-version-remove-and-swap-by-id>

プロジェクトバージョンを削除します。​fixVersion​、​affectedVersion​、またはバージョンピッカーカスタム項目で削除されたバージョンを使用している課題を更新するために、代替バージョンを指定できます。代替バージョンが指定されていない場合、削除されたバージョンを含む ​fixVersion​、​affectedVersion​、およびバージョンピッカーカスタム項目はクリアされます。置換バージョンは、削除されるバージョンと同じプロジェクトに含まれている必要があり、削除されるバージョンにすることはできません。この操作には匿名でアクセスできます。

必要な権限:

バージョンを含むプロジェクトに対する​「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​または​「Administer Projects (プロジェクトの管理)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/version/{id}/removeAndSwap エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

バージョンの ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Register Dynamic Webhooks

<jira:create-rest-api3-webhook>

Web フックを登録します。

必要な権限:

Connect アプリケーションLeaving the Site​のみがこの操作を使用できます。

この操作では、/rest/api/3/webhook エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Create Workflow Transition Property

<jira:create-rest-api3-workflow-transitions-properties-by-transition-id>

ワークフロー移行にプロパティを追加します。移行のプロパティは、移行の動作を変更するために使用されます。詳細は、 「Transition properties (移行のプロパティ)」Leaving the Site​と 「Workflow properties (ワークフローのプロパティ)」Leaving the Site​を参照してください。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/workflow/transitions/{transitionId}/properties エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Transition Id (移行 ID)

Number (数値)

移行の ID。ID を取得するには、Jira 管理者設定でワークフローをテキストモードで表示します。ID は移行の横に表示されます。

x

key (キー)

String (文字列)

追加されるプロパティのキー。プロパティの名前とも呼ばれます。これをリクエストボディで定義されている ​key​ と同じ値に設定します。

x

Workflow Name (ワークフロー名)

String (文字列)

移行が属するワークフローの名前。

x

Workflow Mode (ワークフローモード)

Enumeration (列挙)。次のいずれかになります。

  • LIVE

  • DRAFT (ドラフト)

ワークフロー状況。非アクティブなワークフローの場合は ​[live (ライブ)]​、ドラフトワークフローの場合は ​[draft (ドラフト)]​ に設定します。アクティブなワークフローは編集できません。

LIVE

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Create Workflow Scheme

<jira:create-rest-api3-workflowscheme>

ワークフロースキームを作成します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflowscheme エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Create Workflow Scheme Draft From Parent

<jira:create-rest-api3-workflowscheme-createdraft-by-id>

アクティブなワークフロースキームをコピーして、アクティブなワークフロースキームからドラフトワークフロースキームを作成します。アクティブなワークフロースキームは、1 つのドラフトワークフロースキームのみを持つことができます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflowscheme/{id}/createdraft エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

ドラフトの作成元であるアクティブなワークフロースキームの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Worklogs For Ids

<jira:create-rest-api3-worklog-list>

作業ログ ID のリストでの作業ログの詳細を返します。返される作業ログのリストは 1000 項目に制限されます。

必要な権限:

Jira へのアクセス権。ただし、次のいずれかに該当する場合にのみ作業ログが返されます。

  • 作業ログが ​[Viewable by All Users (すべてのユーザーが参照可能)]​ に設定されている。

  • ユーザーは、作業ログを表示する権限があるプロジェクトロールまたはグループのメンバーである。

この操作では、/rest/api/3/worklog/list エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

expand (展開)

String (文字列)

expand​ を使用して、作業ログに関する追加情報を応答に含めます。このパラメーターは、各作業ログのプロパティを返す ​properties​ を受け入れます。

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Dynamic Modules Resource register Modules post

<jira:create-rest-atlassian-connect1-app-module-dynamic>

モジュールのリストを登録します。

必要な権限:

この要求を実行できるのは Connect アプリケーションのみです。

この操作では、/rest/atlassian-connect/1/app/module/dynamic エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Remove Attachment

<jira:delete-rest-api3-attachment-by-id>

課題から添付ファイルを削除します。この操作には匿名でアクセスできます。

必要な権限:

添付ファイルを含む課題を保持するプロジェクトの場合:

  • コール元ユーザーによって作成された添付ファイルを削除する場合は​「Delete own attachments (独自の添付ファイルの削除)」 プロジェクト権限Leaving the Site​。

  • すべてのユーザーによって作成された添付ファイルを削除する場合は​「Delete all attachments (すべての添付ファイルの削除)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/attachment/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

添付ファイルの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Comment Property

<jira:delete-rest-api3-comment-properties-by-comment-id-property-key>

コメントプロパティを削除します。

必要な権限:

次のいずれか。

  • すべてのコメントからプロパティを削除する場合は​「Delete All Comments (すべてのコメントの編集)」 プロジェクト権限Leaving the Site​。

  • そのユーザーによって作成されたコメントからプロパティを削除する場合は​「Edit Own Comments (独自のコメントの編集)」 プロジェクト権限Leaving the Site​。

また、コメントの表示がロールまたはグループに制限されている場合、ユーザーはそのロールまたはグループのメンバーである必要があります。

この操作では、/rest/api/3/comment/{commentId}/properties/{propertyKey} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Comment Id (コメント ID)

String (文字列)

コメントの ID。

x

Property Key (プロパティキー)

String (文字列)

プロパティのキー。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Component

<jira:delete-rest-api3-component-by-id>

コンポーネントを削除します。この操作には匿名でアクセスできます。

必要な権限:

コンポーネントを含むプロジェクトに対する​「Administer projects (プロジェクトの管理)」 プロジェクト権限Leaving the Site​、または​「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/component/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

コンポーネントの ID。

x

Move Issues To (課題の移動先)

String (文字列)

削除されたコンポーネントを置き換えるコンポーネントの ID。この値が null の場合、置換は行われません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Dashboard

<jira:delete-rest-api3-dashboard-by-id>

ダッシュボードを削除します。

必要な権限:

なし 削除されるダッシュボードは、ユーザーが所有している必要があります。

この操作では、/rest/api/3/dashboard/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

ダッシュボードの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Dashboard Item Property

<jira:delete-rest-api3-dashboard-items-properties-by-dashboard-id-item-id-property-key>

ダッシュボード項目プロパティを削除します。この操作には匿名でアクセスできます。

必要な権限:

ユーザーがダッシュボードのオーナーである必要があります。​「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​を持つユーザーは、System ダッシュボードのオーナーとみなされます。

この操作では、/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Dashboard Id (ダッシュボード ID)

String (文字列)

ダッシュボードの ID。

x

Item Id (品目 ID)

String (文字列)

ダッシュボード項目の ID。

x

Property Key (プロパティキー)

String (文字列)

ダッシュボード項目プロパティのキー。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Custom Field Context

<jira:delete-rest-api3-field-context-by-field-id-context-id>

カスタム項目コンテキストLeaving the Site​を削除します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/field/{fieldId}/context/{contextId} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Id (項目 ID)

String (文字列)

カスタム項目の ID。

x

Context Id (コンテキスト ID)

Number (数値)

コンテキストの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Custom Field Option

<jira:delete-rest-api3-field-context-option-by-field-id-context-id-option-id>

カスタム項目オプションを削除します。カスケードオプションが含まれるオプションを削除するには、最初にカスケードオプションを削除する必要があります。この操作は、Jira で作成されたカスタム項目オプションまたはこのリソースからの操作で機能します。Connect アプリケーション用に作成された課題項目選択リストオプションを操作するには、[Issue custom field options (apps)](#api-group-issue-custom-field-options—​apps-) 操作を使用します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/field/{fieldId}/context/{contextId}/option/{optionId} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Id (項目 ID)

String (文字列)

カスタム項目の ID。

x

Context Id (コンテキスト ID)

Number (数値)

オプションを削除するコンテキストの ID。

x

Option Id (オプション ID)

Number (数値)

削除するオプションの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Issue Field Option

<jira:delete-rest-api3-field-option-by-field-key-option-id>

選択リスト課題項目からオプションを削除します。この操作は、​Connect アプリケーションで追加された課題項目選択リストオプションでのみ機能します​。Jira で作成されたか、[Issue custom field options](#api-group-Issue-custom-field-options) リソースからの操作を使用して作成された課題項目選択リストオプションでは使用できません。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。 項目を提供するアプリケーションでは、Jira 権限は必要ありません。

この操作では、/rest/api/3/field/{fieldKey}/option/{optionId} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Key (項目キー)

String (文字列)

項目キーは次の形式で指定されます: $(app-key)\​\​$(field-key)​。例: example-add-on\_\_example-issue-field​。​fieldKey​ 値を決定するには、次のいずれかを実行します。

  • アプリケーションのプラグイン記述子を開く。​app-key​ は上部にあるキーで、​field-key​ は ​jiraIssueFields​ モジュール内のキーです。 app-key​ は、Atlassian Universal Plugin Manager のアプリケーションリストにもあります。

  • [Get fields](#api-rest-api-3-field-get) を実行する。項目の詳細で、値が ​key​ 内で返されます。(例: "key": "teams-add-on_team-issue-field"​)。

x

Option Id (オプション ID)

Number (数値)

削除されるオプションの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Replace Issue Field Option

<jira:delete-rest-api3-field-option-issue-by-field-key-option-id>

選択されているすべての課題から課題項目選択リストオプションを選択解除します。選択解除されたオプションを置き換える別のオプションを選択できます。JQL クエリを使用することで、更新をより小さい課題のセットに制限することもできます。これは [非同期操作](#async) です。応答オブジェクトには、時間がかかるタスクへのリンクが含まれます。この操作は、​Connect アプリケーションで追加された課題項目選択リストオプションでのみ機能します​。Jira で作成されたか、[Issue custom field options](#api-group-Issue-custom-field-options) リソースからの操作を使用して作成された課題項目選択リストオプションでは使用できません。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。 項目を提供するアプリケーションでは、Jira 権限は必要ありません。

この操作では、/rest/api/3/field/{fieldKey}/option/{optionId}/issue エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Key (項目キー)

String (文字列)

項目キーは次の形式で指定されます: $(app-key)\​\​$(field-key)​。例: example-add-on\_\_example-issue-field​。

fieldKey​ 値を決定するには、次のいずれかを実行します。

  • アプリケーションのプラグイン記述子を開く。​app-key​ は上部にあるキーで、​field-key​ は ​jiraIssueFields​ モジュール内のキーです。 app-key​ は、Atlassian Universal Plugin Manager のアプリケーションリストにもあります。

  • [Get fields](#api-rest-api-3-field-get) を実行する。項目の詳細で、値が ​key​ 内で返されます。例: "key": "teams-add-on_team-issue-field"​。

x

Option Id (オプション ID)

Number (数値)

選択解除されるオプションの ID。

x

Replace With (置換対象)

Number (数値)

現在選択されているオプションを置き換えるオプションの ID。

jql (JQL)

String (文字列)

更新される課題を指定する JQL クエリ。例: project=10000​。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Filter

<jira:delete-rest-api3-filter-by-id>

検索条件を削除します。

必要な権限:

Jira へのアクセス権。ただし、検索条件を削除できるのは、検索条件の作成者、または​「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​を持つユーザーのみです。

この操作では、/rest/api/3/filter/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

削除する検索条件の ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Reset Columns

<jira:delete-rest-api3-filter-columns-by-id>

ユーザーの検索条件に対する列設定をデフォルトにリセットします。

必要な権限:

Jira へのアクセス権。ただし、次の列のみがリセットされます。

  • ユーザーが所有する検索条件。

  • ユーザーがメンバーであるグループと共有される検索条件。

  • ユーザーが​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​を持っている非公開プロジェクトと共有される検索条件。

  • 公開プロジェクトと共有される検索条件。

  • 一般に共有される検索条件。

この操作では、/rest/api/3/filter/{id}/columns エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

検索条件の ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Favourite For Filter

<jira:delete-rest-api3-filter-favourite-by-id>

ユーザーのお気に入りとしての検索条件を削除します。この操作では、ユーザーのお気に入りリストからユーザーに表示される検索条件のみが削除されます。たとえば、ユーザーが公開検索条件をお気に入りに追加し、その後それが非公開になった場合 (そのためお気に入りリストに表示されなくなった場合)、ユーザーはその検索条件をお気に入りリストから削除できません。

必要な権限:

Jira にアクセスするための権限。

この操作では、/rest/api/3/filter/{id}/favourite エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

検索条件の ID。

x

expand (展開)

String (文字列)

expand​ を使用して、検索条件に関する追加情報を応答に含めます。このパラメーターは、カンマ区切りのリストを受け入れます。expand (展開) には次のオプションがあります。

  • sharedUsers​: 検索条件が共有されているユーザーを返します。これには、検索条件が共有されているプロジェクトを参照できるユーザーが含まれます。​sharedUsers​ を指定しない場合、​sharedUsers​ オブジェクトは返されますが、ユーザーはリストされません。返されるユーザーのリストは 1000 個に制限され、追加ユーザーにアクセスするには、展開要求に ​[start-index:end-index]​ を追加します。たとえば、次の 1000 ユーザーにアクセスするには、​?expand=sharedUsers[1001:2000]​ を使用します。

  • subscriptions​: 検索条件にサブスクライブしているユーザーを返します。​subscriptions​ を指定しない場合、​subscriptions​ オブジェクトは返されますが、サブスクリプションはリストされません。返されるサブスクリプションのリストは 1000 個に制限され、追加サブスクリプションにアクセスするには、展開要求に ​[start-index:end-index]​ を追加します。たとえば、次の 1000 サブスクリプションにアクセスするには、​?expand=subscriptions[1001:2000]​ を使用します。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Share Permission

<jira:delete-rest-api3-filter-permission-by-id-permission-id>

検索条件から共有権限を削除します。

必要な権限:

Jira へのアクセス権。さらに、ユーザーが検索条件を所有する必要があります。

この操作では、/rest/api/3/filter/{id}/permission/{permissionId} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

検索条件の ID。

x

Permission Id (権限 ID)

Number (数値)

共有権限の ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Remove Group

<jira:delete-rest-api3-group>

グループを削除します。

必要な権限:

サイト管理 (​site-admin​ 戦略的 グループLeaving the Site​のメンバー)。

この操作では、/rest/api/3/group エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

groupname (グループ名)

String (文字列)

グループの名前。

x

Swap Group (スワップグループ)

String (文字列)

制限を転送するグループ。コメントおよび作業ログのみが転送されます。制限が転送されない場合、削除後にコメントと作業ログにアクセスできなくなります。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Remove User From Group

<jira:delete-rest-api3-group-user>

グループからユーザーを削除します。

必要な権限:

サイト管理 (​site-admin​ グループLeaving the Site​のメンバー)。

この操作では、/rest/api/3/group/user エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

groupname (グループ名)

String (文字列)

グループの名前。

x

username (ユーザー名)

String (文字列)

このパラメーターは使用できなくなり、まもなくドキュメントから削除されます。詳細は、[廃止通知](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/Leaving the Site) を参照してください。

Account Id (アカウント ID)

String (文字列)

ユーザーのアカウント ID。これは、すべての Atlassian 製品でユーザーを一意に識別します。例: 5b10ac8d82e05b22cc7d4ef5​。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Issue

<jira:delete-rest-api3-issue-by-issue-id-or-key>

課題を削除します。1 つ以上のサブタスクがある場合、課題は削除できません。サブタスクのある課題を削除するには、​deleteSubtasks​ を設定します。これにより、課題のサブタスクは課題と共に削除されます。この操作には匿名でアクセスできます。

必要な権限:

  • 課題を含むプロジェクトに対する​「Browse projects (プロジェクトの参照)」​および​「Edit issues (課題の編集)」 プロジェクト権限Leaving the Site​。

  • 課題レベルのセキュリティLeaving the Site​が設定されている場合、課題を表示する課題レベルのセキュリティ権限。

この操作では、/rest/api/3/issue/{issueIdOrKey} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

Delete Subtasks (サブタスクを削除)

Enumeration (列挙)。次のいずれかになります。

  • TRUE

  • FALSE

課題が削除されるときに課題のサブタスクが削除されるかどうか。

FALSE

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Comment

<jira:delete-rest-api3-issue-comment-by-issue-id-or-key-id>

コメントを削除します。

必要な権限:

  • コメントを含む課題があるプロジェクトに対する​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

  • 課題レベルのセキュリティLeaving the Site​が設定されている場合、課題を表示する課題レベルのセキュリティ権限。

  • すべてのコメントを削除する場合は​「Delete all comments (すべてのコメントの削除)」 プロジェクト権限Leaving the Site​、そのユーザーによって作成されたコメントを削除する場合は​「Delete own comments (独自のコメントの削除)」​プロジェクト権限。

  • コメントの表示制限がある場合、ユーザーがグループに属しているか、表示が制限されているロールがある。

この操作では、/rest/api/3/issue/{issueIdOrKey}/comment/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

id

String (文字列)

コメントの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Issue Link

<jira:delete-rest-api3-issue-link-by-link-id>

課題リンクを削除します。この操作には匿名でアクセスできます。

必要な権限:

この操作では、/rest/api/3/issueLink/{linkId} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Link Id (リンク ID)

String (文字列)

課題リンクの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Issue Link Type

<jira:delete-rest-api3-issue-link-type-by-issue-link-type-id>

課題リンク種別を削除します。この操作を使用するには、サイトで 課題のリンクLeaving the Site​が有効になっている必要があります。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/issueLinkType/{issueLinkTypeId} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Link Type Id

String (文字列)

課題リンク種別の ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Issue Property

<jira:delete-rest-api3-issue-properties-by-issue-id-or-key-property-key>

課題のプロパティを削除します。この操作には匿名でアクセスできます。

必要な権限:

この操作では、/rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題のキーまたは ID。

x

Property Key (プロパティキー)

String (文字列)

プロパティのキー。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Bulk Delete Issue Property

<jira:delete-rest-api3-issue-properties-by-property-key>

複数の課題からプロパティ値を削除します。更新される課題は、検索条件で指定できます。対象となる課題を識別するために使用される検索条件は次のとおりです。

  • entityIds​: このリストの課題のみが対象となります。

  • currentValue​: この値に設定されたプロパティを使用する課題のみが対象となります。両方の条件が指定されている場合、それらは論理 ​AND​ で結合されます。両方の条件を満たす課題のみが対象となります。検索条件が指定されていない場合、ユーザーに表示され、ユーザーがその課題に対する EDIT\_ISSUES 権限を持つすべての課題が対象となります。

この操作は次の特性があります。

  • トランザクション。プロパティが対象となるすべての課題から削除されるか、エラーが発生した場合、プロパティは削除されません。

  • [非同期](#async)。応答の ​location​ リンクに従ってタスクの状況を確認し、[Get task](#api-rest-api-3-task-taskId-get) を使用して後続の更新を取得します。

必要な権限:

この操作では、/rest/api/3/issue/properties/{propertyKey} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Property Key (プロパティキー)

String (文字列)

プロパティのキー。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Remote Issue Link By Global Id

<jira:delete-rest-api3-issue-remotelink-by-issue-id-or-key>

リンクのグローバル ID を使用して、課題からリモート課題リンクを削除します。グローバル ID に予約済み URL 文字が含まれる場合、要求でそれらをエスケープする必要があります。たとえば、​system=http://www.mycompany.com/support&id=1​ を ​system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1​ として渡します。

この操作には、 課題リンクがアクティブになっているLeaving the Site​必要があります。この操作には匿名でアクセスできます。

必要な権限:

  • 課題を含むプロジェクトに対する​「Browse projects (プロジェクトの参照)」​および​「Link issues (課題のリンク)」 プロジェクト権限Leaving the Site​。

  • 課題レベルのセキュリティLeaving the Site​が実装されている場合、課題を表示する課題レベルのセキュリティ権限。

この操作では、/rest/api/3/issue/{issueIdOrKey}/remotelink エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

Global Id (グローバル ID)

String (文字列)

リモート課題リンクのグローバル ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Remote Issue Link By Id

<jira:delete-rest-api3-issue-remotelink-by-issue-id-or-key-link-id>

課題のリモート課題リンクを削除します。この操作には、 課題リンクがアクティブになっているLeaving the Site​必要があります。この操作には匿名でアクセスできます。

必要な権限:

  • 課題を含むプロジェクトに対する​「Browse projects (プロジェクトの参照)」​、​「Edit issues (課題の編集)」​、および​「Link issues (課題のリンク)」 プロジェクト権限Leaving the Site​。

  • 課題レベルのセキュリティLeaving the Site​が設定されている場合、課題を表示する課題レベルのセキュリティ権限。

この操作では、/rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

Link Id (リンク ID)

String (文字列)

リモート課題リンクの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Remove Vote

<jira:delete-rest-api3-issue-votes-by-issue-id-or-key>

課題からユーザーの投票を削除します。これは、ユーザーが Jira で課題に対する ​[Unvote (投票取り消し)]​ をクリックするのと同じです。この操作には、​[Allow users to vote on issues (課題に対する投票をユーザーに許可)]​ オプションが ​[ON]​ になっている必要があります。このオプションは、Jira の [General (一般)] 設定で定義されます。詳細は、 「Configuring Jira application options (Jira アプリケーションオプションの設定)」Leaving the Site​を参照してください。

必要な権限:

この操作では、/rest/api/3/issue/{issueIdOrKey}/votes エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Remove Watcher

<jira:delete-rest-api3-issue-watchers-by-issue-id-or-key>

課題のウォッチャーとしてのユーザーを削除します。この操作には、​[Allow users to watch issues (課題の監視をユーザーに許可)]​ オプションが ​[ON]​ になっている必要があります。このオプションは、Jira の [General (一般)] 設定で定義されます。詳細は、 「Configuring Jira application options (Jira アプリケーションオプションの設定)」Leaving the Site​を参照してください。

必要な権限:

  • 課題を含むプロジェクトに対する​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

  • 課題レベルのセキュリティLeaving the Site​が設定されている場合、課題を表示する課題レベルのセキュリティ権限。

  • 自分以外のユーザーをウォッチリストから削除するには、課題を含むプロジェクトに対する​「Manage watcher list (ウォッチャーリストの管理)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/issue/{issueIdOrKey}/watchers エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

username (ユーザー名)

String (文字列)

このパラメーターは使用できなくなり、まもなくドキュメントから削除されます。詳細は、[廃止通知](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/Leaving the Site) を参照してください。

Account Id (アカウント ID)

String (文字列)

ユーザーのアカウント ID。これは、すべての Atlassian 製品でユーザーを一意に識別します。例: 5b10ac8d82e05b22cc7d4ef5​。必須。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Worklog

<jira:delete-rest-api3-issue-worklog-by-issue-id-or-key-id>

課題から作業ログを削除します。Jira でタイムトラッキングを有効にする必要があります。有効にしないと、この操作でエラーが返されます。詳細は、 「Configuring time tracking (タイムトラッキングの設定)」Leaving the Site​を参照してください。この操作には匿名でアクセスできます。

必要な権限:

  • 課題を含むプロジェクトに対する​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

  • 課題レベルのセキュリティLeaving the Site​が設定されている場合、課題を表示する課題レベルのセキュリティ権限。

  • すべての作業ログを削除する場合は​「Delete all worklogs (すべての作業ログの削除)」 プロジェクト権限Leaving the Site​、そのユーザーによって作成された作業ログを削除する場合は​「Delete own worklogs (独自の作業ログの削除)」​プロジェクト権限。

  • 作業ログの表示制限がある場合、グループに属しているか、表示が制限されているロールがある。

この操作では、/rest/api/3/issue/{issueIdOrKey}/worklog/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

id

String (文字列)

作業ログの ID。

x

Notify Users (ユーザーに通知)

Boolean (ブール)

課題を監視しているユーザーにメールで通知するかどうか。

true

Adjust Estimate (見積を調整)

Enumeration (列挙)。次のいずれかになります。

  • NEW

  • LEAVE

  • MANUAL

  • AUTO

課題の時間の見積を更新する方法を定義します。オプションは次のとおりです。* ​new​: newEstimate​ で定義された特定の値に見積を設定します。 *​leave​: 見積は変更されません。 *​manual​: increaseBy​ で指定された量だけ見積を増やします。 *​auto​: 作業ログの ​timeSpent​ の値だけ見積を減らします。

AUTO

New Estimate (新規見積)

String (文字列)

課題の残り時間の見積として設定する値 (日 (#d)、時間 (\#h)、または分 (\#m or \#))。たとえば、​2d​ と指定します。​adjustEstimate​ が ​new​ の場合は必須です。

Increase By (増分量)

String (文字列)

課題の残りの見積を増やす量 (日 (#d)、時間 (\#h)、または分 (\#m または \#))。たとえば、​2d​ と指定します。​adjustEstimate​ が ​manual​ の場合は必須です。

Override Editable Flag (編集可能なフラグを上書き)

Boolean (ブール)

jira.issue.editable​ が ​false​ に設定されているか欠落しているため、課題が編集可能でない場合でも、作業ログエントリを課題に追加するかどうか。このフラグを使用できるのは、管理権限を持つ Connect アプリケーションユーザーのみです。

false

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Worklog Property

<jira:delete-rest-api3-issue-worklog-properties-by-issue-id-or-key-worklog-id-property-key>

作業ログプロパティを削除します。この操作には匿名でアクセスできます。

必要な権限:

  • 課題を含むプロジェクトに対する​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

  • 課題レベルのセキュリティLeaving the Site​が設定されている場合、課題を表示する課題レベルのセキュリティ権限。

  • 作業ログの表示制限がある場合、グループに属しているか、表示が制限されているロールがある。

この操作では、/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

Worklog Id (作業ログ ID)

String (文字列)

作業ログの ID。

x

Property Key (プロパティキー)

String (文字列)

プロパティのキー。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Issue Type

<jira:delete-rest-api3-issuetype-by-id>

課題種別を削除します。課題種別が使用中の場合、すべての使用は代替課題種別 (​alternativeIssueTypeId​) で更新されます。代替課題種別のリストは、[Get alternative issue types](#api-rest-api-3-issuetype-id-alternatives-get) リソースから取得されます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/issuetype/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

課題種別の ID。

x

Alternative Issue Type Id (代替課題種別 ID)

String (文字列)

代替課題種別の ID。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Issue Type Property

<jira:delete-rest-api3-issuetype-properties-by-issue-type-id-property-key>

課題種別プロパティLeaving the Site​を削除します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Type Id (課題種別 ID)

String (文字列)

課題種別の ID。

x

Property Key (プロパティキー)

String (文字列)

プロパティのキー。[Get issue type property keys](#api-rest-api-3-issuetype-issueTypeId-properties-get) を使用して、すべての課題種別プロパティキーのリストを取得します。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Issue Type Scheme

<jira:delete-rest-api3-issuetypescheme-by-issue-type-scheme-id>

課題種別スキームを削除します。削除できるのは、従来のプロジェクトで使用されている課題種別スキームのみです。スキームに割り当てられたすべてのプロジェクトは、デフォルトの課題種別スキームに再割り当てされます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/issuetypescheme/{issueTypeSchemeId} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Type Scheme Id (課題種別スキーム ID)

Number (数値)

課題種別スキームの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Remove Issue Type From Issue Type Scheme

<jira:delete-rest-api3-issuetypescheme-issuetype-by-issue-type-scheme-id-issue-type-id>

課題種別スキームから課題種別を削除します。この操作では、次の種別は削除できません。

  • 課題によって使用されている課題種別。

  • デフォルトの課題種別スキームの課題種別。

  • 課題種別スキームの最後の標準課題種別。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetype/{issueTypeId} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Type Scheme Id (課題種別スキーム ID)

Number (数値)

課題種別スキームの ID。

x

Issue Type Id (課題種別 ID)

Number (数値)

課題種別の ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Issue Type Screen Scheme

<jira:delete-rest-api3-issuetypescreenscheme-by-issue-type-screen-scheme-id>

課題種別画面スキームを削除します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Type Screen Scheme Id (課題種別画面スキーム ID)

String (文字列)

課題種別画面スキームの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Remove Preference

<jira:delete-rest-api3-mypreferences>

ユーザーの設定を削除します。これにより、システム定義設定のデフォルト値が復元されます。

次のキーは非推奨です。

  • jira.user.locale​ ユーザーのロケール。デフォルトでは、設定されていません。ユーザーにはインスタンスのロケールが設定されます。

  • jira.user.timezone​ ユーザーのタイムゾーン。デフォルトでは、設定されていません。ユーザーにはインスタンスのタイムゾーンが設定されます。代わりにタイムゾーンとロケールを管理するには、ユーザー管理 REST API の Update a user profileLeaving the Site​ を使用します。

必要な権限:

Jira にアクセスするための権限。

この操作では、/rest/api/3/mypreferences エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

key (キー)

String (文字列)

設定のキー。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Permission Scheme

<jira:delete-rest-api3-permissionscheme-by-scheme-id>

権限スキームを削除します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/permissionscheme/{schemeId} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Scheme Id (スキーム ID)

Number (数値)

削除される権限スキームの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Permission Scheme Entity

<jira:delete-rest-api3-permissionscheme-permission-by-scheme-id-permission-id>

権限スキームから権限付与を削除します。詳細は、[「権限スキームと付与について」](#about-permission-schemes) を参照してください。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/permissionscheme/{schemeId}/permission/{permissionId} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Scheme Id (スキーム ID)

Number (数値)

権限付与を削除する権限スキームの ID。

x

Permission Id (権限 ID)

Number (数値)

削除する権限付与の ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Project Avatar

<jira:delete-rest-api3-project-avatar-by-project-id-or-key-id>

プロジェクトからカスタムアバターを削除します。システムアバターは削除できません。

必要な権限:

「Administer projects (プロジェクトの管理)」 プロジェクト権限Leaving the Site

この操作では、/rest/api/3/project/{projectIdOrKey}/avatar/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Id Or Key (プロジェクト ID またはキー)

String (文字列)

プロジェクト ID または (大文字と小文字を区別する) キー。

x

id

Number (数値)

アバターの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Project

<jira:delete-rest-api3-project-by-project-id-or-key>

プロジェクトを削除します。

必要な権限:​ ​「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/project/{projectIdOrKey} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Id Or Key (プロジェクト ID またはキー)

String (文字列)

プロジェクト ID またはプロジェクトキー (大文字と小文字を区別)。

x

Enable Undo (元に戻す操作を有効化)

Boolean (ブール)

このプロジェクトが復元可能な Jira のごみ箱に入れられるかどうか。

false

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Remove Project Category

<jira:delete-rest-api3-project-category-by-id>

プロジェクトカテゴリを削除します。

必要な権限:​ ​「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/projectCategory/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

削除するプロジェクトカテゴリの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Project Property

<jira:delete-rest-api3-project-properties-by-project-id-or-key-property-key>

プロジェクトから プロパティLeaving the Site​を削除します。この操作には匿名でアクセスできます。

必要な権限:

プロパティを含むプロジェクトに対する​「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​または​「Administer Projects (プロジェクトの管理)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/project/{projectIdOrKey}/properties/{propertyKey} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Id Or Key (プロジェクト ID またはキー)

String (文字列)

プロジェクト ID またはプロジェクトキー (大文字と小文字を区別)。

x

Property Key (プロパティキー)

String (文字列)

プロジェクトプロパティキー。[Get project property keys](#api-rest-api-3-project-projectIdOrKey-properties-get) を使用して、すべてのプロジェクトプロパティキーのリストを取得します。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Actor

<jira:delete-rest-api3-project-role-by-project-id-or-key-id>

プロジェクトのプロジェクトロールからアクターを削除します。プロジェクトロールからデフォルトのアクターを削除するには、[Delete default actors from project role](#api-rest-api-3-role-id-actors-delete) を使用します。この操作には匿名でアクセスできます。

必要な権限:

プロジェクトに対する​「Administer Projects (プロジェクトの管理)」 プロジェクト権限Leaving the Site​、または​「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/project/{projectIdOrKey}/role/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Id Or Key (プロジェクト ID またはキー)

String (文字列)

プロジェクト ID またはプロジェクトキー (大文字と小文字を区別)。

x

id

Number (数値)

プロジェクトロールの ID。[Get all project roles](#api-rest-api-3-role-get) を使用して、プロジェクトロール ID のリストを取得します。

x

user (ユーザー)

String (文字列)

プロジェクトロールから削除するユーザーのユーザーアカウント ID。

グループ

String (文字列)

プロジェクトロールから削除するグループの名前。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Project Role Actors From Role

<jira:delete-rest-api3-role-actors-by-id>

プロジェクトロールから [デフォルトアクター](#api-rest-api-3-resolution-get) を削除します。グループまたはユーザーを削除できますが、同じ要求内のグループとユーザーを削除することはできません。プロジェクトロールのデフォルトアクターを変更しても、すでに作成されているプロジェクトのプロジェクトロールメンバーには影響しません。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/role/{id}/actors エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

プロジェクトロールの ID。[Get all project roles](#api-rest-api-3-role-get) を使用して、プロジェクトロール ID のリストを取得します。

x

user (ユーザー)

String (文字列)

デフォルトアクターとして削除するユーザーのユーザーアカウント ID。

グループ

String (文字列)

デフォルトアクターとして削除されるグループのグループ名。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Project Role

<jira:delete-rest-api3-role-by-id>

プロジェクトロールを削除します。使用中のプロジェクトロールを削除する場合、置換プロジェクトロールを指定する必要があります。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/role/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

削除するプロジェクトロールの ID。[Get all project roles](#api-rest-api-3-role-get) を使用して、プロジェクトロール ID のリストを取得します。

x

swap (スワップ)

Number (数値)

削除されるプロジェクトロールを置き換えるプロジェクトロールの ID。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Screen

<jira:delete-rest-api3-screens-by-screen-id>

画面を削除します。画面スキーム、ワークフロー、またはワークフロードラフトで使用されている画面は削除できません。削除できるのは、従来のプロジェクトで使用されている画面のみです。

この操作では、/rest/api/3/screens/{screenId} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Screen Id (画面 ID)

Number (数値)

画面の ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Screen Tab

<jira:delete-rest-api3-screens-tabs-by-screen-id-tab-id>

画面タブを削除します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/screens/{screenId}/tabs/{tabId} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Screen Id (画面 ID)

Number (数値)

画面の ID。

x

Tab Id (タブ ID)

Number (数値)

画面タブの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Remove Screen Tab Field

<jira:delete-rest-api3-screens-tabs-fields-by-screen-id-tab-id-id>

画面タブから項目を削除します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/screens/{screenId}/tabs/{tabId}/fields/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Screen Id (画面 ID)

Number (数値)

画面の ID。

x

Tab Id (タブ ID)

Number (数値)

画面タブの ID。

x

id

String (文字列)

項目の ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Screen Scheme

<jira:delete-rest-api3-screenscheme-by-screen-scheme-id>

画面スキームを削除します。課題種別の画面スキームで使用されている画面スキームは削除できません。削除できるのは、従来のプロジェクトで使用されているスキームのみです。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/screenscheme/{screenSchemeId} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Screen Scheme Id (画面スキーム ID)

String (文字列)

画面スキームの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Avatar

<jira:delete-rest-api3-universal-avatar-type-owner-avatar-by-type-owning-object-id-id>

プロジェクトまたは課題種別からアバターを削除します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/universal_avatar/type/{type}/owner/{owningObjectId}/avatar/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

type (型)

Enumeration (列挙)。次のいずれかになります。

  • PROJECT

  • ISSUETYPE

アバター種別。

x

Owning Object Id (所有するオブジェクト ID)

String (文字列)

アバターが関連付けられている項目の ID。

x

id

Number (数値)

アバターの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Remove User

<jira:delete-rest-api3-user>

ユーザーを削除します。

必要な権限:

サイト管理 (​site-admin​ グループLeaving the Site​のメンバーシップ)。

この操作では、/rest/api/3/user エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Account Id (アカウント ID)

String (文字列)

ユーザーのアカウント ID。これは、すべての Atlassian 製品でユーザーを一意に識別します。例: 5b10ac8d82e05b22cc7d4ef5​。

x

username (ユーザー名)

String (文字列)

このパラメーターは使用できなくなり、まもなくドキュメントから削除されます。詳細は、 廃止通知Leaving the Site​を参照してください。

key (キー)

String (文字列)

このパラメーターは使用できなくなり、まもなくドキュメントから削除されます。詳細は、 廃止通知Leaving the Site​を参照してください。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Reset User Columns

<jira:delete-rest-api3-user-columns>

ユーザーのデフォルトの 課題テーブル列Leaving the Site​をシステムのデフォルトにリセットします。​accountId​ が指定されていない場合、コール元ユーザーのデフォルト列がリセットされます。

必要な権限:

  • 他のユーザーの権限を確認する場合は​「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

  • コール元ユーザーの列を設定する場合は Jira へのアクセス権。

この操作では、/rest/api/3/user/columns エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Account Id (アカウント ID)

String (文字列)

ユーザーのアカウント ID。これは、すべての Atlassian 製品でユーザーを一意に識別します。例: 5b10ac8d82e05b22cc7d4ef5​。

username (ユーザー名)

String (文字列)

このパラメーターは使用できなくなり、まもなくドキュメントから削除されます。詳細は、 廃止通知Leaving the Site​を参照してください。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete User Property

<jira:delete-rest-api3-user-properties-by-property-key>

ユーザーからプロパティを削除します。注意: この操作は、Jira で作成および管理されている ユーザープロパティLeaving the Site​にはアクセスしません。

必要な権限:

  • すべてのユーザーからプロパティを削除する場合は​「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

  • コール元ユーザーのレコードからプロパティを削除する場合は Jira へのアクセス権。

この操作では、/rest/api/3/user/properties/{propertyKey} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Property Key (プロパティキー)

String (文字列)

ユーザーのプロパティのキー。

x

Account Id (アカウント ID)

String (文字列)

ユーザーのアカウント ID。これは、すべての Atlassian 製品でユーザーを一意に識別します。例: 5b10ac8d82e05b22cc7d4ef5​。

User Key (ユーザーキー)

String (文字列)

このパラメーターは使用できなくなり、まもなくドキュメントから削除されます。詳細は、 廃止通知Leaving the Site​を参照してください。

username (ユーザー名)

String (文字列)

このパラメーターは使用できなくなり、まもなくドキュメントから削除されます。詳細は、 廃止通知Leaving the Site​を参照してください。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Webhook By Id

<jira:delete-rest-api3-webhook>

ID で Web フックを削除します。コール元 Connect アプリケーションによって登録されている Web フックのみが削除されます。他のアプリケーションによって作成された Web フックが指定されている場合、それらは無視されます。

必要な権限:

Connect アプリケーションLeaving the Site​のみがこの操作を使用できます。

この操作では、/rest/api/3/webhook エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Workflow Transition Property

<jira:delete-rest-api3-workflow-transitions-properties-by-transition-id>

ワークフロー移行からプロパティを削除します。移行のプロパティは、移行の動作を変更するために使用されます。詳細は、 「Transition properties (移行のプロパティ)」Leaving the Site​と 「Workflow properties (ワークフローのプロパティ)」Leaving the Site​を参照してください。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflow/transitions/{transitionId}/properties エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Transition Id (移行 ID)

Number (数値)

移行の ID。ID を取得するには、Jira 管理者設定でワークフローをテキストモードで表示します。ID は移行の横に表示されます。

x

key (キー)

String (文字列)

削除する移行プロパティの名前。プロパティの名前とも呼ばれます。

x

Workflow Name (ワークフロー名)

String (文字列)

移行が属するワークフローの名前。

x

Workflow Mode (ワークフローモード)

Enumeration (列挙)。次のいずれかになります。

  • LIVE

  • DRAFT (ドラフト)

ワークフロー状況。非アクティブなワークフローの場合は ​live​、ドラフトワークフローの場合は ​draft​ に設定します。アクティブなワークフローは編集できません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Workflow Scheme

<jira:delete-rest-api3-workflowscheme-by-id>

ワークフロースキームを削除します。ワークフロースキームがアクティブな場合 (少なくとも 1 つのプロジェクトで使用されている場合)、そのスキームは削除できません。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflowscheme/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

ワークフロースキームの ID。この ID を見つけるには、Jira で目的のワークフロースキームを編集します。ID は URL に ​schemeId​ として表示されます。例: schemeId=10301​。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Default Workflow

<jira:delete-rest-api3-workflowscheme-default-by-id>

ワークフロースキームのデフォルトワークフローをリセットします。つまり、デフォルトのワークフローは Jira のシステムワークフロー (​jira​ ワークフロー) に設定されます。アクティブなワークフロースキームは編集できません。ワークフロースキームがアクティブな場合、​updateDraftIfNeeded​ を ​true​ に設定すると、ドラフトワークフロースキームが作成または更新され、デフォルトのワークフローがリセットされます。ドラフトワークフロースキームは Jira でパブリッシュできます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflowscheme/{id}/default エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

ワークフロースキームの ID。

x

Update Draft If Needed (必要に応じてドラフトを更新)

Boolean (ブール)

ワークフロースキームを編集できない場合に、ワークフロースキームのドラフトを作成または更新し、ドラフトからマッピングを削除する場合、true に設定します。デフォルトは ​false​ です。

false

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Workflow Scheme Draft

<jira:delete-rest-api3-workflowscheme-draft-by-id>

ドラフトワークフロースキームを削除します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflowscheme/{id}/draft エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

ドラフトの作成元であるアクティブなワークフロースキームの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Draft Default Workflow

<jira:delete-rest-api3-workflowscheme-draft-default-by-id>

ワークフロースキームのドラフトのデフォルトワークフローをリセットします。つまり、デフォルトのワークフローは Jira のシステムワークフロー (​jira​ ワークフロー) に設定されます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflowscheme/{id}/draft/default エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

ドラフトが属するワークフロースキームの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Workflow Scheme Draft Issue Type

<jira:delete-rest-api3-workflowscheme-draft-issuetype-by-id-issue-type>

ワークフロースキームのドラフトでの課題種別の課題種別とワークフローのマッピングを削除します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflowscheme/{id}/draft/issuetype/{issueType} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

ドラフトが属するワークフロースキームの ID。

x

Issue Type (課題種別)

String (文字列)

課題種別の ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Draft Workflow Mapping

<jira:delete-rest-api3-workflowscheme-draft-workflow-by-id>

ワークフロースキームのドラフトでのワークフローのワークフローと課題種別のマッピングを削除します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflowscheme/{id}/draft/workflow エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

ドラフトが属するワークフロースキームの ID。

x

Workflow Name (ワークフロー名)

String (文字列)

ワークフローの名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Workflow Scheme Issue Type

<jira:delete-rest-api3-workflowscheme-issuetype-by-id-issue-type>

ワークフロースキームでの課題種別の課題種別とワークフローのマッピングを削除します。アクティブなワークフロースキームは編集できません。ワークフロースキームがアクティブな場合、​updateDraftIfNeeded​ を ​true​ に設定すると、ドラフトワークフロースキームが作成または更新され、課題種別とワークフローのマッピングが削除されます。ドラフトワークフロースキームは Jira でパブリッシュできます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflowscheme/{id}/issuetype/{issueType} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

ワークフロースキームの ID。

x

Issue Type (課題種別)

String (文字列)

課題種別の ID。

x

Update Draft If Needed (必要に応じてドラフトを更新)

Boolean (ブール)

ワークフロースキームを編集できない場合に、ワークフロースキームのドラフトを作成または更新し、ドラフトのマッピングを更新する場合、true に設定します。デフォルトは ​false​ です。

false

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Delete Workflow Mapping

<jira:delete-rest-api3-workflowscheme-workflow-by-id>

ワークフロースキームでのワークフローのワークフローと課題種別のマッピングを削除します。アクティブなワークフロースキームは編集できません。ワークフロースキームがアクティブな場合、​updateDraftIfNeeded​ を ​true​ に設定すると、ドラフトワークフロースキームが作成または更新され、ワークフローと課題種別のマッピングが削除されます。ドラフトワークフロースキームは Jira でパブリッシュできます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflowscheme/{id}/workflow エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

ワークフロースキームの ID。

x

Workflow Name (ワークフロー名)

String (文字列)

ワークフローの名前。

x

Update Draft If Needed (必要に応じてドラフトを更新)

Boolean (ブール)

ワークフロースキームを編集できない場合に、ワークフロースキームのドラフトを作成または更新し、ドラフトからマッピングを削除する場合、true に設定します。デフォルトは ​false​ です。

false

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Addon Properties Resource delete Addon Property delete

<jira:delete-rest-atlassian-connect1-addons-properties-by-addon-key-property-key>

アプリケーションのプロパティを削除します。

必要な権限:

この要求を実行できるのは、キーが ​addonKey​ に一致する Connect アプリケーションのみです。

この操作では、/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Addon Key (アドオンキー)

String (文字列)

記述子で定義されるアプリケーションのキー。

x

Property Key (プロパティキー)

String (文字列)

プロパティのキー。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Dynamic Modules Resource remove Modules delete

<jira:delete-rest-atlassian-connect1-app-module-dynamic>

コール元のアプリケーションによって登録されたモジュールのすべてまたはリストを削除します。

必要な権限:

この要求を実行できるのは Connect アプリケーションのみです。

この操作では、/rest/atlassian-connect/1/app/module/dynamic エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Module Key (モジュールキー)

Array of String (文字列の配列)

削除するモジュールのキー。複数のモジュールキーを含めるには、このパラメーターの複数のコピーを指定します。例: moduleKey=dynamic-attachment-entity-property&moduleKey=dynamic-select-field​。存在しないキーは無視されます。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Application Property

<jira:get-rest-api3-application-properties>

すべてのアプリケーションプロパティまたは特定のアプリケーションプロパティを返します。​key​ パラメーターの値を指定した場合、アプリケーションプロパティは (配列ではなく) オブジェクトとして返されます。それ以外の場合、編集可能なすべてのアプリケーションプロパティの配列が返されます。編集可能なプロパティの説明については、[「Set application property」](#api-rest-api-3-application-properties-id-put) を参照してください。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/application-properties エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

key (キー)

String (文字列)

アプリケーションプロパティのキー。

Permission Level (権限レベル)

String (文字列)

リストで返されるすべての項目の権限レベル。

Key Filter (キー検索条件)

String (文字列)

key​ が指定されていない場合、正規表現を使用するアプリケーションプロパティ ​key​ によって、結果のリストが絞り込まれます。たとえば、​jira.lf.​ を使用すると、キーが *jira.lf. で始まるすべてのアプリケーションプロパティが返されます。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Advanced Settings

<jira:get-rest-api3-application-properties-advanced-settings>

[Advanced Settings (詳細設定)]​ ページでアクセスできるアプリケーションプロパティを返します。Jira で ​[Advanced Settings (詳細設定)]​ ページに移動するには、Jira アイコン > ​[Jira settings (Jira 設定)]​ > ​[System (システム)]​、​[General Configuration (全般設定)]​ を選択し、​[Advanced Settings (詳細設定)]​ (右上) をクリックします。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/application-properties/advanced-settings エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get All Application Roles

<jira:get-rest-api3-applicationrole>

すべてのアプリケーションロールを返します。Jira では、アプリケーションロールは [Application access configuration (アプリケーションアクセス設定)Leaving the Site]​ ページを使用して管理されます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/applicationrole エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Application Role

<jira:get-rest-api3-applicationrole-by-key>

アプリケーションロールを返します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/applicationrole/{key} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

key (キー)

String (文字列)

アプリケーションロールのキー。[Get all application roles](#api-rest-api-3-applicationrole-get) を使用して、各アプリケーションロールのキーを取得します。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Attachment

<jira:get-rest-api3-attachment-by-id>

添付ファイルのメタデータを返します。添付ファイル自体は返されません。この操作には匿名でアクセスできます。

必要な権限:

この操作では、/rest/api/3/attachment/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

添付ファイルの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Expand Attachment For Humans

<jira:get-rest-api3-attachment-expand-human-by-id>

添付ファイルのコンテンツのメタデータ (その添付ファイルがアーカイブの場合)、および添付ファイル自体のメタデータを返します。たとえば、添付ファイルが ZIP アーカイブの場合、アーカイブ内のファイルに関する情報と ZIP アーカイブのメタデータが返されます。

現在、ZIP アーカイブ形式のみがサポートされています。この操作は添付ファイル自体のメタデータ (添付ファイルの ID や名前など) を返すため、ユーザーに表示されるデータを取得する場合にこの操作を使用します。それ以外の場合、[Get contents metadata for an expanded attachment](#api-rest-api-3-attachment-id-expand-raw-get) を使用します。この操作は、添付ファイルのコンテンツのメタデータのみを返します。

この操作には匿名でアクセスできます。

必要な権限:

添付ファイルを含む課題の場合:

この操作では、/rest/api/3/attachment/{id}/expand/human エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

添付ファイルの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Expand Attachment For Machines

<jira:get-rest-api3-attachment-expand-raw-by-id>

添付ファイルのコンテンツのメタデータを返します (その添付ファイルがアーカイブの場合)。たとえば、添付ファイルが ZIP アーカイブの場合、アーカイブ内のファイルに関する情報が返されます。現在、ZIP アーカイブ形式のみがサポートされています。この操作は添付ファイルのコンテンツのメタデータのみを返すため、ユーザーに表示することなくデータを処理する場合にこの操作を使用します。それ以外の場合、ユーザーに表示するデータを取得するために [Get all metadata for an expanded attachment](#api-rest-api-3-attachment-id-expand-human-get) を使用します。この操作は、添付ファイル自体のメタデータ (添付ファイルの ID や名前など) も返します。この操作には匿名でアクセスできます。

必要な権限:

添付ファイルを含む課題の場合:

この操作では、/rest/api/3/attachment/{id}/expand/raw エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

添付ファイルの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Attachment Meta

<jira:get-rest-api3-attachment-meta>

添付ファイルの設定 (添付ファイルが有効かどうか、および許可される最大添付ファイルサイズ) を返します。ユーザーが添付ファイルを作成および削除できるかどうかを制限する プロジェクト権限Leaving the Site​もあります。この操作には匿名でアクセスできます。

必要な権限:

なし。

この操作では、/rest/api/3/attachment/meta エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Audit Records

<jira:get-rest-api3-auditing-record>

監査レコードのリストを返します。リストを絞り込んで、次の項目を含めることができます。

  • 少なくとも 1 つの項目に文字列が含まれる項目。たとえば、​「up」​と指定すると、1 つ以上の項目に​「update」​などの単語が含まれるすべての監査レコードが返されます。

  • 特定の日時以降に作成された項目。

  • 特定の日時以前に作成された項目。

  • 特定の期間中に作成された項目。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/auditing/record エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

offset

Number (数値)

最初の結果を返す前にスキップするレコードの数。

0

limit (制限)

Number (数値)

返す結果の最大数。

1000

filter (検索条件)

String (文字列)

クエリ文字列。

送信元。

String (文字列)

この日時以降に作成された監査レコードが返されます。​to​ が指定されている場合、​from​ は ​to​ より前にする必要があります。そうしないと、監査レコードは返されません。

to

String (文字列)

この日時以前に作成された監査レコードが返されます。​from​ が指定されている場合、​to​ は ​from​ より後にする必要があります。そうしないと、監査レコードは返されません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get All System Avatars

<jira:get-rest-api3-avatar-system-by-type>

オーナー種別ごとにシステムアバターの詳細のリストを返します。オーナー種別は、課題種別、プロジェクト、ユーザーのいずれかです。この操作には匿名でアクセスできます。

必要な権限:

なし。

この操作では、/rest/api/3/avatar/{type}/system エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

type (型)

Enumeration (列挙)。次のいずれかになります。

  • ISSUETYPE

  • PROJECT

  • USER

アバター種別。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Comment Property Keys

<jira:get-rest-api3-comment-properties-by-comment-id>

コメントのすべてのプロパティのキーを返します。この操作には匿名でアクセスできます。

必要な権限:

  • プロジェクトに対する​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

  • 課題レベルのセキュリティLeaving the Site​が設定されている場合、課題を表示する課題レベルのセキュリティ権限。

  • コメントの表示制限がある場合、グループに属しているか、表示が制限されているロールがある。

この操作では、/rest/api/3/comment/{commentId}/properties エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Comment Id (コメント ID)

String (文字列)

コメントの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Comment Property

<jira:get-rest-api3-comment-properties-by-comment-id-property-key>

コメントプロパティの値を返します。この操作には匿名でアクセスできます。

必要な権限:

  • プロジェクトに対する​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

  • 課題レベルのセキュリティLeaving the Site​が設定されている場合、課題を表示する課題レベルのセキュリティ権限。

  • コメントの表示制限がある場合、グループに属しているか、表示が制限されているロールがある。

この操作では、/rest/api/3/comment/{commentId}/properties/{propertyKey} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Comment Id (コメント ID)

String (文字列)

コメントの ID。

x

Property Key (プロパティキー)

String (文字列)

プロパティのキー。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Component

<jira:get-rest-api3-component-by-id>

コンポーネントを返します。この操作には匿名でアクセスできます。

必要な権限:

コンポーネントを含むプロジェクトに対する​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/component/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

コンポーネントの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Component Related Issues

<jira:get-rest-api3-component-related-issue-counts-by-id>

コンポーネントに割り当てられた課題の数を返します。この操作には匿名でアクセスできます。

必要な権限:

なし。

この操作では、/rest/api/3/component/{id}/relatedIssueCounts エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

コンポーネントの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Configuration

<jira:get-rest-api3-configuration>

Jira の グローバル設定Leaving the Site​を返します。この設定により、省略可能な機能 (サブタスク、タイムトラッキングなど) を有効にするかどうかが決まります。タイムトラッキングが有効になっている場合、この操作はタイムトラッキング設定も返します。この操作には匿名でアクセスできます。

必要な権限:

なし。

この操作では、/rest/api/3/configuration エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Selected Time Tracking Implementation

<jira:get-rest-api3-configuration-timetracking>

現在選択されているタイムトラッキングプロバイダーを返します。タイムトラッキングが無効になっている場合、成功しても空の応答が返されます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/configuration/timetracking エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Available Time Tracking Implementations

<jira:get-rest-api3-configuration-timetracking-list>

すべてのタイムトラッキングプロバイダーを返します。デフォルトでは、Jira には 1 つのタイムトラッキングプロバイダー、​JIRA provided time tracking (JIRA 提供のタイムトラッキング)​ しかありません。ただし、Atlassian Marketplace にあるアプリケーションを介して他のタイムトラッキングプロバイダーをインストールできます。タイムトラッキングプロバイダーについての詳細は、 「Time Tracking Provider (タイムトラッキングプロバイダー)」Leaving the Site​モジュールを参照してください。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/configuration/timetracking/list エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Shared Time Tracking Configuration

<jira:get-rest-api3-configuration-timetracking-options>

タイムトラッキング設定を返します。これには、時刻形式、デフォルトの時間単位などの設定が含まれます。詳細は、 「Configuring time tracking (タイムトラッキングの設定)」Leaving the Site​を参照してください。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/configuration/timetracking/options エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Options For Field

<jira:get-rest-api3-custom-field-option-by-field-id>

この操作は廃止されており、2021 年 5 月 8 日に使用できなくなりました。代わりに、 Get custom field options (context)Leaving the Site​ を使用してください。詳細は、 「Deprecation of custom field options (カスタム項目オプションの廃止)」Leaving the Site​を参照してください。

オプションのページ分割されたリストを返します。カスタム選択項目のデータ型が​選択リスト (カスケード)​ の場合、カスタム選択項目のオプションをカスケードします。カスケードオプションは、ページネーションを決定するときに項目数に含まれます。グローバルコンテキストのオプションのみが返されます。この操作は、​Jira で作成されたか、[Issue custom field options](#api-group-Issue-custom-field-options) リソースからの操作を使用して作成された課題項目選択リストオプションでのみ機能します​。Connect アプリケーションによって作成された課題項目選択リストオプションでは使用できません。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/customField/{fieldId}/option エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Id (項目 ID)

Number (数値)

カスタム項目の ID。注意: これは、項目 ID の数値部分です。たとえば、ID ​customfield\_10075​ の項目には ​10075​ を使用します。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

1000

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get All Dashboards

<jira:get-rest-api3-dashboard>

ユーザーが所有または共有しているダッシュボードのリストを返します。リストを絞り込んで、お気に入りのダッシュボードまたは所有するダッシュボードのみを含めることができます。この操作には匿名でアクセスできます。

必要な権限:

なし。

この操作では、/rest/api/3/dashboard エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

filter (検索条件)

Enumeration (列挙)。次のいずれかになります。

  • MY

  • FAVOURITE

ダッシュボードのリストに適用される検索条件。有効な値は次のとおりです。* ​favourite​: ユーザーがお気に入りとしてマークしたダッシュボードを返します。​my​: ユーザーが所有するダッシュボードを返します。

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

20

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Dashboard

<jira:get-rest-api3-dashboard-by-id>

ダッシュボードを返します。この操作には匿名でアクセスできます。

必要な権限:

なし。

ただし、ダッシュボードを取得するには、ダッシュボードをユーザーと共有するか、ユーザーがダッシュボードを所有する必要があります。​「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​を持つユーザーは、System ダッシュボードのオーナーとみなされます。System ダッシュボードは、他のすべてのユーザーと共有されるとみなされます。

この操作では、/rest/api/3/dashboard/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

ダッシュボードの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Dashboard Item Property Keys

<jira:get-rest-api3-dashboard-items-properties-by-dashboard-id-item-id>

ダッシュボード項目のすべてのプロパティのキーを返します。この操作には匿名でアクセスできます。

必要な権限:

ユーザーはダッシュボードのオーナーであるか、ダッシュボードを共有している必要があります。​「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​を持つユーザーは、System ダッシュボードのオーナーとみなされます。System ダッシュボードは、他のすべてのユーザーと共有されるとみなされます。

この操作では、/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Dashboard Id (ダッシュボード ID)

String (文字列)

ダッシュボードの ID。

x

Item Id (品目 ID)

String (文字列)

ダッシュボード項目の ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Dashboard Item Property

<jira:get-rest-api3-dashboard-items-properties-by-dashboard-id-item-id-property-key>

ダッシュボード項目プロパティのキーと値を返します。ダッシュボード項目を使用すると、アプリケーションでユーザー固有の情報をユーザーダッシュボードに追加できます。ダッシュボード項目は、ユーザーがダッシュボードに追加できるガジェットとしてユーザーに公開されます。ユーザーがこれを行う方法についての詳細は、 「Adding and customizing gadgets (ガジェットの追加とカスタマイズ)」Leaving the Site​を参照してください。

アプリケーションでダッシュボード項目が作成されると、ダッシュボード項目 ID を受け取るためのコールバックが登録されます。コールバックは、項目が表示されるか、項目が設定可能な場合はユーザーが項目を編集するたびに起動します。その後、アプリケーションはこのリソースを使用して、項目のコンテンツまたは設定の詳細を保存します。ダッシュボード項目の操作についての詳細は、 「Building a dashboard item for a JIRA Connect add-on (JIRA Connect アドオンのダッシュボード項目の作成)」Leaving the Site​および 「Dashboard Item (ダッシュボード項目)」Leaving the Site​ドキュメントを参照してください。ダッシュボード項目を設定または取得するためのリソースはありません。この操作には匿名でアクセスできます。

必要な権限:

ユーザーはダッシュボードのオーナーであるか、ダッシュボードを共有している必要があります。​「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​を持つユーザーは、System ダッシュボードのオーナーとみなされます。System ダッシュボードは、他のすべてのユーザーと共有されるとみなされます。

この操作では、/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Dashboard Id (ダッシュボード ID)

String (文字列)

ダッシュボードの ID。

x

Item Id (品目 ID)

String (文字列)

ダッシュボード項目の ID。

x

Property Key (プロパティキー)

String (文字列)

ダッシュボード項目プロパティのキー。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Dashboards Paginated

<jira:get-rest-api3-dashboard-search>

ダッシュボードのページ分割されたリストを返します。この操作は [Get dashboards](#api-rest-api-3-dashboard-get) と似ていますが、結果を調整して特定の属性を持つダッシュボードを含めることができる点で異なります。たとえば、特定の名前が付いた複数のダッシュボードがあるとします。複数の属性が指定されている場合、すべての属性に一致する検索条件のみが返されます。この操作には匿名でアクセスできます。

必要な権限:

クエリパラメーターに一致する次のダッシュボードが返されます。

  • ユーザーが所有するダッシュボード。匿名ユーザーの場合は返されません。

  • ユーザーがメンバーであるグループと共有されるダッシュボード。匿名ユーザーの場合は返されません。

  • ユーザーが参照可能な非公開プロジェクトと共有されるダッシュボード。匿名ユーザーの場合は返されません。

  • 公開プロジェクトと共有されるダッシュボード。

  • 一般に共有されるダッシュボード。

この操作では、/rest/api/3/dashboard/search エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Dashboard Name (ダッシュボード名)

String (文字列)

大文字と小文字を区別しない ​name​ との部分一致を実行するために使用される文字列。

Account Id (アカウント ID)

String (文字列)

owner.accountId​ が一致するダッシュボードを返すために使用されるユーザーアカウント ID。このパラメーターは ​owner​ パラメーターと併用できません。

owner (オーナー)

String (文字列)

プライバシーの変更により、このパラメーターは廃止されました。代わりに ​accountId​ を使用します。詳細は、 移行ガイドLeaving the Site​を参照してください。​owner.name​ が一致するダッシュボードを返すために使用されるユーザー名。このパラメーターは ​accountId​ パラメーターと併用できません。

groupname (グループ名)

String (文字列)

sharePermissions.group.name​ に一致するグループと共有されているダッシュボードを返すために使用されるグループ名。

Project Id (プロジェクト ID)

Number (数値)

sharePermissions.project.id​ に一致するプロジェクトと共有されているダッシュボードを返すために使用されるプロジェクト ID。

Order By (並び替え基準)

Enumeration (列挙)。次のいずれかになります。

  • DESCRIPTION

  • FAVORITE_COUNT​

  • ID

  • IS_FAVORITE​

  • NAME

  • OWNER

項目別に結果を並び替えます。

  • description​: ダッシュボードの説明で並び替えます。この並び替えは、説明項目を表示するために展開が使用されているかどうかに関係なく機能します。

  • favourite_count​: ダッシュボードの人気で並び替えます。

  • id​: ダッシュボード ID で並び替えます。

  • is_favourite​: ダッシュボードがお気に入りとしてマークされているかどうかで並び替えます。

  • name​: ダッシュボード名で並び替えます。

  • owner​: ダッシュボードオーナー名で並び替えます。

NAME

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

expand (展開)

String (文字列)

expand​ を使用して、ダッシュボードに関する追加情報を応答に含めます。このパラメーターは、カンマ区切りのリストを受け入れます。expand (展開) には次のオプションがあります。

  • description​: ダッシュボードの説明を返します。

  • owner​: ダッシュボードのオーナーを返します。

  • viewUrl​: ダッシュボードの表示に使用される URL を返します。

  • favourite​: ユーザーがダッシュボードをお気に入りとして設定したかどうかを示すインジケーター ​isFavourite​ を返します。

  • popularity​: このダッシュボードをお気に入りとして設定しているユーザーの数 ​favouritedCount​ を返します。

  • sharePermissions​: ダッシュボードに定義されている共有権限の詳細を返します。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Fields

<jira:get-rest-api3-field>

次のルールに従って、システムおよびカスタム課題項目を返します。

  • 課題ナビゲーターに追加できない項目は常に返されます。

  • 課題画面に配置できない項目は常に返されます。

  • グローバル Jira 設定に連動する項目は、設定が有効になっている場合にのみ返されます。つまり、タイムトラッキング項目、サブタスク、投票、およびウォッチです。

  • 他のすべての項目の場合、この操作はユーザーが参照権限を持っている項目のみを返します (つまり、この項目はユーザーが​「Browse Projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​を持っている 1 つ以上のプロジェクトで使用されます)。 この操作には匿名でアクセスできます。

必要な権限:

なし。

この操作では、/rest/api/3/field エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Contexts For Field

<jira:get-rest-api3-field-context-by-field-id>

カスタム項目の コンテキストLeaving the Site​のページ分割されたリストを返します。コンテキストは次のように返すことができます。

  • 他のパラメーターが設定されていない場合、すべてのコンテキスト。

  • id​ のみを定義することで、ID のリスト内のすべてのコンテキスト。

  • isAnyIssueType​ を定義することで、返されるコンテキストのリストを、すべての課題種別に適用されるコンテキスト (true)、または課題種別のサブセットのみに適用されるコンテキスト (false) に制限。

  • isGlobalContext​ を定義することで、返されるコンテキストのリストを、すべてのプロジェクトに適用されるコンテキスト (グローバルコンテキスト) (true)、またはプロジェクトのサブセットのみに適用されるコンテキスト (false) に制限。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/field/{fieldId}/context エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Id (項目 ID)

String (文字列)

カスタム項目の ID。

x

Is Any Issue Type (すべての課題種別)

Boolean (ブール)

すべての課題種別に適用されるコンテキストを返すかどうか。

false

Is Global Context (グローバルコンテキスト)

Boolean (ブール)

すべてのプロジェクトに適用されるコンテキストを返すかどうか。

false

Context Id (コンテキスト ID)

Array of Number (数値の配列)

コンテキスト ID のリスト。複数のコンテキストを含めるには、ID をアンパサンドで区切ります: contextId=10000&contextId=10001​。

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Default Values

<jira:get-rest-api3-field-context-default-value-by-field-id>

カスタム項目のデフォルトのページ分割されたリストを返します。結果を ​contextId​ で絞り込むことができます。それ以外の場合、すべての値が返されます。コンテキストにデフォルトが設定されていない場合、何も返されません。返されるオブジェクトは、カスタム項目の型によって異なります。

  • 単一選択の選択リストとラジオボタンの場合、​CustomFieldContextDefaultValueSingleOption​ (​option.single​ 型)。

  • 複数選択の選択リストとチェックボックスの場合、​CustomFieldContextDefaultValueMultipleOption​ (​option.multiple​ 型)。

  • カスケード選択リストの場合、​CustomFieldContextDefaultValueCascadingOption​ (​option.cascading​ 型)。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/field/{fieldId}/context/defaultValue エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Id (項目 ID)

String (文字列)

カスタム項目の ID。

x

Context Id (コンテキスト ID)

Array of Number (数値の配列)

コンテキストの ID。

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Issue Type Mappings For Contexts

<jira:get-rest-api3-field-context-issue-type-mapping-by-field-id>

カスタム項目の課題種別マッピングへのコンテキストのページ分割されたリストを返します。マッピングは、すべてのコンテキストまたはコンテキストのリストに対して返されます。マッピングは、最初にコンテキスト ID、次に課題種別 ID の順に並び替えられます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/field/{fieldId}/context/issueTypeMapping エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Id (項目 ID)

String (文字列)

カスタム項目の ID。

x

Context Id (コンテキスト ID)

Array of Number (数値の配列)

コンテキストの ID。複数のコンテキストを含めるには、アンパサンド区切りのリストを指定します。例: contextId=10001&contextId=10002​。

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

* Any の配列

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Options For Context

<jira:get-rest-api3-field-context-option-by-field-id-context-id>

コンテキストのすべてのカスタム項目オプションのページ分割されたリストを返します。Jira に表示される順序で、オプションが最初に返され、次にカスケードオプションが返されます。この操作は、Jira で作成されたカスタム項目オプションまたはこのリソースからの操作で機能します。Connect アプリケーション用に作成された課題項目選択リストオプションを操作するには、[Issue custom field options (apps)](#api-group-issue-custom-field-options—​apps-) 操作を使用します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/field/{fieldId}/context/{contextId}/option エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Id (項目 ID)

String (文字列)

カスタム項目の ID。

x

Context Id (コンテキスト ID)

Number (数値)

コンテキストの ID。

x

Option Id (オプション ID)

Number (数値)

オプションの ID。

Only Options (オプションのみ)

Boolean (ブール)

オプションのみが返されるかどうか。

false

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

100

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Project Context Mapping

<jira:get-rest-api3-field-context-projectmapping-by-field-id>

カスタム項目のプロジェクトマッピングへのコンテキストのページ分割されたリストを返します。結果を ​contextId​ で絞り込むことができます。それ以外の場合、すべてのマッピングが返されます。無効な ID は無視されます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/field/{fieldId}/context/projectmapping エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Id (項目 ID)

String (文字列)

カスタム項目の ID。

x

Context Id (コンテキスト ID)

Array of Number (数値の配列)

コンテキスト ID のリスト。複数のコンテキストを含めるには、ID をアンパサンドで区切ります: contextId=10000&contextId=10001​。

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

* Any の配列

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get All Issue Field Options

<jira:get-rest-api3-field-option-by-field-key>

選択リスト課題項目のすべてのオプションのページ分割されたリストを返します。選択リスト課題項目は、ユーザーがオプションのリストから値を選択できる 課題項目Leaving the Site​の一種です。この操作は、​Connect アプリケーションで追加された課題項目選択リストオプションでのみ機能します​。Jira で作成されたか、[Issue custom field options](#api-group-Issue-custom-field-options) リソースからの操作を使用して作成された課題項目選択リストオプションでは使用できません。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

項目を提供するアプリケーションでは、Jira 権限は必要ありません。この操作では、/rest/api/3/field/{fieldKey}/option エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Key (項目キー)

String (文字列)

項目キーは次の形式で指定されます: $(app-key)\​\​$(field-key)​。例: example-add-on\_\_example-issue-field​。​fieldKey​ 値を決定するには、次のいずれかを実行します。

  • アプリケーションのプラグイン記述子を開く。​app-key​ は上部にあるキーで、​field-key​ は ​jiraIssueFields​ モジュール内のキーです。 app-key​ は、Atlassian Universal Plugin Manager のアプリケーションリストにもあります。

  • [Get fields](#api-rest-api-3-field-get) を実行する。項目の詳細で、値が ​key​ 内で返されます。(例: "key": "teams-add-on_team-issue-field"​)。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

* Any の配列

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Issue Field Option

<jira:get-rest-api3-field-option-by-field-key-option-id>

選択リスト課題項目からオプションを返します。この操作は、​Connect アプリケーションで追加された課題項目選択リストオプションでのみ機能します​。Jira で作成されたか、[Issue custom field options](#api-group-Issue-custom-field-options) リソースからの操作を使用して作成された課題項目選択リストオプションでは使用できません。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

項目を提供するアプリケーションでは、Jira 権限は必要ありません。この操作では、/rest/api/3/field/{fieldKey}/option/{optionId} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Key (項目キー)

String (文字列)

項目キーは次の形式で指定されます: $(app-key)\​\​$(field-key)​。例: example-add-on\_\_example-issue-field​。​fieldKey​ 値を決定するには、次のいずれかを実行します。

  • アプリケーションのプラグイン記述子を開く。​app-key​ は上部にあるキーで、​field-key​ は ​jiraIssueFields​ モジュール内のキーです。 app-key​ は、Atlassian Universal Plugin Manager のアプリケーションリストにもあります。

  • [Get fields](#api-rest-api-3-field-get) を実行する。項目の詳細で、値が ​key​ 内で返されます。(例: "key": "teams-add-on_team-issue-field"​)。

x

Option Id (オプション ID)

Number (数値)

返されるオプションの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Selectable Issue Field Options

<jira:get-rest-api3-field-option-suggestions-edit-by-field-key>

ユーザーが表示および選択できる選択リスト課題項目のオプションのページ分割されたリストを返します。この操作は、​Connect アプリケーションで追加された課題項目選択リストオプションでのみ機能します​。Jira で作成されたか、[Issue custom field options](#api-group-Issue-custom-field-options) リソースからの操作を使用して作成された課題項目選択リストオプションでは使用できません。

必要な権限:

Jira にアクセスするための権限。

この操作では、/rest/api/3/field/{fieldKey}/option/suggestions/edit エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Key (項目キー)

String (文字列)

項目キーは次の形式で指定されます: $(app-key)\​\​$(field-key)​。例: example-add-on\_\_example-issue-field​。​fieldKey​ 値を決定するには、次のいずれかを実行します。

  • アプリケーションのプラグイン記述子を開く。​app-key​ は上部にあるキーで、​field-key​ は ​jiraIssueFields​ モジュール内のキーです。 app-key​ は、Atlassian Universal Plugin Manager のアプリケーションリストにもあります。

  • [Get fields](#api-rest-api-3-field-get) を実行する。項目の詳細で、値が ​key​ 内で返されます。(例: "key": "teams-add-on_team-issue-field"​)。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

Project Id (プロジェクト ID)

Number (数値)

指定されたプロジェクトでのみ使用可能なオプションに結果を絞り込みます。

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

* Any の配列

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Visible Issue Field Options

<jira:get-rest-api3-field-option-suggestions-search-by-field-key>

ユーザーが表示できる選択リスト課題項目のオプションのページ分割されたリストを返します。この操作は、​Connect アプリケーションで追加された課題項目選択リストオプションでのみ機能します​。Jira で作成されたか、[Issue custom field options](#api-group-Issue-custom-field-options) リソースからの操作を使用して作成された課題項目選択リストオプションでは使用できません。

必要な権限:

Jira にアクセスするための権限。

この操作では、/rest/api/3/field/{fieldKey}/option/suggestions/search エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Key (項目キー)

String (文字列)

項目キーは次の形式で指定されます: $(app-key)\​\​$(field-key)​。例: example-add-on\_\_example-issue-field​。​fieldKey​ 値を決定するには、次のいずれかを実行します。

  • アプリケーションのプラグイン記述子を開く。​app-key​ は上部にあるキーで、​field-key​ は ​jiraIssueFields​ モジュール内のキーです。 app-key​ は、Atlassian Universal Plugin Manager のアプリケーションリストにもあります。

  • [Get fields](#api-rest-api-3-field-get) を実行する。項目の詳細で、値が ​key​ 内で返されます。(例: "key": "teams-add-on_team-issue-field"​)。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

Project Id (プロジェクト ID)

Number (数値)

指定されたプロジェクトでのみ使用可能なオプションに結果を絞り込みます。

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

* Any の配列

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Screens For Field

<jira:get-rest-api3-field-screens-by-field-id>

項目が使用されている画面のページ分割されたリストを返します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/field/{fieldId}/screens エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Id (項目 ID)

String (文字列)

画面を返す項目の ID。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

100

expand (展開)

String (文字列)

expand​ を使用して、画面に関する追加情報を応答に含めます。このパラメーターは、項目が使用されている画面タブに関する詳細を返す ​tab​ を受け入れます。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Fields Paginated

<jira:get-rest-api3-field-search>

従来の Jira プロジェクトの項目のページ分割されたリストを返します。リストには次の項目を含めることができます。

  • すべての項目。

  • id​ を定義することで、特定の項目。

  • query​ を定義することで、項目名または説明に文字列を含む項目。

  • id​ と ​query​ を定義することで、項目名または説明に文字列を含む特定の項目。照会できるのはカスタム項目のみです。​type​ が ​custom​ に設定されている必要があります。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/field/search エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

type (型)

Array of Enumeration (列挙の配列)。次のいずれかになります。

  • CUSTOM

  • SYSTEM

検索する項目の種別。

id

Array of String (文字列の配列)

返すカスタム項目の ID、または ​query​ が指定されている場合は検索条件。

query (クエリ)

String (文字列)

大文字と小文字を区別しない項目名または説明との部分一致を実行するために使用される文字列。

Order By (並び替え基準)

Enumeration (列挙)。次のいずれかになります。

  • CONTEXTS_COUNT​

  • LAST_USED​

  • NAME

  • SCREENS_COUNT

項目別に結果を並び替えます。

  • contextsCount​: 項目に関連するコンテキストの数で並び替えます。

  • lastUsed​: 項目の値が最後に変更された日付で並び替えます。

  • name​: 項目名で並び替えます。 *​screensCount​: 項目に関連する画面の数で並び替えます。

expand (拡張)

String (文字列)

expand​ を使用して、追加情報を応答に含めます。このパラメーターは、カンマ区切りのリストを受け入れます。expand (展開) には次のオプションがあります。

  • key​: 各項目のキーを返します。

  • lastUsed​: 項目の値が最後に変更された日付を返します。

  • screensCount​: 項目に関連する画面の数を返します。

  • contextsCount​: 項目に関連するコンテキストの数を返します。

  • isLocked​: 項目が ロックLeaving the Site​されているかどうかに関する情報を返します。

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

* Any の配列

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get All Field Configurations

<jira:get-rest-api3-fieldconfiguration>

すべての項目設定のページ分割されたリストを返します。返されるのは、従来のプロジェクトで使用されている項目設定のみです。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/fieldconfiguration エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

id

Array of Number (数値の配列)

項目設定 ID のリスト。複数の ID を含めるには、アンパサンド区切りのリストを指定します。例: id=10000&id=10001​。

Is Default (デフォルト)

Boolean (ブール)

true​ の場合、デフォルトの項目設定のみを返します。

false

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Field Configuration Items

<jira:get-rest-api3-fieldconfiguration-fields-by-id>

設定のすべての項目のページ分割されたリストを返します。返されるのは、従来のプロジェクトで使用されている設定の項目のみです。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/fieldconfiguration/{id}/fields エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

項目設定の ID。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get All Field Configuration Schemes

<jira:get-rest-api3-fieldconfigurationscheme>

項目設定スキームのページ分割されたリストを返します。返されるのは、従来のプロジェクトで使用されている項目設定スキームのみです。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/fieldconfigurationscheme エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

id

Array of Number (数値の配列)

項目設定スキーム ID のリスト。複数の ID を含めるには、アンパサンド区切りのリストを指定します。例: id=10000&id=10001​。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Field Configuration Scheme Mappings

<jira:get-rest-api3-fieldconfigurationscheme-mapping>

項目設定課題種別項目のページ分割されたリストを返します。返されるのは、従来のプロジェクトで使用されている項目のみです。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/fieldconfigurationscheme/mapping エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

Field Configuration Scheme Id (項目設定スキーム ID)

Array of Number (数値の配列)

項目設定スキーム ID のリスト。複数の項目設定スキームを含めるには、ID をアンパサンドで区切ります: fieldConfigurationSchemeId=10000&fieldConfigurationSchemeId=10001​。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Field Configuration Scheme Project Mapping

<jira:get-rest-api3-fieldconfigurationscheme-project>

項目設定スキームのページ分割されたリストを返し、スキームごとにそれを使用するプロジェクトのリストを返します。リストは、項目設定スキーム ID で並び替えられます。最初の項目には、デフォルトの項目設定スキームに割り当てられたプロジェクト ID のリストが含まれます。返されるのは、従来のプロジェクトで使用されている項目設定スキームのみです。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/fieldconfigurationscheme/project エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

Project Id (プロジェクト ID)

Array of Number (数値の配列)

プロジェクト ID のリスト。複数のプロジェクトを含めるには、ID をアンパサンドで区切ります: projectId=10000&projectId=10001​。

x

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

* Any の配列

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Filter

<jira:get-rest-api3-filter-by-id>

検索条件を返します。この操作には匿名でアクセスできます。

必要な権限:

なし。ただし、検索条件は次の場合にのみ返されます。

  • ユーザーが所有する。

  • ユーザーがメンバーであるグループと共有されている。

  • ユーザーが​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​を持っている非公開プロジェクトと共有されている。

  • 公開プロジェクトと共有されている。

  • 一般に共有されている。

この操作では、/rest/api/3/filter/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

返す検索条件の ID。

x

expand (展開)

String (文字列)

expand​ を使用して、検索条件に関する追加情報を応答に含めます。このパラメーターは、カンマ区切りのリストを受け入れます。expand (展開) には次のオプションがあります。

  • sharedUsers​: 検索条件が共有されているユーザーを返します。これには、検索条件が共有されているプロジェクトを参照できるユーザーが含まれます。​sharedUsers​ を指定しない場合、​sharedUsers​ オブジェクトは返されますが、ユーザーはリストされません。返されるユーザーのリストは 1000 個に制限され、追加ユーザーにアクセスするには、展開要求に ​[start-index:end-index]​ を追加します。たとえば、次の 1000 ユーザーにアクセスするには、​?expand=sharedUsers[1001:2000]​ を使用します。

  • subscriptions​: 検索条件にサブスクライブしているユーザーを返します。​subscriptions​ を指定しない場合、​subscriptions​ オブジェクトは返されますが、サブスクリプションはリストされません。返されるサブスクリプションのリストは 1000 個に制限され、追加サブスクリプションにアクセスするには、展開要求に ​[start-index:end-index]​ を追加します。たとえば、次の 1000 サブスクリプションにアクセスするには、​?expand=subscriptions[1001:2000]​ を使用します。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Columns

<jira:get-rest-api3-filter-columns-by-id>

検索条件に設定された列を返します。列設定は、​[List View (リストビュー)]​ で検索条件の結果が表示され、​[Columns (列)]​ が ​[Filter (検索条件)]​ に設定されている場合に使用されます。この操作には匿名でアクセスできます。

必要な権限:

なし。ただし、列の詳細は次の場合にのみ返されます。

  • ユーザーが所有する検索条件。

  • ユーザーがメンバーであるグループと共有される検索条件。

  • ユーザーが​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​を持っている非公開プロジェクトと共有される検索条件。

  • 公開プロジェクトと共有される検索条件。

  • 一般に共有される検索条件。

この操作では、/rest/api/3/filter/{id}/columns エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

検索条件の ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Default Share Scope

<jira:get-rest-api3-filter-default-share-scope>

ユーザーの新しい検索条件とダッシュボードのデフォルトの共有設定を返します。

必要な権限:

Jira にアクセスするための権限。

この操作では、/rest/api/3/filter/defaultShareScope エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Favourite Filters

<jira:get-rest-api3-filter-favourite>

ユーザーに表示されるお気に入り検索条件を返します。この操作には匿名でアクセスできます。

必要な権限:

お気に入り検索条件は、検索条件が次の場合にのみユーザーに表示されます。

  • ユーザーが所有する。

  • ユーザーがメンバーであるグループと共有されている。

  • ユーザーが​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​を持っている非公開プロジェクトと共有されている。

  • 公開プロジェクトと共有されている。

  • 一般に共有されている。たとえば、ユーザーが公開検索条件をお気に入りに追加し、その後それが非公開になった場合、その検索条件はこの操作では返されません。

この操作では、/rest/api/3/filter/favourite エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

expand (展開)

String (文字列)

expand​ を使用して、検索条件に関する追加情報を応答に含めます。このパラメーターは、カンマ区切りのリストを受け入れます。expand (展開) には次のオプションがあります。

  • sharedUsers​: 検索条件が共有されているユーザーを返します。これには、検索条件が共有されているプロジェクトを参照できるユーザーが含まれます。​sharedUsers​ を指定しない場合、​sharedUsers​ オブジェクトは返されますが、ユーザーはリストされません。返されるユーザーのリストは 1000 個に制限され、追加ユーザーにアクセスするには、展開要求に ​[start-index:end-index]​ を追加します。たとえば、次の 1000 ユーザーにアクセスするには、​?expand=sharedUsers[1001:2000]​ を使用します。

  • subscriptions​: 検索条件にサブスクライブしているユーザーを返します。​subscriptions​ を指定しない場合、​subscriptions​ オブジェクトは返されますが、サブスクリプションはリストされません。返されるサブスクリプションのリストは 1000 個に制限され、追加サブスクリプションにアクセスするには、展開要求に ​[start-index:end-index]​ を追加します。たとえば、次の 1000 サブスクリプションにアクセスするには、​?expand=subscriptions[1001:2000]​ を使用します。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get My Filters

<jira:get-rest-api3-filter-my>

ユーザーが所有する検索条件を返します。​includeFavourites​ が ​true​ の場合、ユーザーに表示されるお気に入り検索条件も返されます。

必要な権限:

Jira へのアクセス権。ただし、お気に入り検索条件は、検索条件が次の場合にのみユーザーに表示されます。

  • ユーザーが所有する。

  • ユーザーがメンバーであるグループと共有されている。

  • ユーザーが​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​を持っている非公開プロジェクトと共有されている。

  • 公開プロジェクトと共有されている。

  • 一般に共有されている。たとえば、ユーザーが公開検索条件をお気に入りに追加し、その後それが非公開になった場合、その検索条件はこの操作では返されません。

この操作では、/rest/api/3/filter/my エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

expand (展開)

String (文字列)

expand​ を使用して、検索条件に関する追加情報を応答に含めます。このパラメーターは、カンマ区切りのリストを受け入れます。expand (展開) には次のオプションがあります。

  • sharedUsers​: 検索条件が共有されているユーザーを返します。これには、検索条件が共有されているプロジェクトを参照できるユーザーが含まれます。​sharedUsers​ を指定しない場合、​sharedUsers​ オブジェクトは返されますが、ユーザーはリストされません。返されるユーザーのリストは 1000 個に制限され、追加ユーザーにアクセスするには、展開要求に ​[start-index:end-index]​ を追加します。たとえば、次の 1000 ユーザーにアクセスするには、​?expand=sharedUsers[1001:2000]​ を使用します。

  • subscriptions​: 検索条件にサブスクライブしているユーザーを返します。​subscriptions​ を指定しない場合、​subscriptions​ オブジェクトは返されますが、サブスクリプションはリストされません。返されるサブスクリプションのリストは 1000 個に制限され、追加サブスクリプションにアクセスするには、展開要求に ​[start-index:end-index]​ を追加します。たとえば、次の 1000 サブスクリプションにアクセスするには、​?expand=subscriptions[1001:2000]​ を使用します。

Include Favourites (お気に入りを含める)

Boolean (ブール)

ユーザーのお気に入り検索条件を応答に含めます。

false

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Share Permissions

<jira:get-rest-api3-filter-permission-by-id>

検索条件の共有権限を返します。検索条件は、グループ、プロジェクト、すべてのログインユーザー、または一般ユーザーと共有できます。すべてのログインユーザーまたは一般ユーザーとの共有は、グローバル共有権限と呼ばれます。この操作には匿名でアクセスできます。

必要な権限:

なし。ただし、共有権限は次の場合にのみ返されます。

  • ユーザーが所有する検索条件。

  • ユーザーがメンバーであるグループと共有される検索条件。

  • ユーザーが​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​を持っている非公開プロジェクトと共有される検索条件。

  • 公開プロジェクトと共有される検索条件。

  • 一般に共有される検索条件。

この操作では、/rest/api/3/filter/{id}/permission エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

検索条件の ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Share Permission

<jira:get-rest-api3-filter-permission-by-id-permission-id>

検索条件の特定の共有権限を返します。検索条件は、グループ、プロジェクト、すべてのログインユーザー、または一般ユーザーと共有できます。すべてのログインユーザーまたは一般ユーザーとの共有は、グローバル共有権限と呼ばれます。この操作には匿名でアクセスできます。

必要な権限:

なし。ただし、特定の共有権限は次の場合にのみ返されます。

  • ユーザーが所有する検索条件。

  • ユーザーがメンバーであるグループと共有される検索条件。

  • ユーザーが​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​を持っている非公開プロジェクトと共有される検索条件。

  • 公開プロジェクトと共有される検索条件。

  • 一般に共有される検索条件。

この操作では、/rest/api/3/filter/{id}/permission/{permissionId} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

検索条件の ID。

x

Permission Id (権限 ID)

Number (数値)

共有権限の ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Filters Paginated

<jira:get-rest-api3-filter-search>

検索条件のページ分割されたリストを返します。このオプションを使用して、次のデータを取得します。

  • id​ のみを定義することで、特定の検索条件。

  • 指定された属性のすべてと一致する検索条件。たとえば、名前に特定の単語が含まれるユーザーのすべての検索条件。複数の属性が指定されている場合、すべての属性に一致する検索条件のみが返されます。この操作には匿名でアクセスできます。

必要な権限:

なし。ただし、クエリパラメーターに一致する次の検索条件のみが返されます。

  • ユーザーが所有する検索条件。

  • ユーザーがメンバーであるグループと共有される検索条件。

  • ユーザーが​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​を持っている非公開プロジェクトと共有される検索条件。

  • 公開プロジェクトと共有される検索条件。

  • 一般に共有される検索条件。

この操作では、/rest/api/3/filter/search エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Filter Name (検索条件名)

String (文字列)

大文字と小文字を区別しない ​name​ との部分一致を実行するために使用される文字列。

Account Id (アカウント ID)

String (文字列)

owner.accountId​ が一致する検索条件を返すために使用されるユーザーアカウント ID。このパラメーターは ​owner​ と併用できません。

owner (オーナー)

String (文字列)

プライバシーの変更により、このパラメーターは廃止されました。代わりに ​accountId​ を使用します。詳細は、 移行ガイドLeaving the Site​を参照してください。​owner.name​ が一致する検索条件を返すために使用されるユーザー名。このパラメーターは ​accountId​ と併用できません。

groupname (グループ名)

String (文字列)

sharePermissions.group.groupname​ に一致するグループと共有されている検索条件を返すために使用されるグループ名。

Project Id (プロジェクト ID)

Number (数値)

sharePermissions.project.id​ に一致するプロジェクトと共有されている検索条件を返すために使用されるプロジェクト ID。

id

Array of Number (数値の配列)

検索条件 ID のリスト。複数の ID を含めるには、アンパサンド区切りのリストを指定します。例: id=10000&id=10001​。

Order By (並び替え基準)

Enumeration (列挙)。次のいずれかになります。

  • DESCRIPTION

  • FAVORITE_COUNT​

  • ID

  • IS_FAVORITE​

  • NAME

  • OWNER

項目別に結果を並び替えます。

  • description​: 検索条件の説明で並び替えます。この並び替えは、説明項目を表示するために展開が使用されているかどうかに関係なく機能します。

  • favourite_count​: この検索条件をお気に入りとして設定しているユーザーの数で並び替えます。

  • is_favourite​: 検索条件がお気に入りとしてマークされているかどうかで並び替えます。

  • id​: 検索条件 ID で並び替えます。

  • name​: 検索条件名で並び替えます。

  • owner​: 検索条件オーナーの ID で並び替えます。

NAME

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

expand (展開)

String (文字列)

expand​ を使用して、検索条件に関する追加情報を応答に含めます。このパラメーターは、カンマ区切りのリストを受け入れます。expand (展開) には次のオプションがあります。

  • description​: 検索条件の説明を返します。

  • favourite​: ユーザーが検索条件をお気に入りとして設定しているかどうかを示すインジケーターを返します。

  • favouritedCount​: この検索条件をお気に入りとして設定しているユーザーの数を返します。

  • jql​: 検索条件を使用する JQL クエリを返します。

  • owner​: 検索条件のオーナーを返します。

  • searchUrl​: 検索条件の JQL クエリを実行する URL を返します。

  • sharePermissions​: 検索条件に定義されている共有権限を返します。

  • subscriptions​: 検索条件にサブスクライブしているユーザーを返します。

  • viewUrl​: 検索条件を表示する URL を返します。

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

* Any の配列

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Bulk Get Groups

<jira:get-rest-api3-group-bulk>

グループのページ分割されたリストを返します。

必要な権限:

「Browse users and groups (ユーザーとグループの参照)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/group/bulk エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

Group Id (グループ ID)

Array of String (文字列の配列)

グループの ID。複数の ID を指定するには、複数の ​groupId​ パラメーターを渡します。例: groupId=5b10a2844c20165700ede21g&groupId=5b10ac8d82e05b22cc7d4ef5​。

Group Name (グループ名)

Array of String (文字列の配列)

グループの名前。複数の名前を指定するには、複数の ​groupName​ パラメーターを渡します。例: groupName=administrators&groupName=jira-software-users​。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Users From Group

<jira:get-rest-api3-group-member>

グループのすべてのユーザーのページ分割されたリストを返します。ユーザーはユーザー名で並び替えられますが、プライバシー上の理由により、ユーザー名は結果で返されません。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/group/member エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

groupname (グループ名)

String (文字列)

グループの名前。

x

Include Inactive Users (非アクティブユーザーを含める)

Boolean (ブール)

非アクティブユーザーを含めます。

false

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Find Groups

<jira:get-rest-api3-groups-picker>

名前にクエリ文字列が含まれるグループのリストを返します。グループ名のリストを指定して、結果からグループを除外できます。このリソースの主なユースケースは、グループピッカーの提案リストにデータを入力することです。この目的のために、返されるオブジェクトには、HTML の強力なタグを使用してグループ名内で一致するクエリ用語が強調表示される ​html​ 項目が含まれます。また、グループリストは、ピッカーで使用するヘッダー (具体的には ​X/Y 一致グループを表示​) を含む応答オブジェクトにラップされます。リストは、グループが並び替えられた状態で返されます。リスト条件に一致するグループがない場合は、空のリストが返されます。この操作には匿名でアクセスできます。

必要な権限:

「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。匿名コールおよび必要な権限がないユーザーによるコールでは、空のリストが返されます。

この操作では、/rest/api/3/groups/picker エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Account Id (アカウント ID)

String (文字列)

このパラメーターは廃止されており、設定しても結果には影響しません。特定のユーザーを含むグループを検索するには、[Get user groups](#api-rest-api-3-user-groups-get) を使用します。

query (クエリ)

String (文字列)

グループ名内で検索する文字列。

exclude (除外)

Array of String (文字列の配列)

結果から除外するグループ。複数のグループを除外するには、アンパサンド区切りのリストを指定します。例: exclude=group1&exclude=group2​。

Max Results (最大結果数)

Number (数値)

返すグループの最大数。返すことができるグループの最大数は、システムプロパティ ​jira.ajax.autocomplete.limit​ によって制限されます。

User Name (ユーザー名)

String (文字列)

このパラメーターは使用できなくなり、まもなくドキュメントから削除されます。詳細は、[廃止通知](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/Leaving the Site) を参照してください。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Find Users And Groups

<jira:get-rest-api3-groupuserpicker>

文字列に一致するユーザーとグループのリストを返します。文字列は次の目的に使用されます。

  • ユーザーの場合、表示名とメールアドレスで大文字と小文字を区別しない一致を検索する。ユーザーが自分のメールアドレスをユーザープロファイルで非表示にしている場合、メールアドレスの部分一致ではユーザーは検索されません。完全一致が必要です。

  • グループの場合、グループ名で大文字と小文字を区別する一致を検索する。たとえば、文字列​「tin」​が使用されている場合、表示名が​「Tina」​、メールアドレスが​「sarah@tinplatetraining.com」​、グループが​「accounting」​のレコードが返されます。必要に応じて、検索を次の対象に絞り込むことができます。

  • ユーザーピッカーなど、カスタム項目に関連付けられたプロジェクトおよび課題種別。
    次に、検索をさらに絞り込んで、次の特定の対象を表示する権限を持つユーザーとグループのみを返すことができます。

    • プロジェクト。

    • 課題種別。

複数のプロジェクトまたは課題種別が指定されている場合、それらはカスタム項目で有効なサブセットである必要があります。それ以外の場合、結果は返されません。たとえば、項目がプロジェクト A、B、C で有効になっている場合、検索をプロジェクト B と C に制限できます。 ただし、検索がプロジェクト B と D に制限されている場合は、何も返されません。

このリソースの主なユースケースは、ピッカー項目の提案リストにユーザーまたはグループを入力することです。この目的のために、返されるオブジェクトには各リストの ​html​ 項目が含まれます。この項目では、HTML の強力なタグを使用して項目名内で一致するクエリ用語が強調表示されます。また、各リストは、ピッカーで使用するヘッダー (具体的には ​X/Y 一致グループを表示​) を含む応答オブジェクトにラップされます。この操作には匿名でアクセスできます。

必要な権限:

「Browse users and groups (ユーザーとグループの参照)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/groupuserpicker エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

query (クエリ)

String (文字列)

検索文字列。

x

Max Results (最大結果数)

Number (数値)

各リストで返される項目の最大数。

50

Show Avatar (アバターを表示)

Boolean (ブール)

ユーザーのアバターが返されるかどうか。無効な値が指定された場合、デフォルト値が使用されます。

false

Field Id (項目 ID)

String (文字列)

この要求の対象となる項目のカスタム項目 ID。

Project Id (プロジェクト ID)

Array of String (文字列の配列)

返されるユーザーとグループに参照権限が必要なプロジェクトの ID。複数のプロジェクトを含めるには、アンパサンド区切りのリストを指定します。例: projectId=10000&projectId=10001​。このパラメーターは、​fieldId​ が存在する場合にのみ使用されます。

Issue Type Id (課題種別 ID)

Array of String (文字列の配列)

返されるユーザーとグループに参照権限が必要な課題種別の ID。複数の課題種別を含めるには、アンパサンド区切りのリストを指定します。例: issueTypeId=10000&issueTypeId=10001​。​-1​ (すべての標準課題種別) や ​-2​ (すべてのサブタスク課題種別) などの特別な値がサポートされています。このパラメーターは、​fieldId​ が存在する場合にのみ使用されます。

Avatar Size (アバターサイズ)

Enumeration (列挙)。次のいずれかになります。

  • XSMALL

  • XSMALL2X

  • XSMALL3X

  • SMALL

  • SMALL2X

  • SMALL3X

  • MEDIUM

  • MEDIUM2X

  • MEDIUM3X

  • LARGE

  • LARGE2X

  • LARGE3X

  • XLARGE

  • XLARGE2X

  • XLARGE3X

  • XXLARGE

  • XXLARGE2X

  • XXLARGE3X

  • XXXLARGE

  • XXXLARGE2X

  • XXXLARGE3X

返すアバターのサイズ。無効な値が指定された場合、デフォルト値が使用されます。

XSMALL

Case Insensitive (大文字と小文字を区別しない)

Boolean (ブール)

グループの検索で大文字と小文字を区別しないかどうか。

false

Exclude Connect Addons (Connect アドオンを除外)

Boolean (ブール)

Connect アプリケーションのユーザーとグループを検索結果から除外するかどうか。無効な値が指定された場合、デフォルト値が使用されます。

false

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Issue

<jira:get-rest-api3-issue-by-issue-id-or-key>

課題の詳細を返します。課題は ID またはキーで識別されますが、識別子が課題と一致しない場合、移動した課題の大文字と小文字を区別しない検索とチェックが実行されます。一致する課題が見つかった場合、その詳細が返され、302 またはその他のリダイレクトは​返されません​。応答で返される課題キーは、見つかった課題のキーです。この操作には匿名でアクセスできます。

必要な権限:

この操作では、/rest/api/3/issue/{issueIdOrKey} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

fields

Array of String (文字列の配列)

課題に対して返される項目のリスト。このパラメーターは、カンマ区切りのリストを受け入れます。これを使用して、項目のサブセットを取得します。次の値を使用できます。

  • *all​: すべての項目を返します。

  • *navigable​: ナビゲート可能な項目を返します。

  • 任意の課題項目: 先頭にマイナス付けることで除外します。

例:

  • summary,comment​: 概要項目とコメント項目のみを返します。

  • -description​: 説明を除くすべての (デフォルト) 項目を返します。

  • *navigable,-comment​: コメントを除くすべてのナビゲート可能な項目を返します。

このパラメーターは複数回指定できます。例: fields=field1,field2& fields=field3​。注意: デフォルトでは、すべての項目が返されます。これは、デフォルトがすべてナビゲート可能な項目である [Search for issues using JQL (GET)](#api-rest-api-3-search-get) および [Search for issues using JQL (POST)](#api-rest-api-3-search-post) とは異なります。

Fields By Keys (キー別の項目)

Boolean (ブール)

fields​ の項目が ID ではなくキーによって参照されるかどうか。このパラメーターは、Connect アプリケーションによって項目が追加され、項目のキーがその ID と異なる場合に役立ちます。

false

expand (展開)

String (文字列)

expand​ を使用して、課題に関する追加情報を応答に含めます。このパラメーターは、カンマ区切りのリストを受け入れます。expand (展開) には次のオプションがあります。

  • renderedFields​: HTML 形式で表示される項目値を返します。

  • names​: 各項目の表示名を返します。

  • schema​: 項目のデータ型を表すスキーマを返します。

  • transitions​: 課題のすべての考えられる移行を返します。

  • editmeta​: 各項目の編集方法に関する情報を返します。

  • changelog​: 新しい日付順に並び替えられた、最近の課題への更新のリストを返します。

  • versionedRepresentations​: 項目値の各バージョンの JSON 配列を返します。最大の数値は最新のバージョンを表します。注意: 要求に含まれている ​fields​ パラメーターは無視されます。

properties

Array of String (文字列の配列)

課題に対して返される課題プロパティのリスト。このパラメーターは、カンマ区切りのリストを受け入れます。次の値を使用できます。

  • *all​: すべての課題プロパティを返します。

  • 任意の課題プロパティキー: 先頭にマイナス付けることで除外します。

例:

  • *all​: すべてのプロパティを返します。

  • *all,-prop1​: prop1​ を除くすべてのプロパティを返します。

  • prop1,prop2​: prop1​ および ​prop2​ プロパティを返します。

このパラメーターは複数回指定できます。例: properties=prop1,prop2& properties=prop3​。

Update History (履歴を更新)

Boolean (ブール)

Jira で ​[Projects (プロジェクト)]​ の下に表示されているように、課題が作成されたプロジェクトがユーザーの ​[Recently viewed (最近参照したデータ)]​ プロジェクトリストに追加されるかどうか。これにより、[JQL issues search](#api-rest-api-3-search-get) ​lastViewed​ 項目にもデータが入力されます。

false

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Change Logs

<jira:get-rest-api3-issue-changelog-by-issue-id-or-key>

古い日付順に並び替えられた、課題のすべての変更ログのページ分割されたリストを返します。この操作には匿名でアクセスできます。

必要な権限:

この操作では、/rest/api/3/issue/{issueIdOrKey}/changelog エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

100

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

* Any の配列

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Comments

<jira:get-rest-api3-issue-comment-by-issue-id-or-key>

課題のすべてのコメントを返します。この操作には匿名でアクセスできます。

必要な権限:

コメントは、ユーザーが次の条件を満たす場合に応答に含まれます。

  • コメントを含むプロジェクトに対する​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

  • 課題レベルのセキュリティLeaving the Site​が設定されている場合、課題を表示する課題レベルのセキュリティ権限。

  • コメントの表示制限がある場合、グループに属しているか、表示が制限されているロールがある。

この操作では、/rest/api/3/issue/{issueIdOrKey}/comment エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

Order By (並び替え基準)

Enumeration (列挙)。次のいずれかになります。

  • CREATED

項目別に結果を並び替えます。作成日でコメントを並べ替えるには、​created (作成済み)​ を受け入れます。

expand (展開)

String (文字列)

expand​ を使用して、コメントに関する追加情報を応答に含めます。このパラメーターは、HTML で表示されるコメント本文を返す ​renderedBody​ を受け入れます。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Comment

<jira:get-rest-api3-issue-comment-by-issue-id-or-key-id>

コメントを返します。この操作には匿名でアクセスできます。

必要な権限:

  • コメントを含むプロジェクトに対する​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

  • 課題レベルのセキュリティLeaving the Site​が設定されている場合、課題を表示する課題レベルのセキュリティ権限。

  • コメントの表示制限がある場合、ユーザーがグループに属しているか、表示が制限されているロールがある。

この操作では、/rest/api/3/issue/{issueIdOrKey}/comment/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

id

String (文字列)

コメントの ID。

x

expand (展開)

String (文字列)

expand​ を使用して、コメントに関する追加情報を応答に含めます。このパラメーターは、HTML で表示されるコメント本文を返す ​renderedBody​ を受け入れます。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Create Issue Meta

<jira:get-rest-api3-issue-createmeta>

プロジェクトの詳細、プロジェクト内の課題種別を返し、要求された場合は、ユーザーの各課題種別の作成画面項目を返します。[Create issue](#api-rest-api-3-issue-post) および [Create issues](#api-rest-api-3-issue-bulk-post) で、この情報を使用して要求にデータを入力します。クエリパラメーターを使用して、要求を特定のプロジェクトまたは課題種別に制限できます。応答には、有効なプロジェクト、課題種別、または要求されたプロジェクトと課題種別の組み合わせに関する情報が含まれます。無効なプロジェクト、課題種別、またはプロジェクトと課題種別の組み合わせでは、エラーは生成されません。この操作には匿名でアクセスできます。

必要な権限:

要求されたプロジェクトに対する​「Create issues (課題の作成)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/issue/createmeta エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Ids (プロジェクト ID)

Array of String (文字列の配列)

プロジェクト ID のリスト。このパラメーターは、カンマ区切りのリストを受け入れます。アンパサンド区切りのリストを使用して、複数のプロジェクト ID を指定することもできます。例: projectIds=10000,10001&projectIds=10020,10021​。このパラメーターは ​projectKeys​ と共に指定できます。

Project Keys (プロジェクトキー)

Array of String (文字列の配列)

プロジェクトキーのリスト。このパラメーターは、カンマ区切りのリストを受け入れます。アンパサンド区切りのリストを使用して、複数のプロジェクトキーを指定することもできます。例: projectKeys=proj1,proj2&projectKeys=proj3​。このパラメーターは ​projectIds​ と共に指定できます。

Issuetype Ids (課題種別 ID)

Array of String (文字列の配列)

課題種別 ID のリスト。このパラメーターは、カンマ区切りのリストを受け入れます。アンパサンド区切りのリストを使用して、複数の課題種別 ID を指定することもできます。例: issuetypeIds=10000,10001&issuetypeIds=10020,10021​。このパラメーターは ​issuetypeNames​ と共に指定できます。

Issuetype Names (課題種別名)

Array of String (文字列の配列)

課題種別名のリスト。このパラメーターは、カンマ区切りのリストを受け入れます。アンパサンド区切りのリストを使用して、複数の課題種別名を指定することもできます。例: issuetypeNames=name1,name2&issuetypeNames=name3​。このパラメーターは ​issuetypeIds​ と共に指定できます。

expand (展開)

String (文字列)

expand​ を使用して、課題メタデータに関する追加情報を応答に含めます。このパラメーターは、各課題種別の課題作成画面の項目に関する情報を返す ​projects.issuetypes.fields​ を受け入れます。画面で非表示になっている項目は返されません。[Create issue](#api-rest-api-3-issue-post) および [Create issues](#api-rest-api-3-issue-bulk-post) で、この情報を使用して ​fields​ および ​update​ 項目にデータを入力します。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Edit Issue Meta

<jira:get-rest-api3-issue-editmeta-by-issue-id-or-key>

ユーザーが表示および編集できる、課題の編集画面項目を返します。[Edit issue](#api-rest-api-3-issue-issueIdOrKey-put) で、この情報を使用して要求にデータを入力します。(ユーザー権限とアプリケーションスコープからの) 管理者権限を持つ Connect アプリケーションユーザーは、次を使用して追加の詳細を返すことができます。

  • overrideScreenSecurity​: 非表示の項目を返します。

  • overrideEditableFlag​: 編集できない項目を返します。たとえば、課題のワークフロー状況が closed (完了) の場合、そのすべての項目は編集できません。この操作には匿名でアクセスできます。

必要な権限:

  • 課題を含むプロジェクトに対する​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

  • 課題レベルのセキュリティLeaving the Site​が設定されている場合、課題を表示する課題レベルのセキュリティ権限。注意: 項目が編集可能になるには、ユーザーが課題に対する​「Edit issues (課題の編集)」 プロジェクト権限Leaving the Site​を持っている必要があります。

この操作では、/rest/api/3/issue/{issueIdOrKey}/editmeta エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

Override Screen Security (画面セキュリティを上書き)

Boolean (ブール)

非表示の項目が返されるかどうか。管理者権限を持つ Connect アプリケーションユーザーが使用可能。

false

Override Editable Flag (編集可能なフラグを上書き)

Boolean (ブール)

編集できない項目が返されるかどうか。管理者権限を持つ Connect アプリケーションユーザーが使用可能。

false

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Issue Link

<jira:get-rest-api3-issue-link-by-link-id>

課題リンクを返します。この操作には匿名でアクセスできます。

必要な権限:

この操作では、/rest/api/3/issueLink/{linkId} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Link Id (リンク ID)

String (文字列)

課題リンクの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Issue Link Types

<jira:get-rest-api3-issue-link-type>

すべての課題リンク種別のリストを返します。この操作を使用するには、サイトで 課題のリンクLeaving the Site​が有効になっている必要があります。この操作には匿名でアクセスできます。

必要な権限:

サイト内のプロジェクトに対する​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/issueLinkType エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Issue Link Type

<jira:get-rest-api3-issue-link-type-by-issue-link-type-id>

課題リンク種別を返します。この操作を使用するには、サイトで 課題のリンクLeaving the Site​が有効になっている必要があります。この操作には匿名でアクセスできます。

必要な権限:

サイト内のプロジェクトに対する​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/issueLinkType/{issueLinkTypeId} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Link Type Id

String (文字列)

課題リンク種別の ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Issue Picker Resource

<jira:get-rest-api3-issue-picker>

クエリ文字列に一致する課題のリストを返します。このリソースを使用して、ユーザーが単語または文字列を使用して課題を検索するときのオートコンプリートの提案を提供します。この操作は 2 つのリストを返します。

  • History Search​: query​ パラメーターの文字列を含む、作成、編集、または表示された課題のユーザーの履歴からの課題が含まれます。

  • Current Search​: currentJQL​ の JQL 式に一致し、​query​ パラメーターの文字列を含む課題が含まれます。

この操作には匿名でアクセスできます。

必要な権限:

なし。

この操作では、/rest/api/3/issue/picker エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

query (クエリ)

String (文字列)

タイトル、説明、コメントなど、課題のテキスト項目と照合する文字列。

Current JQL (現在の JQL)

String (文字列)

クエリ用語を検索する課題のリストを定義する JQL クエリ。プライバシー上の理由により、​username​ および ​userkey​ はこのパラメーターの検索語として使用できません。代わりに ​accountId​ を使用します。

Current Issue Key

String (文字列)

検索結果から除外する課題のキー。たとえば、ユーザーがこのクエリを実行するときに参照している課題。

Current Project Id (現在のプロジェクト ID)

String (文字列)

提案される課題が属している必要があるプロジェクトの ID。

Show Sub Tasks (サブタスクを表示)

Boolean (ブール)

提案リストにサブタスクを含めるかどうかを示します。

false

Show Sub Task Parent (サブタスクの親を表示)

Boolean (ブール)

currentIssueKey​ がサブタスクの場合、クエリに一致する場合に親の課題を提案に含めるかどうか。

false

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Issue Property Keys

<jira:get-rest-api3-issue-properties-by-issue-id-or-key>

課題のプロパティの URL とキーを返します。この操作には匿名でアクセスできます。

必要な権限:

プロパティの詳細は、ユーザーが次の条件を満たす場合にのみ返されます。

この操作では、/rest/api/3/issue/{issueIdOrKey}/properties エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題のキーまたは ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Issue Property

<jira:get-rest-api3-issue-properties-by-issue-id-or-key-property-key>

課題のプロパティのキーと値を返します。この操作には匿名でアクセスできます。

必要な権限:

この操作では、/rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題のキーまたは ID。

x

Property Key (プロパティキー)

String (文字列)

プロパティのキー。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Remote Issue Links

<jira:get-rest-api3-issue-remotelink-by-issue-id-or-key>

課題のリモート課題リンクを返します。リモート課題リンクのグローバル ID が指定されている場合、そのグローバル ID のレコードが返されます。それ以外の場合、すべてのリモート課題リンクが返されます。グローバル ID に予約済み URL 文字が含まれる場合、要求でそれらをエスケープする必要があります。たとえば、​system=http://www.mycompany.com/support&id=1​ を ​system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1​ として渡します。この操作には、 課題リンクがアクティブになっているLeaving the Site​必要があります。この操作には匿名でアクセスできます。

必要な権限:

この操作では、/rest/api/3/issue/{issueIdOrKey}/remotelink エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

Global Id (グローバル ID)

String (文字列)

リモート課題リンクのグローバル ID。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Remote Issue Link By Id

<jira:get-rest-api3-issue-remotelink-by-issue-id-or-key-link-id>

課題のリモート課題リンクを返します。この操作には、 課題リンクがアクティブになっているLeaving the Site​必要があります。この操作には匿名でアクセスできます。

必要な権限:

この操作では、/rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

Link Id (リンク ID)

String (文字列)

リモート課題リンクの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Transitions

<jira:get-rest-api3-issue-transitions-by-issue-id-or-key>

課題の状況に基づいて、すべての移行、または課題でユーザーが実行できる移行のいずれかを返します。存在しないか課題で実行できない移行が要求された場合、その状況を指定すると、応答は空の移行リストを返します。この操作には匿名でアクセスできます。

必要な権限:

リストまたは移行は、ユーザーが次の条件を満たす場合にのみ返されます。

  • 課題を含むプロジェクトに対する​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

  • 課題レベルのセキュリティLeaving the Site​が設定されている場合、課題を表示する課題レベルのセキュリティ権限。ただし、ユーザーが​「Transition issues (課題の移行)」 プロジェクト権限Leaving the Site​を持っていない場合、応答には移行がリストされません。

この操作では、/rest/api/3/issue/{issueIdOrKey}/transitions エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

expand (展開)

String (文字列)

expand​ を使用して、移行に関する追加情報を応答に含めます。このパラメーターは、各移行の移行画面の項目に関する情報を返す ​transitions.fields​ を受け入れます。画面で非表示になっている項目は返されません。この情報を使用して、[Transition issue](#api-rest-api-3-issue-issueIdOrKey-transitions-post) の ​fields​ および ​update​ 項目にデータを入力します。

Transition Id (移行 ID)

String (文字列)

移行の ID。

Skip Remote Only Condition (リモートのみの条件をスキップ)

Boolean (ブール)

条件が ​[Hide From User Condition (ユーザーに非表示条件)]​ の移行が応答に含まれるかどうか。

false

Include Unavailable Transitions (使用できない移行を含める)

Boolean (ブール)

条件に失敗した移行の詳細が応答に含まれるかどうか。

false

Sort By Ops Bar And Status (操作バーと状況で並び替え)

Boolean (ブール)

移行が ops-bar シーケンス値で並び替えられてからカテゴリ順 (Todo、In Progress (処理中)、Done (完了)) で並び替えられるか、または ops-bar シーケンス値のみで並び替えられるか。

false

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Votes

<jira:get-rest-api3-issue-votes-by-issue-id-or-key>

課題への投票に関する詳細を返します。この操作には、​[Allow users to vote on issues (課題に対する投票をユーザーに許可)]​ オプションが ​[ON]​ になっている必要があります。このオプションは、Jira の [General (一般)] 設定で定義されます。詳細は、 「Configuring Jira application options (Jira アプリケーションオプションの設定)」Leaving the Site​を参照してください。この操作には匿名でアクセスできます。

必要な権限:

  • 課題を含むプロジェクトに対する​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

  • 課題レベルのセキュリティLeaving the Site​が設定されている場合、課題を表示する課題レベルのセキュリティ権限。この操作に必要な権限があり、​「View voters and watchers (投票者とウォッチャーの表示)」​プロジェクト権限はないユーザーは、​voters​ 項目で詳細が返されません。

この操作では、/rest/api/3/issue/{issueIdOrKey}/votes エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Issue Watchers

<jira:get-rest-api3-issue-watchers-by-issue-id-or-key>

課題のウォッチャーを返します。この操作には、​[Allow users to watch issues (課題の監視をユーザーに許可)]​ オプションが ​[ON]​ になっている必要があります。このオプションは、Jira の [General (一般)] 設定で定義されます。詳細は、 「Configuring Jira application options (Jira アプリケーションオプションの設定)」Leaving the Site​を参照してください。この操作には匿名でアクセスできます。

必要な権限:

  • 課題を含むプロジェクトに対する​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

  • 課題レベルのセキュリティLeaving the Site​が設定されている場合、課題を表示する課題レベルのセキュリティ権限。

  • 自分以外のウォッチリストに含まれるユーザーの詳細を表示するには、課題を含むプロジェクトに対する​「View voters and watchers (投票者とウォッチャーの表示)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/issue/{issueIdOrKey}/watchers エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Issue Worklog

<jira:get-rest-api3-issue-worklog-by-issue-id-or-key>

最も古い作業ログ、または特定の日時以降に開始された作業ログから開始する課題の作業ログを返します。Jira でタイムトラッキングを有効にする必要があります。有効にしないと、この操作でエラーが返されます。詳細は、 「Configuring time tracking (タイムトラッキングの設定)」Leaving the Site​を参照してください。この操作には匿名でアクセスできます。

必要な権限:

作業ログは、ユーザーが次の条件を満たす場合にのみ返されます。

  • 課題を含むプロジェクトに対する​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

  • 課題レベルのセキュリティLeaving the Site​が設定されている場合、課題を表示する課題レベルのセキュリティ権限。

  • 作業ログの表示制限がある場合、グループに属しているか、表示が制限されているロールがある。

この操作では、/rest/api/3/issue/{issueIdOrKey}/worklog エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

1048576

Started After (次の後に開始)

Number (数値)

作業ログの開始日時 (ミリ秒単位の UNIX タイムスタンプ)。この日時以降に作業ログが返されます。

expand (展開)

String (文字列)

expand​ を使用して、作業ログに関する追加情報を応答に含めます。このパラメーターは、作業ログのプロパティを返す ​properties​ を受け入れます。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Worklog

<jira:get-rest-api3-issue-worklog-by-issue-id-or-key-id>

作業ログを返します。Jira でタイムトラッキングを有効にする必要があります。有効にしないと、この操作でエラーが返されます。詳細は、 「Configuring time tracking (タイムトラッキングの設定)」Leaving the Site​を参照してください。この操作には匿名でアクセスできます。

必要な権限:

  • 課題を含むプロジェクトに対する​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

  • 課題レベルのセキュリティLeaving the Site​が設定されている場合、課題を表示する課題レベルのセキュリティ権限。

  • 作業ログの表示制限がある場合、グループに属しているか、表示が制限されているロールがある。

この操作では、/rest/api/3/issue/{issueIdOrKey}/worklog/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

id

String (文字列)

作業ログの ID。

x

expand (展開)

String (文字列)

expand​ を使用して、作業ログに関する追加情報を応答に含めます。このパラメーターは、作業ログのプロパティを返す ​properties​ を受け入れます。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Worklog Property Keys

<jira:get-rest-api3-issue-worklog-properties-by-issue-id-or-key-worklog-id>

作業ログのすべてのプロパティのキーを返します。この操作には匿名でアクセスできます。

必要な権限:

  • 課題を含むプロジェクトに対する​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

  • 課題レベルのセキュリティLeaving the Site​が設定されている場合、課題を表示する課題レベルのセキュリティ権限。

  • 作業ログの表示制限がある場合、グループに属しているか、表示が制限されているロールがある。

この操作では、/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

Worklog Id (作業ログ ID)

String (文字列)

作業ログの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Worklog Property

<jira:get-rest-api3-issue-worklog-properties-by-issue-id-or-key-worklog-id-property-key>

作業ログプロパティの値を返します。この操作には匿名でアクセスできます。

必要な権限:

  • 課題を含むプロジェクトに対する​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

  • 課題レベルのセキュリティLeaving the Site​が設定されている場合、課題を表示する課題レベルのセキュリティ権限。

  • 作業ログの表示制限がある場合、グループに属しているか、表示が制限されているロールがある。

この操作では、/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

Worklog Id (作業ログ ID)

String (文字列)

作業ログの ID。

x

Property Key (プロパティキー)

String (文字列)

プロパティのキー。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Issue Security Schemes

<jira:get-rest-api3-issuesecurityschemes>

すべての 課題セキュリティスキームLeaving the Site​を返します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/issuesecurityschemes エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Issue Security Scheme

<jira:get-rest-api3-issuesecurityschemes-by-id>

課題セキュリティスキームとそのセキュリティレベルを返します。

必要な権限:

  • 「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

  • 要求された課題セキュリティスキームを使用するプロジェクトに対する​「Administer Projects (プロジェクトの管理)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/issuesecurityschemes/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

課題セキュリティスキームの ID。[Get issue security schemes](#api-rest-api-3-issuesecurityschemes-get) 操作を使用して、課題セキュリティスキーム ID のリストを取得します。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Issue Security Level Members

<jira:get-rest-api3-issuesecurityschemes-members-by-issue-security-scheme-id>

課題セキュリティレベルメンバーを返します。返されるのは、従来のプロジェクトのコンテキストでの課題セキュリティレベルメンバーのみです。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/issuesecurityschemes/{issueSecuritySchemeId}/members エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Security Scheme Id (課題セキュリティスキーム ID)

Number (数値)

課題セキュリティスキームの ID。[Get issue security schemes](#api-rest-api-3-issuesecurityschemes-get) 操作を使用して、課題セキュリティスキーム ID のリストを取得します。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

Issue Security Level Id (課題セキュリティレベル ID)

Array of Number (数値の配列)

課題セキュリティレベル ID のリスト。複数の課題セキュリティレベルを含めるには、ID をアンパサンドで区切ります: issueSecurityLevelId=10000&issueSecurityLevelId=10001​。

expand (展開)

String (文字列)

expand (展開) を使用して、追加情報を応答に含めます。このパラメーターは、カンマ区切りのリストを受け入れます。expand (展開) には次のオプションがあります。* ​all​: すべての展開可能な情報を返します。 *​field​: 権限が付与されたカスタム項目に関する情報を返します。 *​group​: 権限が付与されたグループに関する情報を返します。 *​projectRole​: 権限が付与されたプロジェクトロールに関する情報を返します。 *​user​: 権限が付与されたユーザーに関する情報を返します。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Issue All Types

<jira:get-rest-api3-issuetype>

すべての課題種別を返します。この操作には匿名でアクセスできます。

必要な権限:

課題種別は次のようにのみ返されます。

  • ユーザーに​「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​がある場合、すべての課題種別が返されます。

  • ユーザーに 1 つ以上のプロジェクトに対する​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​がある場合、ユーザーが参照権限を持つプロジェクトに関連付けられた課題種別が返されます。

この操作では、/rest/api/3/issuetype エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Alternative Issue Types

<jira:get-rest-api3-issuetype-alternatives-by-id>

課題種別の置換に使用できる課題種別のリストを返します。代替課題種別は、同じワークフロースキーム、項目設定スキーム、および画面スキームに割り当てられる種別です。この操作には匿名でアクセスできます。

必要な権限:

なし。

この操作では、/rest/api/3/issuetype/{id}/alternatives エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

課題種別の ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Issue Type

<jira:get-rest-api3-issuetype-by-id>

課題種別を返します。この操作には匿名でアクセスできます。

必要な権限:

課題種別が関連付けられたプロジェクトに対する​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​、または​「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/issuetype/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

課題種別の ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Issue Type Property Keys

<jira:get-rest-api3-issuetype-properties-by-issue-type-id>

課題種別のすべての 課題種別プロパティLeaving the Site​キーを返します。この操作には匿名でアクセスできます。

必要な権限:

  • すべての課題種別のプロパティキーを取得する場合は​「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

  • ユーザーが参照権限を持つプロジェクトに関連付けられた課題種別のプロパティキーを取得する場合は​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/issuetype/{issueTypeId}/properties エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Type Id (課題種別 ID)

String (文字列)

課題種別の ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Issue Type Property

<jira:get-rest-api3-issuetype-properties-by-issue-type-id-property-key>

課題種別プロパティLeaving the Site​のキーと値を返します。この操作には匿名でアクセスできます。

必要な権限:

  • すべての課題種別の詳細を取得する場合は​「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

  • ユーザーが参照権限を持つプロジェクトに関連付けられた課題種別の詳細を取得する場合は​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Type Id (課題種別 ID)

String (文字列)

課題種別の ID。

x

Property Key (プロパティキー)

String (文字列)

プロパティのキー。[Get issue type property keys](#api-rest-api-3-issuetype-issueTypeId-properties-get) を使用して、すべての課題種別プロパティキーのリストを取得します。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get All Issue Type Schemes

<jira:get-rest-api3-issuetypescheme>

課題種別スキームのページ分割されたリストを返します。返されるのは、従来のプロジェクトで使用されている課題種別スキームのみです。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/issuetypescheme エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

id

Array of Number (数値の配列)

課題種別スキーム ID のリスト。複数の ID を含めるには、アンパサンド区切りのリストを指定します。例: id=10000&id=10001​。

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

* Any の配列

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Issue Type Schemes Mapping

<jira:get-rest-api3-issuetypescheme-mapping>

課題種別スキーム項目のページ分割されたリストを返します。返されるのは、従来のプロジェクトで使用されている課題種別スキーム項目のみです。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/issuetypescheme/mapping エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

Issue Type Scheme Id (課題種別スキーム ID)

Array of Number (数値の配列)

課題種別スキーム ID のリスト。複数の ID を含めるには、アンパサンド区切りのリストを指定します。例: issueTypeSchemeId=10000&issueTypeSchemeId=10001​。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Issue Type Scheme For Projects

<jira:get-rest-api3-issuetypescheme-project>

課題種別スキームのページ分割されたリストを返し、課題種別スキームごとにそれを使用するプロジェクトのリストを返します。返されるのは、従来のプロジェクトで使用されている課題種別スキームのみです。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/issuetypescheme/project エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

Project Id (プロジェクト ID)

Array of Number (数値の配列)

プロジェクト ID のリスト。複数のプロジェクト ID を含めるには、アンパサンド区切りのリストを指定します。例: projectId=10000&projectId=10001​。

x

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

* Any の配列

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Issue Type Screen Schemes

<jira:get-rest-api3-issuetypescreenscheme>

課題種別画面スキームのページ分割されたリストを返します。返されるのは、従来のプロジェクトで使用されている課題種別画面スキームのみです。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/issuetypescreenscheme エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

id

Array of Number (数値の配列)

課題種別画面スキーム ID のリスト。複数の ID を含めるには、アンパサンド区切りのリストを指定します。例: id=10000&id=10001​。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Issue Type Screen Scheme Mappings

<jira:get-rest-api3-issuetypescreenscheme-mapping>

課題種別画面スキーム項目のページ分割されたリストを返します。返されるのは、従来のプロジェクトで使用されている課題種別画面スキームのみです。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/issuetypescreenscheme/mapping エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

Issue Type Screen Scheme Id (課題種別画面スキーム ID)

Array of Number (数値の配列)

課題種別画面スキーム ID のリスト。複数の課題種別画面スキームを含めるには、ID をアンパサンドで区切ります: issueTypeScreenSchemeId=10000&issueTypeScreenSchemeId=10001​。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Issue Type Screen Scheme Project Associations

<jira:get-rest-api3-issuetypescreenscheme-project>

課題種別画面スキームのページ分割されたリストを返し、課題種別画面スキームごとにそれを使用するプロジェクトのリストを返します。返されるのは、従来のプロジェクトで使用されている課題種別画面スキームのみです。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/issuetypescreenscheme/project エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

Project Id (プロジェクト ID)

Array of Number (数値の配列)

プロジェクト ID のリスト。複数のプロジェクトを含めるには、ID をアンパサンドで区切ります: projectId=10000&projectId=10001​。

x

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

* Any の配列

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Auto Complete

<jira:get-rest-api3-jql-autocompletedata>

JQL 検索の参照データを返します。これは。[「Advanced searching - fields reference (高度な検索 - 項目参照)」](https://confluence.atlassian.com/x/gwORLQLeaving the Site) および 「Advanced searching - functions reference (高度な検索 - 関数参照)」Leaving the Site​で提供されているドキュメントのダウンロード可能なバージョンであり、JQL で予約されている単語のリストが含まれます。この情報を使用して、JQL クエリのプログラムによる作成、またはカスタムクエリビルダーで構築されたクエリの検証を支援します。この操作には匿名でアクセスできます。

必要な権限:

なし。

この操作では、/rest/api/3/jql/autocompletedata エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Field Auto Complete For Query String

<jira:get-rest-api3-jql-autocompletedata-suggestions>

項目の JQL 検索オートコンプリート候補を返します。候補は、次を指定することで取得できます。

  • fieldName​: 項目のすべての値のリストを取得します。

  • fieldName​ および ​fieldValue​: fieldValue​ 内のテキストを含む値のリストを取得します。

  • fieldName​ および ​predicateName​: 項目のすべての述語値のリストを取得します。

  • fieldName​、​predicateName​、および ​predicateValue​: predicateValue​ 内のテキストを含む述語値のリストを取得します。

この操作には匿名でアクセスできます。

必要な権限:

なし。

この操作では、/rest/api/3/jql/autocompletedata/suggestions エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Name (項目名)

String (文字列)

項目の名前。

Field Value (項目値)

String (文字列)

ユーザーが入力した部分的な項目名。

Predicate Name (述語名)

String (文字列)

候補が生成される CHANGED 演算子述語Leaving the Site​の名前。有効な述語演算子は、​by​、​from​、および ​to​ です。

Predicate Value (述語値)

String (文字列)

ユーザーが入力した部分的な述語項目名。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get All Labels

<jira:get-rest-api3-label>

表示ラベルのページ分割されたリストを返します。この操作では、/rest/api/3/label エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

1000

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get My Permissions

<jira:get-rest-api3-mypermissions>

ユーザーが持つ権限を示す権限のリストを返します。ユーザーの権限の詳細は、グローバル、プロジェクト、または課題コンテキストで取得できます。ユーザーは、次の場合にプロジェクト権限を持っていると報告されます。

  • グローバルコンテキストでは、ユーザーがプロジェクトでのプロジェクト権限を持っている場合。

  • プロジェクト権限が課題データを使用して決定されるプロジェクトでは、ユーザーがプロジェクト内の課題に対する権限の条件を満たしている場合。それ以外では、ユーザーがプロジェクトでのプロジェクト権限を持っている場合。

  • プロジェクト権限が課題データを使用して決定される課題では、ユーザーが課題の権限を持っている場合。それ以外では、ユーザーが課題を含むプロジェクトでのプロジェクト権限を持っている場合。つまり、ユーザーはグローバルコンテキストまたはプロジェクトコンテキストで課題権限 (EDIT\_ISSUES など) を持っていると示されても、一部またはすべての課題に対する権限を持っていない可能性があります。たとえば、報告者に EDIT\_ISSUES 権限がある場合、どのユーザーも報告者になることができるため、ユーザーはグローバルコンテキストまたはプロジェクトコンテキストでこの権限を持っていると表示されます。ただし、照会された課題を報告していないユーザーは、その課題に対する EDIT\_ISSUES 権限がありません。グローバル権限はコンテキストの影響を受けません。

この操作には匿名でアクセスできます。

必要な権限:

なし。

この操作では、/rest/api/3/mypermissions エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Key (プロジェクトキー)

String (文字列)

プロジェクトのキー。​projectId​ が指定されている場合は無視されます。

Project Id (プロジェクト ID)

String (文字列)

プロジェクトの ID。

Issue Key (課題キー)

String (文字列)

課題のキー。​issueId​ が指定されている場合は無視されます。

Issue Id (課題 ID)

String (文字列)

課題の ID。

permissions (権限)

String (文字列)

権限キーのリスト。(必須)。このパラメーターは、カンマ区切りのリストを受け入れます。使用可能なすべての権限のリストを取得するには、[Get all permissions](#api-rest-api-3-permissions-get) を使用します。

Project Uuid (プロジェクト UUID)

String (文字列)

Project Uuid (プロジェクト UUID)

Project Configuration Uuid (プロジェクト設定 UUID)

String (文字列)

Project Configuration Uuid (プロジェクト設定 UUID)

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Preference

<jira:get-rest-api3-mypreferences>

現在のユーザーの設定値を返します。次のキーは非推奨です。

  • jira.user.locale​ ユーザーのロケール。デフォルトではこれは設定されておらず、ユーザーにはインスタンスのロケールが適用されます。

  • jira.user.timezone​ ユーザーのタイムゾーン。デフォルトではこれは設定されておらず、ユーザーにはインスタンスのタイムゾーンが適用されます。代わりにタイムゾーンとロケールを管理するには、ユーザー管理 REST API の Update a user profileLeaving the Site​ を使用します。

必要な権限:

Jira にアクセスするための権限。

この操作では、/rest/api/3/mypreferences エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

key (キー)

String (文字列)

設定のキー。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Locale

<jira:get-rest-api3-mypreferences-locale>

ユーザーのロケールを返します。ユーザーに言語設定がない場合 (デフォルト設定)、またはこのリソースが匿名でアクセスされた場合、Jira によって検出されたブラウザーのロケールが返されます。Jira は、要求の ​Accept-Language​ ヘッダーを使用してブラウザーのロケールを検出します。ただし、これが使用可能な Jira のロケールと一致しない場合、サイトのデフォルトロケールが返されます。この操作には匿名でアクセスできます。

必要な権限:

なし。

この操作では、/rest/api/3/mypreferences/locale エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Current User

<jira:get-rest-api3-myself>

現在のユーザーの詳細を返します。

必要な権限:

Jira にアクセスするための権限。

この操作では、/rest/api/3/myself エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

expand (展開)

String (文字列)

expand​ を使用して、ユーザーに関する追加情報を応答に含めます。このパラメーターは、カンマ区切りのリストを受け入れます。expand (展開) には次のオプションがあります。

  • groups​: ユーザーが属するすべてのグループ (ネストされたグループを含む) を返します。

  • applicationRoles​: ユーザーが割り当てられているアプリケーションロールを返します。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Notification Schemes

<jira:get-rest-api3-notificationscheme>

表示名で並び替えられた、 通知スキームLeaving the Site​のページ分割されたリストを返します。

通知スキームについて

通知スキームは、イベント、およびそのイベントの通知を受信する受信者のリストです。このリストは ​notificationSchemeEvents​ オブジェクト内に含まれ、​events​ と ​notifications​ のペアが含まれます。

  • event​: イベントの種別を識別します。イベントは、 Jira システムイベントLeaving the Site​または カスタムイベントLeaving the Site​のいずれかです。

  • notifications​: 各イベントの通知の 受信者Leaving the Site​を識別します。

    受信者は次のいずれかの種別になります。

    • CurrentAssignee

    • Reporter

    • CurrentUser

    • ProjectLead

    • ComponentLead

    • User​ (​parameter​ はユーザーキー)

    • Group​ (​parameter​ はグループ名)

    • ProjectRole​ (​parameter​ はプロジェクトロール ID)

    • EmailAddress

    • AllWatchers

  • UserCustomField​ (​parameter​ はカスタム項目の ID)

  • GroupCustomField​(​parameter​ はカスタム項目の ID) ​受信者のいないイベントが応答に表示できるようにする必要があります。

必要な権限:

Jira へのアクセス権。ただし、通知スキームを返すには、ユーザーがその通知スキームに関連付けられた 1 つ以上のプロジェクトを管理する権限を持っている必要があります。この操作では、/rest/api/3/notificationscheme エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

expand (展開)

String (文字列)

expand​ を使用して、追加情報を応答に含めます。このパラメーターは、カンマ区切りのリストを受け入れます。expand (展開) には次のオプションがあります。

  • all​: すべての展開可能な情報を返します。

  • field​: イベントを受信するために割り当てられたカスタム項目に関する情報を返します。

  • group​: イベントを受信するために割り当てられたグループに関する情報を返します。

  • notificationSchemeEvents​: イベントの関連付けのリストを返します。このリストは、すべての展開可能な情報に対して返されます。

  • projectRole​: イベントを受信するために割り当てられたプロジェクトロールに関する情報を返します。

  • user​: イベントを受信するために割り当てられたユーザーに関する情報を返します。

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

* Any の配列

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Notification Scheme

<jira:get-rest-api3-notificationscheme-by-id>

通知スキームLeaving the Site​を返します。これには、イベント、およびそのイベントの通知を受信する受信者のリストが含まれます。

必要な権限:

Jira へのアクセス権。ただし、ユーザーがその通知スキームに関連付けられた 1 つ以上のプロジェクトを管理する権限を持っている必要があります。

この操作では、/rest/api/3/notificationscheme/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

通知スキームの ID。[Get notification schemes paginated](#api-rest-api-3-notificationscheme-get) を使用して、通知スキーム ID のリストを取得します。

x

expand (展開)

String (文字列)

expand​ を使用して、追加情報を応答に含めます。このパラメーターは、カンマ区切りのリストを受け入れます。expand (展開) には次のオプションがあります。

  • all​: すべての展開可能な情報を返します。

  • field​: イベントを受信するために割り当てられたカスタム項目に関する情報を返します。

  • group​: イベントを受信するために割り当てられたグループに関する情報を返します。

  • notificationSchemeEvents​: イベントの関連付けのリストを返します。このリストは、すべての展開可能な情報に対して返されます。

  • projectRole​: イベントを受信するために割り当てられたプロジェクトロールに関する情報を返します。

  • user​: イベントを受信するために割り当てられたユーザーに関する情報を返します。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get All Permissions

<jira:get-rest-api3-permissions>

以下を含むすべての権限を返します: * グローバル権限。 *プロジェクト権限。 *プラグインによって追加されたグローバル権限。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/permissions エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get All Permission Schemes

<jira:get-rest-api3-permissionscheme>

すべての権限スキームを返します。

権限スキームと権限付与について

権限スキームは、権限付与のコレクションです。権限付与は ​holder​ と ​permission​ で構成されます。

Holder (所有者) オブジェクト

holder​ オブジェクトには、権限が付与されているユーザーまたはグループに関する情報が含まれます。たとえば、​「Administer projects (プロジェクトの管理)」​権限が​「Teams in space administrators (スペース管理者のチーム)」​というグループに付与されているとします。この場合、種別は ​"type": "group"​ で、パラメーターはグループ名 ​"parameter": "Teams in space administrators"​ です。

holder​ オブジェクトは、次のプロパティで定義されます。

  • type​: ユーザーまたはグループを識別します (以下の種別のリストを参照)。

  • parameter​: このプロパティの値は、​type​ によって異なります。たとえば、​type​ がグループの場合、グループ名を指定する必要があります。次の ​types​ を使用できます。​parameter​ の期待値は括弧内に示されています (一部の ​types​ には ​parameter​ がありません)。

    • anyone​: 匿名ユーザーに付与します。

    • applicationRole​: 指定されたアプリケーション (アプリケーション名) にアクセスできるユーザーに付与します。詳細は、[「Update product access settings (製品アクセス設定の更新)」](https://confluence.atlassian.com/x/3YxjLLeaving the Site) を参照してください。

    • assignee​: 現在課題に割り当てられているユーザーに付与します。

    • group​: 指定されたグループ (グループ名) に付与します。

    • groupCustomField​: 指定されたカスタム項目 (カスタム項目 ID) で選択されたグループのユーザーに付与します。

    • projectLead​: プロジェクトリーダーに付与します。

    • projectRole​: 指定されたプロジェクトロール (プロジェクトロール名) に付与します。

    • reporter​: 課題を報告したユーザーに付与します。 *​sd.customer.portal.only​: Jira Service Desk のみ。顧客にカスタマーポータルへのアクセス権を付与しますが、Jira へのアクセス権は付与されません。詳細は、[「Customizing Jira Service Desk permissions (Jira Service Desk 権限のカスタマイズ)」](https://confluence.atlassian.com/x/24dKLgLeaving the Site) を参照してください。

    • user​: 指定されたユーザー (ユーザー ID - これまでこれはユーザーキーでしたが、廃止されたため、アカウント ID を使用する必要があります) に付与します。

    • userCustomField​: 指定されたカスタム項目 (カスタム項目 ID) で選択されたユーザーに付与します。

組み込み権限

[組み込み Jira 権限](https://confluence.atlassian.com/x/yodKLgLeaving the Site) を以下に示します。アプリケーションでカスタム権限を定義することもできます。詳細は、 プロジェクト権限Leaving the Site​および グローバル権限Leaving the Site​モジュールドキュメントを参照してください。

プロジェクト権限

  • ADMINISTER_PROJECTS

  • BROWSE_PROJECTS

  • MANAGE_SPRINTS_PERMISSION​ (Jira Software のみ)

  • SERVICEDESK_AGENT​ (Jira Service Desk のみ)

  • VIEW_DEV_TOOLS​ (Jira Software のみ)

  • VIEW_READONLY_WORKFLOW

課題権限

  • ASSIGNABLE_USER

  • ASSIGN_ISSUES

  • CLOSE_ISSUES

  • CREATE_ISSUES

  • DELETE_ISSUES

  • EDIT_ISSUES

  • LINK_ISSUES

  • MODIFY_REPORTER

  • MOVE_ISSUES

  • RESOLVE_ISSUES

  • SCHEDULE_ISSUES

  • SET_ISSUE_SECURITY

  • TRANSITION_ISSUES

投票者およびウォッチャー権限

  • MANAGE_WATCHERS

  • VIEW_VOTERS_AND_WATCHERS

コメント権限

  • ADD_COMMENTS

  • DELETE_ALL_COMMENTS

  • DELETE_OWN_COMMENTS

  • EDIT_ALL_COMMENTS

  • EDIT_OWN_COMMENTS

添付ファイル権限

  • CREATE_ATTACHMENTS

  • DELETE_ALL_ATTACHMENTS

  • DELETE_OWN_ATTACHMENTS

タイムトラッキング権限

  • DELETE_ALL_WORKLOGS

  • DELETE_OWN_WORKLOGS

  • EDIT_ALL_WORKLOGS

  • EDIT_OWN_WORKLOGS

  • WORK_ON_ISSUES

必要な権限:

Jira にアクセスするための権限。

この操作では、/rest/api/3/permissionscheme エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

expand (展開)

String (文字列)

expand​ を使用して、追加情報を応答に含めます。このパラメーターは、カンマ区切りのリストを受け入れます。値を指定すると、権限が含まれます。expand (展開) には次のオプションがあります。

  • all​: すべての展開可能な情報を返します。

  • field​: 権限が付与されたカスタム項目に関する情報を返します。

  • group​: 権限が付与されたグループに関する情報を返します。

  • permissions​: 各権限スキームのすべての権限付与を返します。

  • projectRole​: 権限が付与されたプロジェクトロールに関する情報を返します。

  • user​: 権限が付与されたユーザーに関する情報を返します。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Permission Scheme

<jira:get-rest-api3-permissionscheme-by-scheme-id>

権限スキームを返します。

必要な権限:

Jira にアクセスするための権限。

この操作では、/rest/api/3/permissionscheme/{schemeId} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Scheme Id (スキーム ID)

Number (数値)

返す権限スキームの ID。

x

expand (展開)

String (文字列)

expand​ を使用して、追加情報を応答に含めます。このパラメーターは、カンマ区切りのリストを受け入れます。値を指定すると、権限が含まれます。expand (展開) には次のオプションがあります。

  • all​: すべての展開可能な情報を返します。

  • field​: 権限が付与されたカスタム項目に関する情報を返します。

  • group​: 権限が付与されたグループに関する情報を返します。

  • permissions​: 各権限スキームのすべての権限付与を返します。

  • projectRole​: 権限が付与されたプロジェクトロールに関する情報を返します。

  • user​: 権限が付与されたユーザーに関する情報を返します。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Permission Scheme Grants

<jira:get-rest-api3-permissionscheme-permission-by-scheme-id>

権限スキームのすべての権限付与を返します。

必要な権限:

Jira にアクセスするための権限。

この操作では、/rest/api/3/permissionscheme/{schemeId}/permission エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Scheme Id (スキーム ID)

Number (数値)

権限スキームの ID。

x

expand (展開)

String (文字列)

expand​ を使用して、追加情報を応答に含めます。このパラメーターは、カンマ区切りのリストを受け入れます。値を指定すると、権限は常に含まれるます。expand (展開) には次のオプションがあります。

  • permissions​: 各権限スキームのすべての権限付与を返します。

  • user​: 権限が付与されたユーザーに関する情報を返します。

  • group​: 権限が付与されたグループに関する情報を返します。

  • projectRole​: 権限が付与されたプロジェクトロールに関する情報を返します。

  • field​: 権限が付与されたカスタム項目に関する情報を返します。

  • all​: すべての展開可能な情報を返します。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Permission Scheme Grant

<jira:get-rest-api3-permissionscheme-permission-by-scheme-id-permission-id>

権限付与を返します。

必要な権限:

Jira にアクセスするための権限。

この操作では、/rest/api/3/permissionscheme/{schemeId}/permission/{permissionId} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Scheme Id (スキーム ID)

Number (数値)

権限スキームの ID。

x

Permission Id (権限 ID)

Number (数値)

権限付与の ID。

x

expand (展開)

String (文字列)

expand (展開) を使用して、追加情報を応答に含めます。このパラメーターは、カンマ区切りのリストを受け入れます。値を指定すると、権限は常に含まれるます。expand (展開) には次のオプションがあります。

  • all​: すべての展開可能な情報を返します。

  • field​: 権限が付与されたカスタム項目に関する情報を返します。

  • group​: 権限が付与されたグループに関する情報を返します。

  • permissions​: 各権限スキームのすべての権限付与を返します。

  • projectRole​: 権限が付与されたプロジェクトロールに関する情報を返します。

  • user​: 権限が付与されたユーザーに関する情報を返します。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Priorities

<jira:get-rest-api3-priority>

すべての課題プロパティのリストを返します。

必要な権限:

Jira にアクセスするための権限。

この操作では、/rest/api/3/priority エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Priority

<jira:get-rest-api3-priority-by-id>

課題プロパティを返します。

必要な権限:

Jira にアクセスするための権限。

この操作では、/rest/api/3/priority/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

課題プロパティの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get All Project Avatars

<jira:get-rest-api3-project-avatars-by-project-id-or-key>

システムアバターとカスタムアバターでグループ化された、すべてのプロジェクトアバターを返します。この操作には匿名でアクセスできます。

必要な権限:

プロジェクトに対する​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/project/{projectIdOrKey}/avatars エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Id Or Key (プロジェクト ID またはキー)

String (文字列)

プロジェクトの ID または (大文字と小文字を区別する) キー。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Project

<jira:get-rest-api3-project-by-project-id-or-key>

プロジェクトの [プロジェクト詳細](https://confluence.atlassian.com/x/ahLpNwLeaving the Site) を返します。この操作には匿名でアクセスできます。

必要な権限:

プロジェクトに対する​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/project/{projectIdOrKey} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Id Or Key (プロジェクト ID またはキー)

String (文字列)

プロジェクト ID またはプロジェクトキー (大文字と小文字を区別)。

x

expand (展開)

String (文字列)

expand​ を使用して、追加情報を応答に含めます。このパラメーターは、カンマ区切りのリストを受け入れます。プロジェクトの説明、課題種別、およびプロジェクトリーダーは、デフォルトですべての応答に含まれます。expand (展開) には次のオプションがあります。

  • description​: プロジェクトの説明。

  • issueTypes​: プロジェクトに関連付けられた課題種別。

  • lead​: プロジェクトリーダー。 *​projectKeys​ プロジェクトに関連付けられたすべてのプロジェクトキー。

  • issueTypeHierarchy​: プロジェクト課題種別階層。

properties

Array of String (文字列の配列)

プロジェクトに対して返されるプロジェクトプロパティのリスト。このパラメーターは、カンマ区切りのリストを受け入れます。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get All Project Categories

<jira:get-rest-api3-project-category>

すべてのプロジェクトカテゴリを返します。

必要な権限:

Jira にアクセスするための権限。

この操作では、/rest/api/3/projectCategory エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Project Category By Id

<jira:get-rest-api3-project-category-by-id>

プロジェクトカテゴリを返します。

必要な権限:

Jira にアクセスするための権限。

この操作では、/rest/api/3/projectCategory/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

プロジェクトカテゴリの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Project Components Paginated

<jira:get-rest-api3-project-component-by-project-id-or-key>

プロジェクトのすべてのコンポーネントのページ分割されたリストを返します。ページネーションなしでバージョンの完全なリストを取得する場合は、[Get project components](#api-rest-api-3-project-projectIdOrKey-components-get) リソースを参照してください。この操作には匿名でアクセスできます。

必要な権限:

プロジェクトに対する​「Browse Projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/project/{projectIdOrKey}/component エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Id Or Key (プロジェクト ID またはキー)

String (文字列)

プロジェクト ID またはプロジェクトキー (大文字と小文字を区別)。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

Order By (並び替え基準)

Enumeration (列挙)。次のいずれかになります。

  • DESCRIPTION

  • ISSUE_COUNT​

  • LEAD

  • NAME

項目別に結果を並び替えます。

  • description​: コンポーネントの説明で並び替えます。

  • issueCount​: コンポーネントに関連付けられた課題の数で並び替えます。

  • lead​: コンポーネントのプロジェクトリーダーのユーザーキーで並び替えます。

  • name​: コンポーネント名で並び替えます。

query (クエリ)

String (文字列)

リテラル文字列を使用して結果を絞り込みます。​name​ または ​description​ が一致するコンポーネントが返されます (大文字と小文字を区別しない)。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Project Components

<jira:get-rest-api3-project-components-by-project-id-or-key>

プロジェクトのすべてのコンポーネントを返します。ページネーションを使用してコンポーネントの完全なリストを取得する場合は、[Get project components paginated](#api-rest-api-3-project-projectIdOrKey-component-get) リソースを参照してください。この操作には匿名でアクセスできます。

必要な権限:

プロジェクトに対する​「Browse Projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/project/{projectIdOrKey}/components エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Id Or Key (プロジェクト ID またはキー)

String (文字列)

プロジェクト ID またはプロジェクトキー (大文字と小文字を区別)。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Project Email

<jira:get-rest-api3-project-email-by-project-id>

[プロジェクトの送信者メールアドレス](https://confluence.atlassian.com/x/dolKLgLeaving the Site) を返します。

必要な権限:

プロジェクトに対する​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/project/{projectId}/email エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Id (プロジェクト ID)

Number (数値)

プロジェクト ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Hierarchy

<jira:get-rest-api3-project-hierarchy-by-project-id>

次世代プロジェクトの課題種別階層を取得します。プロジェクトの課題種別階層は、次の内容で構成されます。

  • レベル 1 の ​Epic (エピック)​ (省略可能)。

  • レベル 0 の 1 つ以上の課題種別 (​Story (ストーリー)​、​Task (タスク)​、​Bug (バグ)​ など)。課題種別 ​Epic (エピック)​ が定義されている場合、これらの課題種別はエピックのコンテンツを分類するために使用されます。

  • レベル -1 の ​Subtask (サブタスク)​ (省略可能)。この課題種別では、レベル 0 の課題種別をコンポーネントに分類できます。レベル -1 の課題種別に基づく課題には、親の課題が必要です。

必要な権限:

プロジェクトに対する​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/project/{projectId}/hierarchy エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Id (プロジェクト ID)

Number (数値)

プロジェクトの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Project Issue Security Scheme

<jira:get-rest-api3-project-issuesecuritylevelscheme-by-project-key-or-id>

プロジェクトに関連付けられた 課題セキュリティスキームLeaving the Site​を返します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​または​「Administer Projects (プロジェクトの管理)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/project/{projectKeyOrId}/issuesecuritylevelscheme エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Key Or Id (プロジェクトキーまたは ID)

String (文字列)

プロジェクト ID またはプロジェクトキー (大文字と小文字を区別)。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Notification Scheme For Project

<jira:get-rest-api3-project-notificationscheme-by-project-key-or-id>

プロジェクトに関連付けられた 通知スキームLeaving the Site​を返します。通知スキームについての詳細は、[Get notification scheme](#api-rest-api-3-notificationscheme-id-get) を参照してください。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​または​「Administer Projects (プロジェクトの管理)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/project/{projectKeyOrId}/notificationscheme エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Key Or Id (プロジェクトキーまたは ID)

String (文字列)

プロジェクト ID またはプロジェクトキー (大文字と小文字を区別)。

x

expand (展開)

String (文字列)

expand​ を使用して、追加情報を応答に含めます。このパラメーターは、カンマ区切りのリストを受け入れます。expand (展開) には次のオプションがあります。

  • all​: すべての展開可能な情報を返します。

  • field​: イベントを受信するために割り当てられたカスタム項目に関する情報を返します。

  • group​: イベントを受信するために割り当てられたグループに関する情報を返します。

  • notificationSchemeEvents​: イベントの関連付けのリストを返します。このリストは、すべての展開可能な情報に対して返されます。

  • projectRole​: イベントを受信するために割り当てられたプロジェクトロールに関する情報を返します。

  • user​: イベントを受信するために割り当てられたユーザーに関する情報を返します。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Assigned Permission Scheme

<jira:get-rest-api3-project-permissionscheme-by-project-key-or-id>

プロジェクトに関連付けられた 権限スキームLeaving the Site​を取得します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​または​「Administer Projects (プロジェクトの管理)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/project/{projectKeyOrId}/permissionscheme エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Key Or Id (プロジェクトキーまたは ID)

String (文字列)

プロジェクト ID またはプロジェクトキー (大文字と小文字を区別)。

x

expand (展開)

String (文字列)

expand​ を使用して、追加情報を応答に含めます。このパラメーターは、カンマ区切りのリストを受け入れます。値を指定すると、権限が含まれます。expand (展開) には次のオプションがあります。

  • all​: すべての展開可能な情報を返します。

  • field​: 権限が付与されたカスタム項目に関する情報を返します。

  • group​: 権限が付与されたグループに関する情報を返します。

  • permissions​: 各権限スキームのすべての権限付与を返します。

  • projectRole​: 権限が付与されたプロジェクトロールに関する情報を返します。

  • user​: 権限が付与されたユーザーに関する情報を返します。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Project Property Keys

<jira:get-rest-api3-project-properties-by-project-id-or-key>

プロジェクトのすべての プロジェクトプロパティLeaving the Site​キーを返します。この操作には匿名でアクセスできます。

必要な権限:

プロジェクトに対する​「Browse Projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/project/{projectIdOrKey}/properties エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Id Or Key (プロジェクト ID またはキー)

String (文字列)

プロジェクト ID またはプロジェクトキー (大文字と小文字を区別)。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Project Property

<jira:get-rest-api3-project-properties-by-project-id-or-key-property-key>

[プロジェクトプロパティ](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-propertiesLeaving the Site) の値を返します。この操作には匿名でアクセスできます。

必要な権限:

プロパティを含むプロジェクトに対する​「Browse Projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/project/{projectIdOrKey}/properties/{propertyKey} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Id Or Key (プロジェクト ID またはキー)

String (文字列)

プロジェクト ID またはプロジェクトキー (大文字と小文字を区別)。

x

Property Key (プロパティキー)

String (文字列)

プロジェクトプロパティキー。[Get project property keys](#api-rest-api-3-project-projectIdOrKey-properties-get) を使用して、すべてのプロジェクトプロパティキーのリストを取得します。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Project Roles

<jira:get-rest-api3-project-role-by-project-id-or-key>

プロジェクトの プロジェクトロールLeaving the Site​のリストを返し、各ロールの名前と自己 URL を返します。すべてのプロジェクトロールは、Jira Cloud のすべてのプロジェクトと共有されます。詳細は、[Get all project roles](#api-rest-api-3-role-get) を参照してください。この操作には匿名でアクセスできます。

必要な権限:

サイトのプロジェクトに対する​「Administer Projects (プロジェクトの管理)」 プロジェクト権限Leaving the Site​、または​「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/project/{projectIdOrKey}/role エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Id Or Key (プロジェクト ID またはキー)

String (文字列)

プロジェクト ID またはプロジェクトキー (大文字と小文字を区別)。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Project Role

<jira:get-rest-api3-project-role-by-project-id-or-key-id>

プロジェクトロールの詳細とプロジェクトに関連付けられたアクターを返します。アクターのリストは表示名で並び替えられます。グループメンバーシップに基づいてユーザーがロールに属しているかどうかを確認するには、​groups​ 展開パラメーターを選択した状態で [Get user](#api-rest-api-3-user-get) を使用します。次に、ユーザーキーとグループがプロジェクトに返されたアクターと一致するかどうかを確認します。この操作には匿名でアクセスできます。

必要な権限:

プロジェクトに対する​「Administer Projects (プロジェクトの管理)」 プロジェクト権限Leaving the Site​、または​「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/project/{projectIdOrKey}/role/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Id Or Key (プロジェクト ID またはキー)

String (文字列)

プロジェクト ID またはプロジェクトキー (大文字と小文字を区別)。

x

id

Number (数値)

プロジェクトロールの ID。[Get all project roles](#api-rest-api-3-role-get) を使用して、プロジェクトロール ID のリストを取得します。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Project Role Details

<jira:get-rest-api3-project-roledetails-by-project-id-or-key>

すべての プロジェクトロールLeaving the Site​と各ロールの詳細を返します。プロジェクトロールのリストはすべてのプロジェクトに共通です。この操作には匿名でアクセスできます。

必要な権限:

プロジェクトに対する​「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​または​「Administer Projects (プロジェクトの管理)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/project/{projectIdOrKey}/roledetails エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Id Or Key (プロジェクト ID またはキー)

String (文字列)

プロジェクト ID またはプロジェクトキー (大文字と小文字を区別)。

x

Current Member (現在のメンバー)

Boolean (ブール)

ユーザーが割り当てられているロールのみを含めるようにロールを絞り込むかどうか。

false

Exclude Connect Addons (Connect アドオンを除外)

Boolean (ブール)

Exclude Connect Addons (Connect アドオンを除外)

false

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Search Projects

<jira:get-rest-api3-project-search>

ユーザーに表示されるプロジェクトのページ分割されたリストを返します。この操作には匿名でアクセスできます。

必要な権限:

プロジェクトは、ユーザーが次のいずれかを持っている場合にのみ返されます。

この操作では、/rest/api/3/project/search エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

Order By (並び替え基準)

Enumeration (列挙)。次のいずれかになります。

  • CATEGORY

  • KEY

  • NAME

  • OWNER

  • ISSUE_COUNT​

  • LAST_ISSUE_UPDATED_DATE​

  • ARCHIVED_DATE​

  • DELETED_DATE

項目別に結果を並び替えます。

  • category​: プロジェクトカテゴリで並び替えます。カテゴリ ID の完全なリストは、[Get all project categories](#api-rest-api-3-projectCategory-get) を使用して取得できます。

  • issueCount​: 各プロジェクトの課題の総数で並び替えます。

  • key​: プロジェクトキーで並び替えます。

  • lastIssueUpdatedTime​: 課題の最終更新時刻で並び替えます。

  • name​: プロジェクト名で並び替えます。

  • owner​: プロジェクトリーダーで並び替えます。

  • archivedDate​: 実験的。プロジェクトのアーカイブ日で並び替えます。

  • deletedDate​: 実験的。プロジェクトの削除日で並び替えます。

KEY

query (クエリ)

String (文字列)

リテラル文字列を使用して結果を絞り込みます。​key​ または ​name​ が一致するプロジェクトが返されます (大文字と小文字を区別しない)。

Type Key (タイプキー)

String (文字列)

[プロジェクトタイプ](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-ProductfeaturesandprojecttypesLeaving the Site) で結果を並び替えます。このパラメーターは、カンマ区切りのリストを受け入れます。有効な値は ​business​、​service_desk​、​software​ です。

Category Id (カテゴリ ID)

Number (数値)

プロジェクトのカテゴリの ID。カテゴリ ID の完全なリストは、[Get all project categories](#api-rest-api-3-projectCategory-get) 操作を使用して取得できます。

action (アクション)

Enumeration (列挙)。次のいずれかになります。

  • VIEW

  • BROWSE

  • EDIT

ユーザーが次を実行できるプロジェクトで結果を絞り込みます。

  • プロジェクトの ​view​。つまり、ユーザーは次のいずれかの権限を持っています。

  • プロジェクトに対する​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

  • プロジェクトに対する​「Administer Projects (プロジェクトの管理)」 プロジェクト権限Leaving the Site​。

  • 「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

  • プロジェクトの ​browse​。つまり、ユーザーはプロジェクトの​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​を持っています。

  • プロジェクトの ​edit​。つまり、ユーザーは次のいずれかの権限を持っています。

VIEW

expand (展開)

String (文字列)

expand​ を使用して、追加情報を応答に含めます。このパラメーターは、カンマ区切りのリストを受け入れます。expand (展開) には次のオプションがあります。

  • description​: プロジェクトの説明を返します。

  • projectKeys​: プロジェクトに関連付けられたすべてのプロジェクトキーを返します。

  • lead​: プロジェクトリーダーに関する情報を返します。

  • issueTypes​: プロジェクトに関連付けられたすべての課題種別を返します。

  • url​: プロジェクトに関連付けられた URL を返します。

  • insight​: 実験的。プロジェクトの課題総数と課題の最終更新時刻のインサイト詳細を返します。

status (状況)

Array of Enumeration (列挙の配列)。次のいずれかになります。

  • LIVE

  • ARCHIVED

  • DELETED

実験的。プロジェクトの状況で結果を絞り込みます。

  • live​: ライブプロジェクトを検索します。

  • archived​: アーカイブされたプロジェクトを検索します。

  • deleted​: 削除されたプロジェクトを検索してから、ごみ箱内でそれらを検索します。

properties

Array of String (文字列の配列)

実験的。プロジェクトに対して返されるプロジェクトプロパティのリスト。このパラメーターは、カンマ区切りのリストを受け入れます。

Property Query (プロパティクエリ)

String (文字列)

実験的。検索プロパティに使用されるクエリ文字列。JSON オブジェクトを使用してクエリ文字列を指定することはできません。たとえば、​{"something":{"nested":1,"other":2}}​ から ​nested​ の値を検索するには、​[thepropertykey].something.nested=1​ を使用します。propertyQuery キーにドット (.) または等号 (=) 文字が含まれる場合に検索できるように、propertyQuery キーは角括弧で囲まれています。

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

* Any の配列

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Security Levels For Project

<jira:get-rest-api3-project-securitylevel-by-project-key-or-id>

ユーザーがアクセスできるプロジェクトのすべての 課題セキュリティLeaving the Site​レベルを返します。この操作には匿名でアクセスできます。

必要な権限:

プロジェクトに対する​「Browse Projects (プロジェクトの参照)」 グローバル権限Leaving the Site​。ただし、課題セキュリティレベルは、認証済みユーザーがプロジェクトに対する​「Set Issue Security (課題セキュリティの設定)」 グローバル権限Leaving the Site​を持っている場合にのみ返されます。

この操作では、/rest/api/3/project/{projectKeyOrId}/securitylevel エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Key Or Id (プロジェクトキーまたは ID)

String (文字列)

プロジェクト ID またはプロジェクトキー (大文字と小文字を区別)。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get All Statuses

<jira:get-rest-api3-project-statuses-by-project-id-or-key>

プロジェクトの有効な状況を返します。各プロジェクトに有効な課題種別セットがあり、各課題種別に有効な状況セットがある場合、状況は課題種別ごとにグループ化されます。この操作には匿名でアクセスできます。

必要な権限:

プロジェクトに対する​「Browse Projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/project/{projectIdOrKey}/statuses エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Id Or Key (プロジェクト ID またはキー)

String (文字列)

プロジェクト ID またはプロジェクトキー (大文字と小文字を区別)。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get All Project Types

<jira:get-rest-api3-project-type>

インスタンスの各タイプに有効なライセンスがあるかどうかに関係なく、すべての プロジェクトタイプLeaving the Site​を返します。この操作には匿名でアクセスできます。

必要な権限:

なし。

この操作では、/rest/api/3/project/type エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get All Accessible Project Types

<jira:get-rest-api3-project-type-accessible>

有効なライセンスがあるすべての プロジェクトタイプLeaving the Site​を返します。

この操作では、/rest/api/3/project/type/accessible エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Accessible Project Type By Key

<jira:get-rest-api3-project-type-accessible-by-project-type-key>

ユーザーがアクセスできる プロジェクトタイプLeaving the Site​を返します。

必要な権限:

Jira にアクセスするための権限。

この操作では、/rest/api/3/project/type/{projectTypeKey}/accessible エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

プロジェクトタイプキー

Enumeration (列挙)。次のいずれかになります。

  • SOFTWARE

  • SERVICE_DESK​

  • BUSINESS

プロジェクトタイプのキー。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Project Type By Key

<jira:get-rest-api3-project-type-by-project-type-key>

[プロジェクトタイプ](https://confluence.atlassian.com/x/Var1NwLeaving the Site) を返します。この操作には匿名でアクセスできます。

必要な権限:

なし。

この操作では、/rest/api/3/project/type/{projectTypeKey} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

プロジェクトタイプキー

Enumeration (列挙)。次のいずれかになります。

  • SOFTWARE

  • SERVICE_DESK​

  • BUSINESS

プロジェクトタイプのキー。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Project Versions Paginated

<jira:get-rest-api3-project-version-by-project-id-or-key>

プロジェクトのすべてのバージョンのページ分割されたリストを返します。ページネーションなしでバージョンの完全なリストを取得する場合は、[Get project versions](#api-rest-api-3-project-projectIdOrKey-versions-get) リソースを参照してください。この操作には匿名でアクセスできます。

必要な権限:

プロジェクトに対する​「Browse Projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/project/{projectIdOrKey}/version エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Id Or Key (プロジェクト ID またはキー)

String (文字列)

プロジェクト ID またはプロジェクトキー (大文字と小文字を区別)。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

Order By (並び替え基準)

Enumeration (列挙)。次のいずれかになります。

  • DESCRIPTION

  • NAME

  • RELEASE_DATE​

  • SEQUENCE

  • START_DATE

項目別に結果を並び替えます。

  • description​: バージョンの説明で並び替えます。

  • name​: バージョン名で並び替えます。

  • releaseDate​: リリース日の古い日付順に並び替えます。リリース日のないバージョンは最後にリストされます。

  • sequence​: ユーザーインターフェースに表示される順序で並び替えます。

  • startDate​: 開始日の古い日付順に並び替えます。開始日のないバージョンは最後にリストされます。

query (クエリ)

String (文字列)

リテラル文字列を使用して結果を絞り込みます。​name​ または ​description​ が一致するバージョンが返されます (大文字と小文字を区別しない)。

status (状況)

String (文字列)

バージョンの状況で結果を絞り込むために使用される状況値のリスト。このパラメーターは、カンマ区切りのリストを受け入れます。状況値は ​released​、​unreleased​、​archived​ です。

expand (展開)

String (文字列)

expand​ を使用して、追加情報を応答に含めます。このパラメーターは、カンマ区切りのリストを受け入れます。expand (展開) には次のオプションがあります。

  • issuesstatus​: 各バージョンの各状況カテゴリの課題数を返します。

  • operations​: 指定されたバージョンで実行できるアクションを返します。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Project Versions

<jira:get-rest-api3-project-versions-by-project-id-or-key>

プロジェクトのすべてのバージョンを返します。応答はページ分割されません。ページネーションを使用してプロジェクトのバージョンを取得する場合は、[Get project versions paginated](#api-rest-api-3-project-projectIdOrKey-version-get) を参照してください。この操作には匿名でアクセスできます。

必要な権限:

プロジェクトに対する​「Browse Projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/project/{projectIdOrKey}/versions エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Id Or Key (プロジェクト ID またはキー)

String (文字列)

プロジェクト ID またはプロジェクトキー (大文字と小文字を区別)。

x

expand (展開)

String (文字列)

expand​ を使用して、追加情報を応答に含めます。このパラメーターは、そのバージョンで実行できるアクションを返す ​operations​ を受け入れます。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Validate Project Key

<jira:get-rest-api3-projectvalidate-key>

キーが有効な文字列であり使用中でないことを確認することで、プロジェクトキーを検証します。

必要な権限:

なし。

この操作では、/rest/api/3/projectvalidate/key エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

key (キー)

String (文字列)

プロジェクトキー。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Valid Project Key

<jira:get-rest-api3-projectvalidate-valid-project-key>

プロジェクトキーを検証します。キーが無効または使用中の場合、プロジェクトキーの有効かつランダムな文字列を生成します。

必要な権限:

なし。

この操作では、/rest/api/3/projectvalidate/validProjectKey エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

key (キー)

String (文字列)

プロジェクトキー。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Valid Project Name

<jira:get-rest-api3-projectvalidate-valid-project-name>

プロジェクト名が使用中でないことを確認します。名前が使用中でない場合、渡した文字列が返されます。名前が使用中の場合、この操作では、指定された名前に基づいて (通常は連番を追加して) 有効なプロジェクト名が生成されます。有効なプロジェクト名を生成できない場合、404 応答が返されます。

必要な権限:

なし。

この操作では、/rest/api/3/projectvalidate/validProjectName エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

name (名前)

String (文字列)

プロジェクト名。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Resolutions

<jira:get-rest-api3-resolution>

すべての課題解決値のリストを返します。

必要な権限:

Jira にアクセスするための権限。

この操作では、/rest/api/3/resolution エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Resolution

<jira:get-rest-api3-resolution-by-id>

課題解決値を返します。

必要な権限:

Jira にアクセスするための権限。

この操作では、/rest/api/3/resolution/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

課題解決値の ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get All Project Roles

<jira:get-rest-api3-role>

プロジェクトロールの詳細とデフォルトアクターを含むすべてのプロジェクトロールのリストを取得します。

プロジェクトロールについて

プロジェクトロールLeaving the Site​を使用すると、ユーザーとグループをプロジェクトに柔軟に関連付けることができます。Jira Cloud では、プロジェクトロールのリストはすべてのプロジェクトとグローバルに共有されますが、各プロジェクトには異なるアクターセットが関連付けられている可能性があります (すべての Jira アプリケーションで同じメンバーシップを使用するグループとは異なります)。プロジェクトロールは、[権限スキーム](#api-rest-api-3-permissionscheme-get)、[メール通知スキーム](#api-rest-api-3-notificationscheme-get)、[課題のセキュリティレベル](#api-rest-api-3-issuesecurityschemes-get)、[コメントの表示](#api-rest-api-3-comment-list-post)、ワークフロー条件で使用されます。

メンバーとアクター

Jira REST API では、プロジェクトロールのメンバーは​アクター​と呼ばれます。​アクター​は、プロジェクトロールに関連付けられたグループまたはユーザーです。アクターは、プロジェクトロールの デフォルトメンバーLeaving the Site​として設定するか、プロジェクトレベルで設定できます。

  • デフォルトアクター: 新しく作成されるすべてのプロジェクトのプロジェクトロールに割り当てられるユーザーとグループ。デフォルトアクターは、後で必要に応じてプロジェクトレベルで削除できます。

  • アクター: プロジェクトのプロジェクトロールに関連付けられるユーザーとグループ。デフォルトアクターとは異なる場合があります。これにより、ユーザーを異なるプロジェクトの異なるロールに割り当てることができます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/role エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Project Role Actors For Role

<jira:get-rest-api3-role-actors-by-id>

プロジェクトロールの [デフォルトアクター](#api-rest-api-3-resolution-get) を返します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/role/{id}/actors エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

プロジェクトロールの ID。[Get all project roles](#api-rest-api-3-role-get) を使用して、プロジェクトロール ID のリストを取得します。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Project Role By Id

<jira:get-rest-api3-role-by-id>

プロジェクトロールの詳細と、そのロールに関連付けられたデフォルトアクターを取得します。デフォルトアクターのリストは表示名で並び替えられます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/role/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

プロジェクトロールの ID。[Get all project roles](#api-rest-api-3-role-get) を使用して、プロジェクトロール ID のリストを取得します。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Screens

<jira:get-rest-api3-screens>

すべての画面または 1 つ以上の画面 ID で指定された画面のページ分割されたリストを返します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/screens エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

100

id

Array of Number (数値の配列)

画面 ID のリスト。複数の ID を含めるには、アンパサンド区切りのリストを指定します。例: id=10000&id=10001​。

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

* Any の配列

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Available Screen Fields

<jira:get-rest-api3-screens-available-fields-by-screen-id>

画面のタブに追加できる項目を返します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/screens/{screenId}/availableFields エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Screen Id (画面 ID)

Number (数値)

画面の ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get All Screen Tabs

<jira:get-rest-api3-screens-tabs-by-screen-id>

画面のタブのリストを返します。

必要な権限:

  • 「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

  • 「Administer projects (プロジェクトの管理)」 プロジェクト権限Leaving the Site​。画面が画面スキームと課題種別画面スキームを介してプロジェクトに関連付けられている場合に、プロジェクトキーを指定するときに必要です。

この操作では、/rest/api/3/screens/{screenId}/tabs エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Screen Id (画面 ID)

Number (数値)

画面の ID。

x

Project Key (プロジェクトキー)

String (文字列)

プロジェクトのキー。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get All Screen Tab Fields

<jira:get-rest-api3-screens-tabs-fields-by-screen-id-tab-id>

画面タブのすべての項目を返します。

必要な権限:

  • 「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

  • 「Administer projects (プロジェクトの管理)」 プロジェクト権限Leaving the Site​。画面が画面スキームと課題種別画面スキームを介してプロジェクトに関連付けられている場合に、プロジェクトキーを指定するときに必要です。

この操作では、/rest/api/3/screens/{screenId}/tabs/{tabId}/fields エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Screen Id (画面 ID)

Number (数値)

画面の ID。

x

Tab Id (タブ ID)

Number (数値)

画面タブの ID。

x

Project Key (プロジェクトキー)

String (文字列)

プロジェクトのキー。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Screen Schemes

<jira:get-rest-api3-screenscheme>

画面スキームのページ分割されたリストを返します。従来のプロジェクトで使用された画面スキームのみが返されます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/screenscheme エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

25

id

Array of Number (数値の配列)

画面スキーム ID のリスト。複数の ID を含めるには、アンパサンド区切りのリストを指定します。例: id=10000&id=10001​。

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

* Any の配列

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

(非推奨) Search For Issues Using JQL

<jira:get-rest-api3-search>

JQLLeaving the Site​ を使用して課題を検索します。JQL クエリ式が大きすぎてクエリパラメーターとしてエンコードできない場合、このリソースの [POST](#api-rest-api-3-search-post) バージョンを使用します。この操作には匿名でアクセスできます。

必要な権限:

課題は、ユーザーが次の条件を満たす場合に応答に含まれます。

この操作では、/rest/api/3/search エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

jql (JQL)

String (文字列)

検索を定義する JQLLeaving the Site​。注意:

  • JQL 式を指定しない場合、すべての課題が返されます。

  • username​ と ​userkey​ はプライバシー上の理由で検索語として使用できません。代わりに ​accountId​ を使用します。

  • ユーザーがユーザープロファイルでメールアドレスを非表示にしている場合、メールアドレスの部分一致ではそのユーザーは検索されません。完全一致が必要です。

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。ページサイズを管理するため、多数の項目が要求された場合に、各ページで返される項目数が少なくなることがあります。各ページで返される項目数が最も多くなるのは、​id​ または ​key​ が要求された場合のみです。

50

Validate Query (クエリの検証)

Enumeration (列挙)。次のいずれかになります。

  • STRICT

  • WARN

  • NONE

  • TRUE

  • FALSE

JQL クエリを検証して検証結果を処理する方法を決定します。サポートされている値は、次のとおりです。

  • strict​: エラーが見つかった場合、400 応答コードとすべてのエラー (および警告) のリストを返します。

  • warn​: すべてのエラーを警告として返します。

  • none​: 検証は実行されません。

  • true ​非推奨​ ​strict​ の従来のシノニム。

  • false ​非推奨​ ​warn​ の従来のシノニム。注意: JQL の形式が正しくない場合、​validateQuery​ 値にかかわらず 400 応答コードが返されます。

STRICT

fields

Array of String (文字列の配列)

課題ごとに返す項目のリスト。これを使用して項目のサブセットを取得します。このパラメーターは、カンマ区切りのリストを受け入れます。expand (展開) には次のオプションがあります。

  • *all​: すべての項目を返します。

  • *navigable​: ナビゲート可能な項目を返します。

  • 任意の課題項目: 先頭にマイナス付けることで除外します。

例:

  • summary,comment​: 概要項目とコメント項目のみを返します。

  • -description​: 説明を除くすべてのナビゲート可能 (デフォルト) な項目を返します。

  • *all,-comment​: コメントを除くすべての項目を返します。

このパラメーターは複数回指定できます。例: fields=field1,field2&fields=field3​。注意: デフォルトでは、すべてのナビゲート可能な項目が返されます。これは、デフォルトですべての項目が返される [GET issue](#api-rest-api-3-issue-issueIdOrKey-get) とは異なります。

expand (展開)

String (文字列)

expand​ を使用すると、課題に関する追加の情報が応答に含まれます。このパラメーターは、カンマ区切りのリストを受け入れます。expand (展開) には次のオプションがあります。

  • renderedFields​: HTML 形式で表示される項目値を返します。

  • names​: 各項目の表示名を返します。

  • schema​: 項目のデータ型を表すスキーマを返します。

  • transitions​: 課題のすべての考えられる移行を返します。

  • operations​: この課題に対するすべての可能な操作を返します。

  • editmeta​: 各項目の編集方法に関する情報を返します。

  • changelog​: 新しい日付順に並び替えられた、最近の課題への更新のリストを返します。

  • versionedRepresentations​: fields​ の代わりに ​versionedRepresentations​ (項目の値の各バージョンを含む JSON 配列) と、最新バージョンを表す最も大きな数字の項目を返します。

properties

Array of String (文字列の配列)

結果に含める課題プロパティの課題プロパティキーのリスト。このパラメーターは、カンマ区切りのリストを受け入れます。アンパサンド区切りリストを使用して複数のプロパティを指定することもできます。例: properties=prop1,prop2&properties=prop3​。最大 5 個の課題プロパティキーを指定できます。

Fields By Keys (キー別の項目)

Boolean (ブール)

(ID ではなく) キーで項目を参照します。

false

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Search For Issues Using JQL (ページ分割)

<jira:get-rest-api3-search-paginated>

JQLLeaving the Site​ を使用して課題を検索します。JQL クエリ式が大きすぎてクエリパラメーターとしてエンコードできない場合、このリソースの POST バージョンを使用します。この操作には匿名でアクセスできます。 この操作では、​/rest/api/3/search​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

jql (JQL)

String (文字列)

検索を定義する JQLLeaving the Site​。

* JQL 式を指定しない場合、すべての課題が返されます。

* username​ と ​userkey​ はプライバシー上の理由で検索語として使用できません。代わりに ​accountId​ を使用します。

* ユーザーがユーザープロファイルでメールアドレスを非表示にしている場合、メールアドレスの部分一致ではそのユーザーは検索されません。完全一致が必要です。

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。ページサイズを管理するため、多数の項目が要求された場合に、各ページで返される項目数が少なくなることがあります。​id​ または ​key​ を要求して、ページごとに多数の項目を返します。

50

Validate Query (クエリの検証)

Enumeration (列挙)。次のいずれかになります。

  • STRICT

  • WARN

  • NONE

  • TRUE

  • FALSE

JQL クエリを検証して検証結果を処理する方法を決定します。JQL の形式が正しくない場合、​validateQuery​ 値にかかわらず 400 応答コードが返されます。

サポートされる値:

* strict​

400 応答コードとすべてのエラーおよび警告のリストを返します。

* warn​

すべてのエラーを警告として返します。

* none​

検証は実行されません。

* true​

非推奨​ ​strict​ の従来のシノニム。

* false​

非推奨​ ​warn​ の従来のシノニム。

STRICT

fields

Array of String (文字列の配列)

各課題に対して返される項目のリスト。これを使用して、項目のサブセットを取得します。このパラメーターは、カンマ区切りのリストを受け入れます。デフォルトでは、すべてのナビゲート可能な項目が返されます。これは、デフォルトですべての項目が返される GET issue とは異なります。

expand (展開) には次のオプションがあります。

* *all​

すべての項目を返します。

* *navigable​

ナビゲート可能な項目を返します。

* 任意の課題項目: 先頭にマイナス付けることで除外します。

例:

* summary,comment​

概要項目とコメント項目のみを返します。

* -description​

説明を除くすべてのナビゲート可能 (デフォルト) な項目を返します。

* *all,-comment​

コメントを除くすべての項目を返します。このパラメーターは複数回指定できます。例: fields=field1,field2&fields=field3​。

expand (展開)

String (文字列)

このパラメーターを使用すると、課題に関する追加の情報が応答に含まれます。このパラメーターは、カンマ区切りのリストを受け入れます。

expand (展開) には次のオプションがあります。

* renderedFields​

HTML 形式で表示される項目値を返します。

* names​

各項目の表示名を返します。

* schema​

項目のデータ型を表すスキーマを返します。

* transitions​

課題のすべての考えられる移行を返します。

* operations​

この課題に対するすべての可能な操作を返します。

* editmeta​

各項目の編集方法に関する情報を返します。

* changelog​

新しい日付順に並び替えられた、最近の課題への更新のリストを返します。

* versionedRepresentations​

versionedRepresentations​ (項目の値の各バージョンを含む JSON 配列) と、最新バージョンを表す最も大きな数字の項目を返します。

properties

Array of String (文字列の配列)

結果に含める課題プロパティの課題プロパティキーのリスト。このパラメーターは、カンマ区切りのリストを受け入れます。アンパサンド区切りリストを使用して複数のプロパティを指定することもできます。例: properties=prop1,prop2&properties=prop3​。最大 5 個の課題プロパティキーを指定できます。

Fields By Keys (キー別の項目)

Boolean (ブール)

(ID ではなく) キーで項目を参照します。

false

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

応答がタイムアウトするまで Mule が応答の完了を待機する時間。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Issue Security Level

<jira:get-rest-api3-securitylevel-by-id>

課題セキュリティレベルの詳細を返します。[Get issue security scheme](#api-rest-api-3-issuesecurityschemes-id-get) を使用して、課題セキュリティスキームに関連付けられた課題セキュリティレベルの ID を取得します。この操作には匿名でアクセスできます。

必要な権限:

なし。

この操作では、/rest/api/3/securitylevel/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

課題セキュリティレベルの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Server Info

<jira:get-rest-api3-server-info>

Jira インスタンスに関する情報を返します。この操作には匿名でアクセスできます。

必要な権限:

なし。

この操作では、/rest/api/3/serverInfo エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Issue Navigator Default Columns

<jira:get-rest-api3-settings-columns>

デフォルトの課題ナビゲーター列を返します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/settings/columns エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Statuses

<jira:get-rest-api3-status>

ワークフローに関連付けられたすべての状況のリストを返します。この操作には匿名でアクセスできます。

必要な権限:

なし。

この操作では、/rest/api/3/status エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Status

<jira:get-rest-api3-status-by-id-or-name>

状況を返します。返されるワークフローには状況が関連付けられています。名前が複数の状況で使用されている場合、最初に見つかった状況のみが返されます。このため、状況をその ID で識別することをお勧めします。この操作には匿名でアクセスできます。

必要な権限:

なし。

この操作では、/rest/api/3/status/{idOrName} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Id Or Name (ID または名前)

String (文字列)

状況の ID または名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Status Categories

<jira:get-rest-api3-statuscategory>

すべての状況カテゴリのリストを返します。

必要な権限:

Jira にアクセスするための権限。

この操作では、/rest/api/3/statuscategory エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Status Category

<jira:get-rest-api3-statuscategory-by-id-or-key>

状況カテゴリを返します。状況カテゴリでは、[状況](#api-rest-api-3-status-idOrName-get) を分類するためのメカニズムが提供されます。

必要な権限:

Jira にアクセスするための権限。

この操作では、/rest/api/3/statuscategory/{idOrKey} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Id Or Key (ID またはキー)

String (文字列)

状況カテゴリの ID またはキー。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Task

<jira:get-rest-api3-task-by-task-id>

[実行時間が長い非同期タスク](#async) の状況を返します。タスクが終了すると、この操作ではタスクに適用される JSON blob が返されます。詳細は、タスクを作成した操作のドキュメントを参照してください。タスクの詳細は永続的に保持されるものではありません。2019 年 9 月以降、詳細は 14 日間保持されていますが、この期間は通知なく変更される場合があります。

必要な権限:

次のいずれか。

この操作では、/rest/api/3/task/{taskId} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Task Id (タスク ID)

String (文字列)

タスクの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Avatars

<jira:get-rest-api3-universal-avatar-type-owner-by-type-entity-id>

プロジェクトまたは課題種別のシステムアバターとカスタムアバターを返します。この操作には匿名でアクセスできます。

必要な権限:

なし。

この操作では、/rest/api/3/universal_avatar/type/{type}/owner/{entityId} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

type (型)

Enumeration (列挙)。次のいずれかになります。

  • PROJECT

  • ISSUETYPE

アバター種別。

x

Entity Id (エンティティ ID)

String (文字列)

アバターが関連付けられている項目の ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get User

<jira:get-rest-api3-user>

ユーザーを返します。

必要な権限:

「Browse users and groups (ユーザーとグループの参照)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/user エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Account Id (アカウント ID)

String (文字列)

ユーザーのアカウント ID。これは、すべての Atlassian 製品でユーザーを一意に識別します。例: 5b10ac8d82e05b22cc7d4ef5​。必須。

username (ユーザー名)

String (文字列)

このパラメーターは使用できなくなり、まもなくドキュメントから削除されます。詳細は、 廃止通知Leaving the Site​を参照してください。

key (キー)

String (文字列)

このパラメーターは使用できなくなり、まもなくドキュメントから削除されます。詳細は、 廃止通知Leaving the Site​を参照してください。

expand (展開)

String (文字列)

expand​ を使用すると、ユーザーに関する追加の情報が応答に含まれます。このパラメーターは、カンマ区切りのリストを受け入れます。expand (展開) には次のオプションがあります。

  • groups​ では、ユーザーが属しているすべてのグループとネストされたグループが含まれます。

  • applicationRoles​ では、ユーザーがアクセスできるすべてのアプリケーションの詳細が含まれます。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Find Bulk Assignable Users

<jira:get-rest-api3-user-assignable-multi-project-search>

1 つ以上のプロジェクトの課題を割り当てることができるユーザーのリストを返します。リストは、文字列に一致する属性を持つユーザーに制限することができます。この操作では、​startAt​ と ​maxResults​ で定義された範囲 (1,000 番目のユーザーまで) でユーザーが取得され、その範囲から、プロジェクトの課題を割り当てることができるユーザーのみが返されます。つまり、通常、この操作で返されるユーザーの数は、​maxResults​ で指定された数よりも少なくなります。

プロジェクトの課題を割り当てることができるすべてのユーザーを取得するには、[Get all users](#api-rest-api-3-users-search-get) を使用して、コードでレコードを絞り込みます。

この操作には匿名でアクセスできます。

必要な権限:

なし。

この操作では、/rest/api/3/user/assignable/multiProjectSearch エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

query (クエリ)

String (文字列)

関連するユーザーを見つけるためにユーザー属性 (​displayName​ や ​emailAddress​ など) と照合するクエリ文字列。この文字列は属性の値のプレフィックスに一致できます。たとえば、​query=john​ は、​John Smith​ の ​displayName​ を持つユーザーと ​johnson@example.com​ の ​emailAddress​ を持つユーザーに一致します。​accountId​ が指定されていない場合は必須です。

username (ユーザー名)

String (文字列)

このパラメーターは使用できなくなり、まもなくドキュメントから削除されます。詳細は、 廃止通知Leaving the Site​を参照してください。

Account Id (アカウント ID)

String (文字列)

ユーザーの ​accountId​ に完全に一致するクエリ文字列。​query​ が指定されていない場合は必須です。

Project Keys (プロジェクトキー)

String (文字列)

プロジェクトキーのリスト (大文字と小文字を区別)。このパラメーターは、カンマ区切りのリストを受け入れます。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Find Assignable Users

<jira:get-rest-api3-user-assignable-search>

課題に割り当てることができるユーザーのリストを返します。この操作を使用して、以下の課題に割り当てることができるユーザーのリストを見つけます。

  • 新しい課題。​projectKeyOrId​ を指定します。

  • 更新された課題。​issueKey​ を指定します。

  • 移行 (ワークフローアクション) 中の課題。​issueKey​ と移行 ID を ​actionDescriptorId​ に指定します。課題の有効な移行の ID は、[Get issue](#api-rest-api-3-issue-issueIdOrKey-get) の ​expand​ パラメーターの ​transitions​ オプションを使用して取得できます。このすべての場合で、アカウント ID を渡して、ユーザーを課題に割り当てることができるかどうかを確認できます。

ユーザーを課題または課題の移行に割り当てることができる場合、そのユーザーが応答に返されます。この操作では、​startAt​ と ​maxResults​ で定義された範囲 (1,000 番目のユーザーまで) でユーザーが取得され、その範囲から、課題を割り当てることができるユーザーのみが返されます。つまり、通常、この操作で返されるユーザーの数は、​maxResults​ で指定された数よりも少なくなります。課題を割り当てることができるすべてのユーザーを取得するには、[Get all users](#api-rest-api-3-users-search-get) を使用して、コードでレコードを絞り込みます。

必要な権限:

Jira にアクセスするための権限。

この操作では、/rest/api/3/user/assignable/search エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

query (クエリ)

String (文字列)

関連するユーザーを見つけるためにユーザー属性 (​displayName​ や ​emailAddress​ など) と照合するクエリ文字列。この文字列は属性の値のプレフィックスに一致できます。たとえば、​query=john​ は、​John Smith​ の ​displayName​ を持つユーザーと ​johnson@example.com​ の ​emailAddress​ を持つユーザーに一致します。​username​ または ​accountId​ が指定されていない場合は必須です。

Session Id (セッション ID)

String (文字列)

この要求の sessionId。SessionId は、担当者が設定されるまで同じです。

username (ユーザー名)

String (文字列)

このパラメーターは使用できなくなり、まもなくドキュメントから削除されます。詳細は、 廃止通知Leaving the Site​を参照してください。

Account Id (アカウント ID)

String (文字列)

ユーザーの ​accountId​ に完全に一致するクエリ文字列。​query​ が指定されていない場合は必須です。

プロジェクト

String (文字列)

プロジェクト ID またはプロジェクトキー (大文字と小文字を区別)。​issueKey​ が指定されていない場合は必須です。

Issue Key (課題キー)

String (文字列)

課題のキー。​project​ が指定されていない場合は必須です。

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

返す項目の最大数。この操作では、最大項目数より少ない数の項目が (これ以上の項目がある場合でも) 返される場合があります。この操作では、ユーザーが最大数までフェッチされ、フェッチされたユーザーから、課題に割り当てることができるユーザーのみが返されます。

50

Action Descriptor Id (アクション記述子 ID)

Number (数値)

移行の ID。

recommend (推奨)

Boolean (ブール)

recommend (推奨)

false

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Bulk Get Users

<jira:get-rest-api3-user-bulk>

1 つ以上のアカウント ID で指定されたユーザーのページ分割されたリストを返します。

必要な権限:

Jira にアクセスするための権限。

この操作では、/rest/api/3/user/bulk エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

10

username (ユーザー名)

Array of String (文字列の配列)

このパラメーターは使用できなくなり、まもなくドキュメントから削除されます。詳細は、 廃止通知Leaving the Site​を参照してください。

key (キー)

Array of String (文字列の配列)

このパラメーターは使用できなくなり、まもなくドキュメントから削除されます。詳細は、 廃止通知Leaving the Site​を参照してください。

Account Id (アカウント ID)

Array of String (文字列の配列)

ユーザーのアカウント ID。複数のユーザーを指定するには、複数の ​accountId​ パラメーターを渡します。例: accountId=5b10a2844c20165700ede21g&accountId=5b10ac8d82e05b22cc7d4ef5​。

x

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

* Any の配列

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Bulk Get Users Migration

<jira:get-rest-api3-user-bulk-migration>

key​ または ​username​ パラメーターで指定されたユーザーのアカウント ID を返します。複数の ​key​ または ​username​ パラメーターを指定できます。

必要な権限:

Jira にアクセスするための権限。

この操作では、/rest/api/3/user/bulk/migration エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

10

username (ユーザー名)

Array of String (文字列の配列)

ユーザーのユーザー名。複数のユーザーを指定するには、このパラメーターの複数のコピーを渡します。例: username=fred&username=barney​。​key​ が指定されていない場合は必須です。​key​ がある場合、指定できません。

key (キー)

Array of String (文字列の配列)

ユーザーのキー。複数のユーザーを指定するには、このパラメーターの複数のコピーを渡します。例: key=fred&key=barney​。​username​ が指定されていない場合は必須です。​username​ がある場合、指定できません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get User Default Columns

<jira:get-rest-api3-user-columns>

ユーザーのデフォルトの 課題テーブル列Leaving the Site​を返します。要求で ​accountId​ を渡さない場合、コール元ユーザーの詳細が返されます。

必要な権限:

  • 「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。任意のユーザーの列の詳細を取得します。

  • Jira にアクセスするための権限。コール元ユーザーの列の詳細を取得します。

この操作では、/rest/api/3/user/columns エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Account Id (アカウント ID)

String (文字列)

ユーザーのアカウント ID。これは、すべての Atlassian 製品でユーザーを一意に識別します。例: 5b10ac8d82e05b22cc7d4ef5​。

username (ユーザー名)

String (文字列)

このパラメーターは使用できなくなり、まもなくドキュメントから削除されます。詳細は、 廃止通知Leaving the Site​を参照してください。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get User Email

<jira:get-rest-api3-user-email>

ユーザーのメールアドレスを返します。この API を使用できるのは、この ガイドラインLeaving the Site​に従って Atlassian が承認したアプリケーションのみです。

この操作では、/rest/api/3/user/email エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Account Id (アカウント ID)

String (文字列)

ユーザーのアカウント ID。これは、すべての Atlassian 製品でユーザーを一意に識別します。例: 5b10ac8d82e05b22cc7d4ef5​。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get User Email Bulk

<jira:get-rest-api3-user-email-bulk>

ユーザーのメールアドレスを返します。この API を使用できるのは、この ガイドラインLeaving the Site​に従って Atlassian が承認したアプリケーションのみです。

この操作では、/rest/api/3/user/email/bulk エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Account Id (アカウント ID)

Array of String (文字列の配列)

メールを必要とするユーザーのアカウント ID。​accountId​ は、すべての Atlassian 製品でユーザーを一意に識別する識別子です。例: 5b10ac8d82e05b22cc7d4ef5​。これは不透明な識別子 (opaque identifier) として処理する必要があります (つまり、値内の構造を想定しないでください)。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get User Groups

<jira:get-rest-api3-user-groups>

ユーザーが所属するグループを返します。

必要な権限:

「Browse users and groups (ユーザーとグループの参照)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/user/groups エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Account Id (アカウント ID)

String (文字列)

ユーザーのアカウント ID。これは、すべての Atlassian 製品でユーザーを一意に識別します。例: 5b10ac8d82e05b22cc7d4ef5​。

x

username (ユーザー名)

String (文字列)

このパラメーターは使用できなくなり、まもなくドキュメントから削除されます。詳細は、 廃止通知Leaving the Site​を参照してください。

key (キー)

String (文字列)

このパラメーターは使用できなくなり、まもなくドキュメントから削除されます。詳細は、 廃止通知Leaving the Site​を参照してください。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Find Users With All Permissions

<jira:get-rest-api3-user-permission-search>

次の条件を満たすユーザーのリストを返します。

  • ユーザー属性が検索文字列に一致する。

  • プロジェクトまたは課題に対する一連の権限がある。

検索文字列を指定しない場合、これらの権限を持つすべてのユーザーのリストが返されます。この操作では、​startAt​ と ​maxResults​ で定義された範囲 (1,000 番目のユーザーまで) でユーザーが取得され、その範囲から、検索文字列に一致し、プロジェクトまたは課題に対する権限を持つユーザーのみが返されます。つまり、通常、この操作で返されるユーザーの数は、​maxResults​ で指定された数よりも少なくなります。検索文字列に一致し、プロジェクトまたは課題に対する権限を持つすべてのユーザーを取得するには、[Get all users](#api-rest-api-3-users-search-get) を使用して、コードでレコードを絞り込みます。この操作には匿名でアクセスできます。

必要な権限:

  • 「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。任意のプロジェクトのユーザーを取得します。

  • プロジェクトに対する​「Administer Projects (プロジェクトの管理)」 プロジェクト権限Leaving the Site​。該当のプロジェクトのユーザーを取得します。

この操作では、/rest/api/3/user/permission/search エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

query (クエリ)

String (文字列)

関連するユーザーを見つけるためにユーザー属性 (​displayName​ や ​emailAddress​ など) と照合するクエリ文字列。この文字列は属性の値のプレフィックスに一致できます。たとえば、​query=john​ は、​John Smith​ の ​displayName​ を持つユーザーと ​johnson@example.com​ の ​emailAddress​ を持つユーザーに一致します。​accountId​ が指定されていない場合は必須です。

username (ユーザー名)

String (文字列)

このパラメーターは使用できなくなり、まもなくドキュメントから削除されます。詳細は、 廃止通知Leaving the Site​を参照してください。

Account Id (アカウント ID)

String (文字列)

ユーザーの ​accountId​ に完全に一致するクエリ文字列。​query​ が指定されていない場合は必須です。

permissions (権限)

String (文字列)

権限のカンマ区切りリスト。権限は次の権限として指定できます。

  • [Get all permissions](#api-rest-api-3-permissions-get) で返された権限。

  • Connect アプリケーションで追加されたカスタムプロジェクト権限。

  • (非推奨) 次のいずれか。

  • ASSIGNABLE\_USER * ASSIGN\_ISSUE

  • ATTACHMENT\_DELETE\_ALL

  • ATTACHMENT\_DELETE\_OWN

  • BROWSE * CLOSE\_ISSUE

  • COMMENT\_DELETE\_ALL

  • COMMENT\_DELETE\_OWN

  • COMMENT\_EDIT\_ALL

  • COMMENT\_EDIT\_OWN

  • COMMENT\_ISSUE

  • CREATE\_ATTACHMENT

  • CREATE\_ISSUE

  • DELETE\_ISSUE

  • EDIT\_ISSUE

  • LINK\_ISSUE

  • MANAGE\_WATCHER\_LIST

  • MODIFY\_REPORTER

  • MOVE\_ISSUE

  • PROJECT\_ADMIN

  • RESOLVE\_ISSUE

  • SCHEDULE\_ISSUE

  • SET\_ISSUE\_SECURITY

  • TRANSITION\_ISSUE

  • VIEW\_VERSION\_CONTROL

  • VIEW\_VOTERS\_AND\_WATCHERS

  • VIEW\_WORKFLOW\_READONLY

  • WORKLOG\_DELETE\_ALL

  • WORKLOG\_DELETE\_OWN

  • WORKLOG\_EDIT\_ALL

  • WORKLOG\_EDIT\_OWN

  • WORK\_ISSUE

x

Issue Key (課題キー)

String (文字列)

課題の課題キー。

Project Key (プロジェクトキー)

String (文字列)

プロジェクトのプロジェクトキー (大文字と小文字を区別)。

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Find Users For Picker

<jira:get-rest-api3-user-picker>

クエリ語に一致する属性を持つユーザーのリストを返します。返されるオブジェクトには ​html​ 項目が含まれ、一致するクエリ語が HTML strong タグで強調表示されます。アカウント ID のリストを指定して、ユーザーを結果から除外できます。この操作では、​maxResults​ で定義された範囲 (1,000 番目のユーザーまで) でユーザーが取得され、その範囲から、クエリ語に一致するユーザーのみが返されます。つまり、通常、この操作で返されるユーザーの数は、​maxResults​ で指定された数よりも少なくなります。クエリ語に一致するすべてのユーザーを取得するには、[Get all users](#api-rest-api-3-users-search-get) を使用して、コードでレコードを絞り込みます。この操作には匿名でアクセスできます。

必要な権限:

「Browse users and groups (ユーザーとグループの参照)」 グローバル権限Leaving the Site​。匿名コール、および必須権限のないユーザーによるコールでは、名前が完全に一致する検索結果のみが返されます。

この操作では、/rest/api/3/user/picker エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

query (クエリ)

String (文字列)

関連するユーザーを見つけるためにユーザー属性 (​displayName​ や ​emailAddress​ など) と照合するクエリ文字列。この文字列は属性の値のプレフィックスに一致できます。たとえば、​query=john​ は、​John Smith​ の ​displayName​ を持つユーザーと ​johnson@example.com​ の ​emailAddress​ を持つユーザーに一致します。

x

Max Results (最大結果数)

Number (数値)

返す項目の最大数。一致したユーザーの合計数は ​total​ で返されます。

50

Show Avatar (アバターを表示)

Boolean (ブール)

ユーザーのアバターへの URI を含めます。

false

exclude (除外)

Array of String (文字列の配列)

このパラメーターは使用できなくなり、まもなくドキュメントから削除されます。詳細は、 廃止通知Leaving the Site​を参照してください。

Exclude Account Ids (アカウント ID を除外)

Array of String (文字列の配列)

検索結果から除外するアカウント ID のリスト。このパラメーターは、カンマ区切りのリストを受け入れます。アンパサンド区切りリストを使用して複数のアカウント ID を指定することもできます。例: excludeAccountIds=5b10a2844c20165700ede21g,5b10a0effa615349cb016cd8&excludeAccountIds=5b10ac8d82e05b22cc7d4ef5​。​exclude​ と共に指定することはできません。

Avatar Size (アバターサイズ)

String (文字列)

Avatar Size (アバターサイズ)

Exclude Connect Users (Connect ユーザーを除外)

Boolean (ブール)

Exclude Connect Users (Connect ユーザーを除外)

false

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get User Property Keys

<jira:get-rest-api3-user-properties>

ユーザーのすべてのプロパティのキーを返します。注意: この操作は、Jira で作成および管理されている ユーザープロパティLeaving the Site​にはアクセスしません。

必要な権限:

  • 「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。任意のユーザーのプロパティキーにアクセスします。

  • Jira へのアクセス権。コール元ユーザーのプロパティキーにアクセスします。

この操作では、/rest/api/3/user/properties エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Account Id (アカウント ID)

String (文字列)

ユーザーのアカウント ID。これは、すべての Atlassian 製品でユーザーを一意に識別します。例: 5b10ac8d82e05b22cc7d4ef5​。

User Key (ユーザーキー)

String (文字列)

このパラメーターは使用できなくなり、まもなくドキュメントから削除されます。詳細は、 廃止通知Leaving the Site​を参照してください。

username (ユーザー名)

String (文字列)

このパラメーターは使用できなくなり、まもなくドキュメントから削除されます。詳細は、 廃止通知Leaving the Site​を参照してください。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get User Property

<jira:get-rest-api3-user-properties-by-property-key>

ユーザーのプロパティの値を返します。プロパティキーを指定しない場合、[Get user property keys](#api-rest-api-3-user-properties-get) がコールされます。注意: この操作では、Jira で作成および維持されている [ユーザープロパティ](https://confluence.atlassian.com/x/8YxjLLeaving the Site) にはアクセスしません。

必要な権限:

  • 「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。任意のユーザーからプロパティを取得します。

  • Jira へのアクセス権。コール元ユーザーのレコードからプロパティを取得します。

この操作では、/rest/api/3/user/properties/{propertyKey} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Property Key (プロパティキー)

String (文字列)

ユーザーのプロパティのキー。

x

Account Id (アカウント ID)

String (文字列)

ユーザーのアカウント ID。これは、すべての Atlassian 製品でユーザーを一意に識別します。例: 5b10ac8d82e05b22cc7d4ef5​。

User Key (ユーザーキー)

String (文字列)

このパラメーターは使用できなくなり、まもなくドキュメントから削除されます。詳細は、[廃止通知](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/Leaving the Site) を参照してください。

username (ユーザー名)

String (文字列)

このパラメーターは使用できなくなり、まもなくドキュメントから削除されます。詳細は、[廃止通知](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/Leaving the Site) を参照してください。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Find Users

<jira:get-rest-api3-user-search>

検索文字列とプロパティに一致するユーザーのリストを返します。この操作では、​startAt​ と ​maxResults​ で定義された範囲 (1,000 番目のユーザーまで) でユーザーが取得され、その範囲から、検索文字列とプロパティに一致するユーザーのみが返されます。つまり、通常、この操作で返されるユーザーの数は、​maxResults​ で指定された数よりも少なくなります。検索文字列とプロパティに一致するすべてのユーザーを取得するには、[Get all users](#api-rest-api-3-users-search-get) を使用して、コードでレコードを絞り込みます。この操作には匿名でアクセスできます。

必要な権限:

「Browse users and groups (ユーザーとグループの参照)」 グローバル権限Leaving the Site​。匿名コール、または必須権限のないユーザーによるコールでは、空の検索結果が返されます。

この操作では、/rest/api/3/user/search エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

query (クエリ)

String (文字列)

関連するユーザーを見つけるためにユーザー属性 (​displayName​ や ​emailAddress​) と照合するクエリ文字列。この文字列は属性の値のプレフィックスに一致できます。たとえば、​query=john​ は、​John Smith​ の ​displayName​ を持つユーザーと ​johnson@example.com​ の ​emailAddress​ を持つユーザーに一致します。​accountId​ または ​property​ が指定されていない場合は必須です。

username (ユーザー名)

String (文字列)

username (ユーザー名)

Account Id (アカウント ID)

String (文字列)

ユーザーの ​accountId​ に完全に一致するクエリ文字列。​query​ または ​property​ が指定されていない場合は必須です。

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

property

String (文字列)

検索プロパティに使用されるクエリ文字列。プロパティキーはパスで指定するため、ドット (.) または等号 (=) 文字を含むプロパティキーは使用できません。JSON オブジェクトを使用してクエリ文字列を指定することはできません。例: {"something":{"nested":1,"other":2}}​ から ​nested​ の値を検索するには、​thepropertykey.something.nested=1​ を使用します。​accountId​ または ​query​ が指定されていない場合は必須です。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Find Users By Query

<jira:get-rest-api3-user-search-query>

構造化クエリを使用してユーザーを検索し、ユーザーの詳細のページ分割されたリストを返します。この操作では、​startAt​ と ​maxResults​ で定義された範囲 (1,000 番目のユーザーまで) でユーザーが取得され、その範囲から、構造化クエリに一致するユーザーのみが返されます。つまり、通常、この操作で返されるユーザーの数は、​maxResults​ で指定された数よりも少なくなります。構造化クエリに一致するすべてのユーザーを取得するには、[Get all users](#api-rest-api-3-users-search-get) を使用して、コードでレコードを絞り込みます。

必要な権限:

「Browse users and groups (ユーザーとグループの参照)」 グローバル権限Leaving the Site​。

クエリステートメントは次のとおりです。

  • is assignee of PROJ​: プロジェクト ​PROJ​ の 1 つ以上の課題の担当者であるユーザーを返します。

  • is assignee of (PROJ-1, PROJ-2)​: 課題 ​PROJ-1​ または ​PROJ-2​ の担当者であるユーザーを返します。

  • is reporter of (PROJ-1, PROJ-2)​: 課題 ​PROJ-1​ または ​PROJ-2​ の報告者であるユーザーを返します。

  • is watcher of (PROJ-1, PROJ-2)​: 課題 ​PROJ-1​ または ​PROJ-2​ のウォッチャーであるユーザーを返します。

  • is voter of (PROJ-1, PROJ-2)​: 課題 ​PROJ-1​ または ​PROJ-2​ の投票者であるユーザーを返します。

  • is commenter of (PROJ-1, PROJ-2)​: 課題 ​PROJ-1​ または ​PROJ-2​ でコメントを投稿したユーザーを返します。

  • is transitioner of (PROJ-1, PROJ-2)​: 課題 ​PROJ-1​ または ​PROJ-2​ で移行を実行したユーザーを返します。

  • [propertyKey].entity.property.path is "property value"​: エンティティプロパティ値を持つユーザーを返します。

(PROJ-1, PROJ-2, …​ PROJ-n)​ のように、課題のリストを必要に応じて拡張できます。​AND​ および ​OR​ 演算子を使用してステートメントを組み合わせて、より複雑なクエリを形成できます。例: is assignee of PROJ AND [propertyKey].entity.property.path is "property value"

この操作では、/rest/api/3/user/search/query エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

query (クエリ)

String (文字列)

検索クエリ。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

100

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Find User Keys By Query

<jira:get-rest-api3-user-search-query-key>

構造化クエリを使用してユーザーを検索し、ユーザーキーのページ分割されたリストを返します。この操作では、​startAt​ と ​maxResults​ で定義された範囲 (1,000 番目のユーザーまで) でユーザーが取得され、その範囲から、構造化クエリに一致するユーザーのみが返されます。つまり、通常、この操作で返されるユーザーの数は、​maxResults​ で指定された数よりも少なくなります。構造化クエリに一致するすべてのユーザーを取得するには、[Get all users](#api-rest-api-3-users-search-get) を使用して、コードでレコードを絞り込みます。

必要な権限:

「Browse users and groups (ユーザーとグループの参照)」 グローバル権限Leaving the Site​。

クエリステートメントは次のとおりです。

  • is assignee of PROJ​: プロジェクト ​PROJ​ の 1 つ以上の課題の担当者であるユーザーを返します。

  • is assignee of (PROJ-1, PROJ-2)​: 課題 ​PROJ-1​ または ​PROJ-2​ の担当者であるユーザーを返します。

  • is reporter of (PROJ-1, PROJ-2)​: 課題 ​PROJ-1​ または ​PROJ-2​ の報告者であるユーザーを返します。

  • is watcher of (PROJ-1, PROJ-2)​: 課題 ​PROJ-1​ または ​PROJ-2​ のウォッチャーであるユーザーを返します。

  • is voter of (PROJ-1, PROJ-2)​: 課題 ​PROJ-1​ または ​PROJ-2​ の投票者であるユーザーを返します。

  • is commenter of (PROJ-1, PROJ-2)​: 課題 ​PROJ-1​ または ​PROJ-2​ でコメントを投稿したユーザーを返します。

  • is transitioner of (PROJ-1, PROJ-2)​: 課題 ​PROJ-1​ または ​PROJ-2​ で移行を実行したユーザーを返します。

  • [propertyKey].entity.property.path is "property value"​: エンティティプロパティ値を持つユーザーを返します。

(PROJ-1, PROJ-2, …​ PROJ-n)​ のように、課題のリストを必要に応じて拡張できます。​AND​ および ​OR​ 演算子を使用してステートメントを組み合わせて、より複雑なクエリを形成できます。例: is assignee of PROJ AND [propertyKey].entity.property.path is "property value"

この操作では、/rest/api/3/user/search/query/key エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

query (クエリ)

String (文字列)

検索クエリ。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

100

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Find Users With Browse Permission

<jira:get-rest-api3-user-viewissue-search>

次の条件を満たすユーザーのリストを返します。

  • ユーザー属性が検索文字列に一致する。

  • 課題を参照する権限がある。

このリソースを使用して、以下の課題を参照できるユーザーを見つけます。

  • 課題。​issueKey​ を指定します。

  • プロジェクトの任意の課題。​projectKey​ を指定します。この操作では、​startAt​ と ​maxResults​ で定義された範囲 (1,000 番目のユーザーまで) でユーザーが取得され、その範囲から、検索文字列に一致し、課題を参照する権限を持つユーザーのみが返されます。つまり、通常、この操作で返されるユーザーの数は、​maxResults​ で指定された数よりも少なくなります。検索文字列に一致し、課題を参照する権限を持つすべてのユーザーを取得するには、[Get all users](#api-rest-api-3-users-search-get) を使用して、コードでレコードを絞り込みます。

この操作には匿名でアクセスできます。

必要な権限:

「Browse users and groups (ユーザーとグループの参照)」 グローバル権限Leaving the Site​。匿名コール、および必須権限のないユーザーによるコールでは、空の検索結果が返されます。

この操作では、/rest/api/3/user/viewissue/search エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

query (クエリ)

String (文字列)

関連するユーザーを見つけるためにユーザー属性 (​displayName​ や ​emailAddress​ など) と照合するクエリ文字列。この文字列は属性の値のプレフィックスに一致できます。たとえば、​query=john​ は、​John Smith​ の ​displayName​ を持つユーザーと ​johnson@example.com​ の ​emailAddress​ を持つユーザーに一致します。​accountId​ が指定されていない場合は必須です。

username (ユーザー名)

String (文字列)

このパラメーターは使用できなくなり、まもなくドキュメントから削除されます。詳細は、 廃止通知Leaving the Site​を参照してください。

Account Id (アカウント ID)

String (文字列)

ユーザーの ​accountId​ に完全に一致するクエリ文字列。​query​ が指定されていない場合は必須です。

Issue Key (課題キー)

String (文字列)

課題の課題キー。​projectKey​ が指定されていない場合は必須です。

Project Key (プロジェクトキー)

String (文字列)

プロジェクトのプロジェクトキー (大文字と小文字を区別)。​issueKey​ が指定されていない場合は必須です。

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get All Users Default

<jira:get-rest-api3-users>

すべて (アクティブおよび非アクティブ) のユーザーのリストを返します。

必要な権限:

「Browse users and groups (ユーザーとグループの参照)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/users エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Start At (開始)

Number (数値)

返す最初の項目のインデックス。

0

Max Results (最大結果数)

Number (数値)

返す項目の最大数。

50

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get All Users

<jira:get-rest-api3-users-search>

すべて (アクティブおよび非アクティブ) のユーザーのリストを返します。

必要な権限:

「Browse users and groups (ユーザーとグループの参照)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/users/search エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Start At (開始)

Number (数値)

返す最初の項目のインデックス。

0

Max Results (最大結果数)

Number (数値)

返す項目の最大数。

50

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Version

<jira:get-rest-api3-version-by-id>

プロジェクトバージョンを返します。この操作には匿名でアクセスできます。

必要な権限:

バージョンを含むプロジェクトの​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/version/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

バージョンの ID。

x

expand (展開)

String (文字列)

expand​ を使用すると、バージョンに関する追加の情報が応答に含まれます。このパラメーターは、カンマ区切りのリストを受け入れます。expand (展開) には次のオプションがあります。

  • operations​: このバージョンで使用できる操作のリストを返します。

  • issuesstatus​ 状況カテゴリ (​to do (ToDo)​、​in progress (処理中)​、​done (完了)​、​unmapped (マッピングなし)​) ごとにこのバージョンの課題の件数を返します。​unmapped (マッピングなし)​ プロパティは、​to do (ToDo)​、​in progress (処理中)​、および ​done (完了)​ 以外の状況の課題の数を表します。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Version Related Issues

<jira:get-rest-api3-version-related-issue-counts-by-id>

バージョンの以下の件数を返します。

  • fixVersion​ がバージョンに設定されている課題の数。

  • affectedVersion​ がバージョンに設定されている課題の数。

  • バージョンのカスタム項目がバージョンに設定されている課題の数。

この操作には匿名でアクセスできます。

必要な権限:

バージョンを含むプロジェクトに対する​「Browse projects (プロジェクトの参照)」​プロジェクト権限。

この操作では、/rest/api/3/version/{id}/relatedIssueCounts エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

バージョンの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Version Unresolved Issues

<jira:get-rest-api3-version-unresolved-issue-count-by-id>

プロジェクトバージョンの課題および未解決の課題の件数を返します。この操作には匿名でアクセスできます。

必要な権限:

バージョンを含むプロジェクトに対する​「Browse projects (プロジェクトの参照)」​プロジェクト権限。

この操作では、/rest/api/3/version/{id}/unresolvedIssueCount エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

バージョンの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Dynamic Webhooks For App

<jira:get-rest-api3-webhook>

コール元アプリケーションにより登録された Web フックのページ分割されたリストを返します。

必要な権限:

Connect アプリケーションLeaving the Site​のみがこの操作を使用できます。

この操作では、/rest/api/3/webhook エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

100

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Failed Webhooks

<jira:get-rest-api3-webhook-failed>

最大再試行回数後に要求元アプリケーションへの配信に最近失敗した Web フックを返します。72 時間経過すると、その失敗はこの操作により返されなくなる場合があります。最も古い失敗が最初に返されます。この方法では、カーソルベースのページネーションを使用します。次のページを要求するために、リストの最後の Web フックの失敗時間を ​failedAfter​ 値として使用するか、​next​ で指定された URL を使用します。

必要な権限:

Connect アプリケーションLeaving the Site​のみがこの操作を使用できます。

この操作では、/rest/api/3/webhook/failed エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Max Results (最大結果数)

Number (数値)

ページごとに返される Web フックの最大数。maxResults ディレクティブに従った結果として、同じ失敗時刻を持つレコードが複数のページに分割される場合、このディレクティブは無視され、同じ失敗時刻を持つすべてのレコードがページに含まれます。

after (この時間より後)

Number (数値)

レコードを返すには、この時間の後に何らかの Web フック失敗が発生している必要があります。UNIX エポックからのミリ秒で表されます。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Workflow Transition Rule Configurations

<jira:get-rest-api3-workflow-rule-config>

移行ルールを含むワークフローのページ分割されたリストを返します。ワークフローを絞り込み、次のワークフロー移行ルールを含むワークフローのみを返すことができます。

  • 1 つ以上の移行ルール種別 ( ワークフローの事後操作Leaving the Site​など) のワークフロー移行ルール。

  • 1 つ以上の移行ルールキーに一致するワークフロー移行ルール。コール元の Connect アプリケーションで作成された移行ルールを含むワークフローのみが返されます。ただし、ワークフローが返される場合、そのワークフローに対して、検索条件に一致するすべての移行ルールが返されます。サーバー側の最適化のため、空のルールリストを含むワークフローが返される場合がありますが、そのワークフローは無視できます。

必要な権限:

Connect アプリケーションのみがこの操作を使用できます。

この操作では、/rest/api/3/workflow/rule/config エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

10

types (種別)

Array of Enumeration (列挙の配列)。次のいずれかになります。

  • POSTFUNCTION

  • CONDITION

  • VALIDATOR

返す移行ルールの種別。

x

Key (キー)

Array of String (文字列の配列)

Connect アプリケーション記述子で定義された、返す移行ルールの移行ルールクラスキー。

expand (展開)

String (文字列)

expand​ を使用して、追加情報を応答に含めます。このパラメーターでは、ルールごとにルールの割り当て先の移行に関する情報を返す ​transition​ を受け入れます。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Workflows Paginated

<jira:get-rest-api3-workflow-search>

パブリッシュ済みの従来のワークフローのページ分割されたリストを返します。ワークフロー名を指定した場合、そのワークフローの詳細が返されます。指定しない場合、すべてのパブリッシュ済みの従来のワークフローが返されます。この操作では、次世代ワークフローは返されません。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflow/search エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

Workflow Name (ワークフロー名)

Array of String (文字列の配列)

返すワークフローの名前。

expand (展開)

String (文字列)

expand​ を使用して、追加情報を応答に含めます。このパラメーターは、カンマ区切りのリストを受け入れます。expand (展開) には次のオプションがあります。

  • transitions​: ワークフローごとに、ワークフロー内の移行に関する情報を返します。

  • transitions.rules​: ワークフロー移行ごとに、そのルールに関する情報を返します。この拡張オプションが要求された場合、移行が自動的に含まれます。

  • statuses​: ワークフローごとに、ワークフロー内の状況に関する情報を返します。

  • statuses.properties​: ワークフロー状況ごとに、そのプロパティに関する情報を返します。この拡張オプションが要求された場合、状況が自動的に含まれます。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Workflow Transition Properties

<jira:get-rest-api3-workflow-transitions-properties-by-transition-id>

ワークフロー移行のプロパティを返します。移行のプロパティは、移行の動作を変更するために使用されます。詳細は、 「Transition properties (移行のプロパティ)」Leaving the Site​と 「Workflow properties (ワークフローのプロパティ)」Leaving the Site​を参照してください。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflow/transitions/{transitionId}/properties エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Transition Id (移行 ID)

Number (数値)

移行の ID。ID を取得するには、Jira 管理コンソールでワークフローをテキストモードで表示します。ID は移行の横に表示されます。

x

Include Reserved Keys (予約済みキーを含める)

Boolean (ブール)

jira.​ プレフィックス付きのキーを持ついくつかのプロパティが予約されています。つまり、これらは編集できません。これらのプロパティを結果に含めるには、このパラメーターを ​true​ に設定します。

false

key (キー)

String (文字列)

返されるプロパティのキー (プロパティの名前とも呼ばれる)。このパラメーターを指定しない場合、移行のすべてのプロパティが返されます。

Workflow Name (ワークフロー名)

String (文字列)

移行が属するワークフローの名前。

x

Workflow Mode (ワークフローモード)

Enumeration (列挙)。次のいずれかになります。

  • LIVE

  • DRAFT (ドラフト)

ワークフロー状況。アクティブおよび非アクティブなワークフローでは ​live (ライブ)​ に設定し、ドラフトワークフローでは ​draft (ドラフト)​ に設定します。

LIVE

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get All Workflow Schemes

<jira:get-rest-api3-workflowscheme>

ドラフトワークフロースキームを含まない、すべてのワークフロースキームのページ分割されたリストを返します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflowscheme エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Start At (開始)

Number (数値)

結果のページで返される最初の項目のインデックス (ページオフセット)。

0

Max Results (最大結果数)

Number (数値)

ページごとに返される項目の最大数。

50

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

* Any の配列

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Workflow Scheme

<jira:get-rest-api3-workflowscheme-by-id>

ワークフロースキームを返します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflowscheme/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

ワークフロースキームの ID。この ID を見つけるには、Jira で目的のワークフロースキームを編集します。ID は URL に ​schemeId​ として表示されます。例: schemeId=10301​。

x

Return Draft If Exists (存在する場合にドラフトを返す)

Boolean (ブール)

true に設定した場合、スキーム自体ではなく、ワークフロースキームのドラフトを返します。ワークフロースキームにドラフトがない場合、ワークフロースキームが返されます。

false

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Default Workflow

<jira:get-rest-api3-workflowscheme-default-by-id>

ワークフロースキームのデフォルトワークフローを返します。デフォルトワークフローは、他のワークフローにマップされていない任意の課題種別が割り当てられるワークフローです。デフォルトワークフローでは、​[All Unassigned Issue Types (すべての未割り当ての課題種別)]​ が Jira のワークフロースキームの課題種別内でリストされます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflowscheme/{id}/default エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

ワークフロースキームの ID。

x

Return Draft If Exists (存在する場合にドラフトを返す)

Boolean (ブール)

true​ に設定すると、スキーム自体ではなくワークフロースキームのドラフトのデフォルトワークフローが返されます。ワークフロースキームにドラフトがない場合、ワークフロースキームのドラフトワークフローが返されます。

false

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Workflow Scheme Draft

<jira:get-rest-api3-workflowscheme-draft-by-id>

アクティブなワークフロースキームのドラフトワークフロースキームを返します。ドラフトワークフロースキームを使用すると、アクティブなワークフロースキームに変更を加えることができます。アクティブなワークフロースキームが更新されると、ドラフトのコピーが作成されます。ドラフトが変更されたら、ドラフト内の変更が、アクティブなワークフロースキームにコピーされます。詳細は、 「Configuring workflow schemes (ワークフロースキームの設定)」Leaving the Site​を参照してください。

注意:

  • アクティブなワークフロースキームのみがドラフトワークフロースキームを持つことができます。

  • アクティブなワークフロースキームは 1 つのドラフトワークフロースキームのみを持つことができます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflowscheme/{id}/draft エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

ドラフトの作成元であるアクティブなワークフロースキームの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Draft Default Workflow

<jira:get-rest-api3-workflowscheme-draft-default-by-id>

ワークフロースキームのドラフトのデフォルトワークフローを返します。デフォルトワークフローは、他のワークフローにマップされていない任意の課題種別が割り当てられるワークフローです。デフォルトワークフローでは、​[All Unassigned Issue Types (すべての未割り当ての課題種別)]​ が Jira のワークフロースキームの課題種別内でリストされます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflowscheme/{id}/draft/default エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

ドラフトが属するワークフロースキームの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Workflow Scheme Draft Issue Type

<jira:get-rest-api3-workflowscheme-draft-issuetype-by-id-issue-type>

ワークフロースキームのドラフト内の課題種別の課題種別-ワークフローマッピングを返します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflowscheme/{id}/draft/issuetype/{issueType} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

ドラフトが属するワークフロースキームの ID。

x

Issue Type (課題種別)

String (文字列)

課題種別の ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Draft Workflow

<jira:get-rest-api3-workflowscheme-draft-workflow-by-id>

ワークフロースキームのドラフトのワークフロー-課題種別マッピングを返します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflowscheme/{id}/draft/workflow エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

ドラフトが属するワークフロースキームの ID。

x

Workflow Name (ワークフロー名)

String (文字列)

スキーム内のワークフローの名前。指定したワークフローのワークフロー-課題種別マッピングに結果を制限します。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Workflow Scheme Issue Type

<jira:get-rest-api3-workflowscheme-issuetype-by-id-issue-type>

ワークフロースキーム内の課題種別の課題種別-ワークフローマッピングを返します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflowscheme/{id}/issuetype/{issueType} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

ワークフロースキームの ID。

x

Issue Type (課題種別)

String (文字列)

課題種別の ID。

x

Return Draft If Exists (存在する場合にドラフトを返す)

Boolean (ブール)

true に設定した場合、ワークフロースキームではなく、ワークフロースキームのドラフトからのマッピングを返します。ドラフトが存在しない場合、ワークフロースキームからのマッピングが返されます。

false

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Workflow Scheme Project Associations

<jira:get-rest-api3-workflowscheme-project>

プロジェクトのリストに関連付けられたワークフロースキームのリストを返します。返される各ワークフロースキームには、そのワークフロースキームに関連付けられた要求済みプロジェクトのリストが含まれます。要求内の次世代プロジェクトや存在しないプロジェクトは無視されてエラーは返されません。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflowscheme/project エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Id (プロジェクト ID)

Array of Number (数値の配列)

返すワークフロースキームの対象であるプロジェクトの ID。複数のプロジェクトを含めるには、アンパサンド区切りリストを指定します。例: projectId=10000&projectId=10001​。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Workflow

<jira:get-rest-api3-workflowscheme-workflow-by-id>

ワークフロースキームのワークフロー-課題種別マッピングを返します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflowscheme/{id}/workflow エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

ワークフロースキームの ID。

x

Workflow Name (ワークフロー名)

String (文字列)

スキーム内のワークフローの名前。指定したワークフローのワークフロー-課題種別マッピングに結果を制限します。

Return Draft If Exists (存在する場合にドラフトを返す)

Boolean (ブール)

true に設定した場合、ワークフロースキームではなく、ワークフロースキームのドラフトからのマッピングを返します。ドラフトが存在しない場合、ワークフロースキームからのマッピングが返されます。

false

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Ids Of Worklogs Deleted Since

<jira:get-rest-api3-worklog-deleted>

特定の日時以降に削除された作業ログの ID のリストを返し、タイムスタンプを削除します。このリソースはページ分割されます。ページごとに 1,000 件の作業ログの制限があります。各ページでは最も古いものから順に作業ログがリストされます。日付範囲内の項目数が 1,000 件を超える場合、​until​ では、ページ上の最も新しい項目のタイムスタンプが示されます。また、​nextPage​ では、作業ログの次のページの URL が提供されます。​lastPage​ パラメーターは、作業ログの最後のページで true に設定されます。このリソースでは、要求の前の 1 分間に削除された作業ログは返されません。

必要な権限:

Jira にアクセスするための権限。

この操作では、/rest/api/3/worklog/deleted エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

since (この日時以降)

Number (数値)

この日時 (ミリ秒単位の UNIX タイムスタンプ) 以降に削除された作業ログを返します。

0

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Get Ids Of Worklogs Modified Since

<jira:get-rest-api3-worklog-updated>

特定の日時以降に更新された作業ログの ID のリストを返し、タイムスタンプを更新します。このリソースはページ分割されます。ページごとに 1,000 件の作業ログの制限があります。各ページでは最も古いものから順に作業ログがリストされます。日付範囲内の項目数が 1,000 件を超える場合、​until​ では、ページ上の最も新しい項目のタイムスタンプが示されます。また、​nextPage​ では、作業ログの次のページの URL が提供されます。​lastPage​ パラメーターは、作業ログの最後のページで true に設定されます。このリソースでは、要求の前の 1 分間に更新された作業ログは返されません。

必要な権限:

Jira へのアクセス権。ただし、次のいずれかに該当する場合にのみ作業ログが返されます。

  • 作業ログが ​[Viewable by All Users (すべてのユーザーが表示可能)]​ として設定されている。

  • ユーザーが、作業ログの表示権限を持つプロジェクトロールまたはグループのメンバーである。

この操作では、/rest/api/3/worklog/updated エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

since (この日時以降)

Number (数値)

この日時 (ミリ秒単位の UNIX タイムスタンプ) 以降に更新された作業ログを返します。

0

expand (展開)

String (文字列)

expand​ を使用して、作業ログに関する追加情報を応答に含めます。このパラメーターは、各作業ログのプロパティを返す ​properties​ を受け入れます。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Addon Properties Resource get Addon Properties get

<jira:get-rest-atlassian-connect1-addons-properties-by-addon-key>

アプリケーションのすべてのプロパティを取得します。

必要な権限:

この要求を実行できるのは、キーが ​addonKey​ に一致する Connect アプリケーションのみです。

この操作では、/rest/atlassian-connect/1/addons/{addonKey}/properties エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Addon Key (アドオンキー)

String (文字列)

記述子で定義されるアプリケーションのキー。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Addon Properties Resource get Addon Property get

<jira:get-rest-atlassian-connect1-addons-properties-by-addon-key-property-key>

アプリケーションのプロパティのキーと値を返します。

必要な権限:

この要求を実行できるのは、キーが ​addonKey​ に一致する Connect アプリケーションのみです。

この操作では、/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Addon Key (アドオンキー)

String (文字列)

記述子で定義されるアプリケーションのキー。

x

Property Key (プロパティキー)

String (文字列)

プロパティのキー。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Dynamic Modules Resource get Modules get

<jira:get-rest-atlassian-connect1-app-module-dynamic>

コール元アプリケーションにより動的に登録されたすべてのモジュールを返します。

必要な権限:

この要求を実行できるのは Connect アプリケーションのみです。

この操作では、/rest/atlassian-connect/1/app/module/dynamic エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Unauthorize

<jira:unauthorize>

特定のリソースオーナー ID のアクセストークン情報をすべて削除して、認証ダンスが繰り返されない限り、そのユーザー向けの操作を実行できないようにします。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Resource Owner Id (リソースオーナー ID)

String (文字列)

アクセスの無効化が必要なリソースオーナーの ID。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

次の設定の場合

Set Application Property

<jira:update-rest-api3-application-properties-by-id>

アプリケーションプロパティの値を変更します。たとえば、文頭の大文字表記が望まれる場合は、​jira.clone.prefix​ の値をそのデフォルト値の ​CLONE -​ から ​Clone -​ に変更できます。以下で、編集可能なプロパティとそのデフォルト値について説明します。

詳細設定

以下の詳細設定は、 JiraLeaving the Site​ でもアクセスできます。

Key (キー) 説明 デフォルト値

jira.clone.prefix

コピーした課題のタイトルの先頭に追加するテキストの文字列。

CLONE -

jira.date.picker.java.format

Java (サーバー側) で生成された日付の日付形式。これは、​jira.date.picker.javascript.format​ 形式設定と同じである必要があります。

d/MMM/yy

jira.date.picker.javascript.format

JavaScript (クライアント側) で生成された日付の日付形式。これは、​jira.date.picker.java.format​ 形式設定と同じである必要があります。

%e/%b/%y

jira.date.time.picker.java.format

Java (サーバー側) で生成された日時の日付形式。これは、​jira.date.time.picker.javascript.format​ 形式設定と同じである必要があります。

dd/MMM/yy h:mm a

jira.date.time.picker.javascript.format

JavaScript (クライアント側) で生成された日時の日付形式。これは、​jira.date.time.picker.java.format​ 形式設定と同じである必要があります。

%e/%b/%y %I:%M %p

jira.issue.actions.order

課題ビューに表示するアクション (​Comments (コメント)​、​Change history (変更履歴)​ など) のデフォルトの順序。

asc

jira.table.cols.subtasks

テーブルにサブタスク課題を表示するときに表示する列。たとえば、課題のサブタスクのリストです。

issuetype, status, assignee, progress

jira.view.issue.links.sort.order

課題ビューでの課題リンクのリストの並び替え順。

type, status, priority

jira.comment.collapsing.minimum.hidden

コメントの折りたたみを実行するために必要なコメントの最小数。​0​ の値では、コメントの折りたたみが無効になります。

4

jira.newsletter.tip.delay.days

Jira Insiders ニュースレターへのサインアップを促すメッセージを表示するまでの日数。​-1​ の値では、この機能が無効になります。

7

デザイン

以下の設定で デザインLeaving the Site​を調整します。

Key (キー) 説明 デフォルト値

jira.lf.date.time

時間形式Leaving the Site​。

h:mm a

jira.lf.date.day

曜日形式Leaving the Site​。

EEEE h:mm a

jira.lf.date.complete

日時形式Leaving the Site​。

dd/MMM/yy h:mm a

jira.lf.date.dmy

日付形式Leaving the Site​。

dd/MMM/yy

jira.date.time.picker.use.iso8061

有効にした場合、ISO8601 標準で規定されているように、月曜日を日付ピッカーでの週の最初の日として設定します。

false

jira.lf.logo.url

ロゴ画像ファイルの URL。

/images/icon-jira-logo.png

jira.lf.logo.show.application.title

サイドバーでのアプリケーションタイトルの表示を制御します。

false

jira.lf.favicon.url

お気に入りアイコンの URL。

/favicon.ico

jira.lf.favicon.hires.url

高解像度のお気に入りアイコンの URL。

/images/64jira.png

jira.lf.top.adg3.bgcolour

サイドバーの背景色。

#0747A6

jira.lf.top.adg3.textcolour

サイドバーのテキストとロゴの色。

#DEEBFF

jira.lf.hero.button.base.bg.colour

ヒーローボタンの背景色。

#3b7fc4

jira.title

アプリケーションタイトルのテキスト。アプリケーションタイトルは ​[General settings (一般設定)]​ でも設定できます。

Jira

jira.option.globalsharing

検索条件とダッシュボードを、Jira にサインインした任意のユーザーと共有できるかどうか。

true

xflow.product.suggestions.enabled

Jira 内の他の Atlassian 製品の製品提案を公開するかどうか。

true

その他の設定

Key (キー) 説明 デフォルト値

jira.issuenav.criteria.autoupdate

検索条件の即時更新がアクティブかどうか。

true

注意​: アプリケーションプロパティと高度な設定Leaving the Site​を変更する場合は注意が必要です。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/application-properties/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

更新するアプリケーションプロパティのキー。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Set Comment Property

<jira:update-rest-api3-comment-properties-by-comment-id-property-key>

コメントのプロパティの値を作成または更新します。このリソースを使用して、コメントに対するカスタムデータを保存します。リクエストボディの値は、[有効な](http://tools.ietf.org/html/rfc4627Leaving the Site) 空でない JSON blob である必要があります。最大長は 32768 文字です。

必要な権限:

次のいずれか。

  • 「Edit All Comments (すべてのコメントの編集)」 プロジェクト権限Leaving the Site​。任意のコメントのプロパティの値を作成または更新します。

  • 「Edit Own Comments (自分のコメントの編集)」 プロジェクト権限Leaving the Site​。ユーザーが作成したコメントのプロパティの値を作成または更新します。また、コメントの表示がロールまたはグループに制限されている場合、ユーザーはそのロールまたはグループのメンバーである必要があります。

この操作では、/rest/api/3/comment/{commentId}/properties/{propertyKey} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Comment Id (コメント ID)

String (文字列)

コメントの ID。

x

Property Key (プロパティキー)

String (文字列)

プロパティのキー。最大長は 255 文字です。

x

Body (本文)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Component

<jira:update-rest-api3-component-by-id>

コンポーネントを更新します。要求に含まれる任意の項目を上書きします。​leadAccountId​ が空の文字列 ("") の場合、コンポーネントリーダーが削除されます。この操作には匿名でアクセスできます。

必要な権限:

コンポーネントを含むプロジェクトに対する​「Administer projects (プロジェクトの管理)」 プロジェクト権限Leaving the Site​、または​「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/component/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

コンポーネントの ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Select Time Tracking Implementation

<jira:update-rest-api3-configuration-timetracking>

時間トラッキングプロバイダーを選択します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/configuration/timetracking エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Set Shared Time Tracking Configuration

<jira:update-rest-api3-configuration-timetracking-options>

時間トラッキング設定を定義します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/configuration/timetracking/options エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Custom Field Options

<jira:update-rest-api3-custom-field-option-by-field-id>

この操作は廃止されており、2021 年 5 月 8 日に使用できなくなりました。代わりに、 Update custom field options (context)Leaving the Site​ を使用してください。詳細は、 「Deprecation of custom field options (カスタム項目オプションの廃止)」Leaving the Site​を参照してください。

カスタム選択項目のオプションを更新します。更新されたオプションが課題で使用されている場合、課題の値も更新されます。見つからないオプションは無視されます。​[Select List (cascading) (選択リスト (カスケード))]​ 項目のサブオプションを含め、要求ごとに最大 1,000 個のオプションを更新できます。これらのオプションは、項目のグローバルコンテキストで更新されます。この操作は、​Jira で作成されたか、[Issue custom field options](api-group-Issue-custom-field-options) リソースの操作を使用して作成された課題項目選択リストオプションでのみ機能する​ため、Connect アプリケーションで作成された課題項目選択リストオプションでは使用できません。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/customField/{fieldId}/option エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Id (項目 ID)

Number (数値)

カスタム項目の ID。注意: これは、項目 ID の数値部分です。たとえば、ID ​customfield\_10075​ の項目には ​10075​ を使用します。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Dashboard

<jira:update-rest-api3-dashboard-by-id>

ダッシュボードを更新し、ダッシュボードのすべての詳細を、指定した詳細に置き換えます。

必要な権限:

なし

更新するダッシュボードはユーザーが所有している必要があります。

この操作では、/rest/api/3/dashboard/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

更新するダッシュボードの ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Set Dashboard Item Property

<jira:update-rest-api3-dashboard-items-properties-by-dashboard-id-item-id-property-key>

ダッシュボード項目プロパティの値を設定します。アプリケーションでこのリソースを使用して、ダッシュボード項目に対するカスタムデータを保存します。ダッシュボード項目を使用すると、アプリケーションでユーザー固有の情報をユーザーダッシュボードに追加できます。ダッシュボード項目は、ユーザーがダッシュボードに追加できるガジェットとしてユーザーに公開されます。ユーザーがこれを行う方法についての詳細は、 「Adding and customizing gadgets (ガジェットの追加とカスタマイズ)」Leaving the Site​を参照してください。

アプリケーションでダッシュボード項目が作成されると、ダッシュボード項目 ID を受け取るコールバックが登録されます。コールバックは、項目が表示されるか、項目が設定可能な場合はユーザーが項目を編集するたびに起動します。その後、アプリケーションはこのリソースを使用して、項目のコンテンツまたは設定の詳細を保存します。ダッシュボード項目の操作についての詳細は、 「Building a dashboard item for a JIRA Connect add-on (JIRA Connect アドオンのダッシュボード項目の作成)」Leaving the Site​および 「Dashboard Item (ダッシュボード項目)」Leaving the Site​ドキュメントを参照してください。

ダッシュボード項目を設定または取得するためのリソースはありません。リクエストボディの値は、 有効Leaving the Site​な空でない JSON blob である必要があります。最大長は 32768 文字です。

この操作には匿名でアクセスできます。

必要な権限:

ユーザーがダッシュボードのオーナーである必要があります。​「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​を持つユーザーは、System ダッシュボードのオーナーとみなされます。

この操作では、/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Dashboard Id (ダッシュボード ID)

String (文字列)

ダッシュボードの ID。

x

Item Id (品目 ID)

String (文字列)

ダッシュボード項目の ID。

x

Property Key (プロパティキー)

String (文字列)

ダッシュボード項目プロパティのキー。最大長は 255 文字です。

x

Body (本文)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Custom Field

<jira:update-rest-api3-field-by-field-id>

カスタム項目を更新します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/field/{fieldId} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Id (項目 ID)

String (文字列)

カスタム項目の ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Custom Field Context

<jira:update-rest-api3-field-context-by-field-id-context-id>

カスタム項目コンテキストLeaving the Site​を更新します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/field/{fieldId}/context/{contextId} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Id (項目 ID)

String (文字列)

カスタム項目の ID。

x

Context Id (コンテキスト ID)

Number (数値)

コンテキストの ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Set Default Values

<jira:update-rest-api3-field-context-default-value-by-field-id>

カスタム項目のコンテキストのデフォルトを設定します。デフォルトは、次のオブジェクトを使用して定義されます。

  • 単一選択の選択リストとラジオボタンの場合、​CustomFieldContextDefaultValueSingleOption​ (​option.single​ 型)。

  • 複数選択の選択リストとチェックボックスの場合、​CustomFieldContextDefaultValueMultipleOption​ (​option.multiple​ 型)。

  • カスケード選択リストの場合、​CustomFieldContextDefaultValueCascadingOption​ (​option.cascading​ 型)。1 つの種別のデフォルトオブジェクトのみを要求に含めることができます。コンテキストのデフォルトを削除するには、デフォルトパラメーターを ​null​ に設定します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/field/{fieldId}/context/defaultValue エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Id (項目 ID)

String (文字列)

カスタム項目の ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Add Issue Types To Context

<jira:update-rest-api3-field-context-issuetype-by-field-id-context-id>

課題種別をカスタム項目コンテキストに追加して、課題種別を課題種別リストに追加します。課題種別のないカスタム項目コンテキストは、すべての課題種別に適用されます。このようなカスタム項目コンテキストに課題種別を追加すると、カスタム項目コンテキストはリストされた課題種別にのみ適用されます。いずれかの課題種別がカスタム項目コンテキストに存在する場合、操作は失敗し、どの課題種別も追加されません。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/field/{fieldId}/context/{contextId}/issuetype エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Id (項目 ID)

String (文字列)

カスタム項目の ID。

x

Context Id (コンテキスト ID)

Number (数値)

コンテキストの ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Custom Field Option

<jira:update-rest-api3-field-context-option-by-field-id-context-id>

カスタム項目のオプションを更新します。いずれかのオプションが見つからない場合、どのオプションも更新されません。要求内の値が現在の値に一致するオプションは更新されず、応答で報告されません。この操作は、​Jira で作成されたか、[Issue custom field options](#api-group-Issue-custom-field-options) リソースからの操作を使用して作成された課題項目選択リストオプションでのみ機能します​。Connect アプリケーションによって作成された課題項目選択リストオプションでは使用できません。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/field/{fieldId}/context/{contextId}/option エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Id (項目 ID)

String (文字列)

カスタム項目の ID。

x

Context Id (コンテキスト ID)

Number (数値)

コンテキストの ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Reorder Custom Field Options

<jira:update-rest-api3-field-context-option-move-by-field-id-context-id>

コンテキスト内のカスタム項目オプションまたはカスケードオプションの順序を変更します。この操作は、Jira で作成されたカスタム項目オプションまたはこのリソースからの操作で機能します。 Connect アプリケーション用に作成された課題項目選択リストオプションを操作するには、[Issue custom field options (apps)](#api-group-issue-custom-field-options—​apps-) 操作を使用します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/field/{fieldId}/context/{contextId}/option/move エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Id (項目 ID)

String (文字列)

カスタム項目の ID。

x

Context Id (コンテキスト ID)

Number (数値)

コンテキストの ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Assign Projects To Custom Field Context

<jira:update-rest-api3-field-context-project-by-field-id-context-id>

カスタム項目コンテキストをプロジェクトに割り当てます。要求内のいずれかのプロジェクトがカスタム項目のいずれかのコンテキストに割り当てられている場合、操作は失敗します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/field/{fieldId}/context/{contextId}/project エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Id (項目 ID)

String (文字列)

カスタム項目の ID。

x

Context Id (コンテキスト ID)

Number (数値)

コンテキストの ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Issue Field Option

<jira:update-rest-api3-field-option-by-field-key-option-id>

選択リスト課題項目のオプションを更新または作成します。この操作では、オプションを作成するときにオプション ID を指定する必要があるため、オプション ID を path および body パラメーターとして指定する必要があります。path と body で指定するオプション ID は同じである必要があります。この操作は、​Connect アプリケーションで追加された課題項目選択リストオプションでのみ機能する​ため、Jira で作成されたか、[Issue custom field options](api-group-Issue-custom-field-options) リソースの操作を使用して作成された課題項目選択リストオプションでは使用できません。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

項目を提供するアプリケーションでは、Jira 権限は必要ありません。

この操作では、/rest/api/3/field/{fieldKey}/option/{optionId} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Field Key (項目キー)

String (文字列)

項目キーは次の形式で指定されます: $(app-key)\​\​$(field-key)​。例: example-add-on\_\_example-issue-field​。​fieldKey​ 値を決定するには、次のいずれかを実行します。

  • アプリケーションのプラグイン記述子を開く。​app-key​ は上部にあるキーで、​field-key​ は ​jiraIssueFields​ モジュール内のキーです。 app-key​ は、Atlassian Universal Plugin Manager のアプリケーションリストにもあります。

  • [Get fields](#api-rest-api-3-field-get) を実行する。項目の詳細で、値が ​key​ 内で返されます。(例: "key": "teams-add-on__team-issue-field"​)。

x

Option Id (オプション ID)

Number (数値)

更新するオプションの ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Assign Field Configuration Scheme To Project

<jira:update-rest-api3-fieldconfigurationscheme-project>

項目設定スキームをプロジェクトに割り当てます。項目設定スキーム ID が ​null​ の場合、この操作ではデフォルトの項目設定スキームが割り当てられます。項目設定スキームは従来のプロジェクトにのみ割り当てることができます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/fieldconfigurationscheme/project エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Filter

<jira:update-rest-api3-filter-by-id>

検索条件を更新します。この操作を使用して、検索条件の名前、説明、JQL または共有を更新します。

必要な権限:

Jira にアクセスするための権限。ただし、ユーザーが検索条件を所有している必要があります。

この操作では、/rest/api/3/filter/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

更新する検索条件の ID。

x

expand (展開)

String (文字列)

expand​ を使用して、検索条件に関する追加情報を応答に含めます。このパラメーターは、カンマ区切りのリストを受け入れます。expand (展開) には次のオプションがあります。

  • sharedUsers​: 検索条件が共有されているユーザーを返します。これには、検索条件が共有されているプロジェクトを参照できるユーザーが含まれます。​sharedUsers​ を指定しない場合、​sharedUsers​ オブジェクトは返されますが、ユーザーはリストされません。返されるユーザーのリストは 1000 個に制限され、追加ユーザーにアクセスするには、展開要求に ​[start-index:end-index]​ を追加します。たとえば、次の 1000 ユーザーにアクセスするには、​?expand=sharedUsers[1001:2000]​ を使用します。

  • subscriptions​: 検索条件にサブスクライブしているユーザーを返します。​subscriptions​ を指定しない場合、​subscriptions​ オブジェクトは返されますが、サブスクリプションはリストされません。返されるサブスクリプションのリストは 1000 個に制限され、追加サブスクリプションにアクセスするには、展開要求に ​[start-index:end-index]​ を追加します。たとえば、次の 1000 サブスクリプションにアクセスするには、​?expand=subscriptions[1001:2000]​ を使用します。

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Set Columns

<jira:update-rest-api3-filter-columns-by-id>

検索条件の列を設定します。ナビゲート可能な項目のみを列として設定できます。Jira のリスト項目を取得するには、[Get fields](#api-rest-api-3-field-get) を使用します。ナビゲート可能な項目の ​navigable​ は ​true​ に設定されています。このリソースのパラメーターは HTML フォームデータとして表されます。たとえば、curl では ​curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/filter/10000/columnsLeaving the Site​ のようになります。

必要な権限:

Jira にアクセスするための権限。ただし、列は次の検索条件に対してのみ設定されます。

  • ユーザーが所有する検索条件。

  • ユーザーがメンバーであるグループと共有される検索条件。

  • ユーザーが​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​を持っている非公開プロジェクトと共有される検索条件。

  • 公開プロジェクトと共有される検索条件。

  • 一般に共有される検索条件。

この操作では、/rest/api/3/filter/{id}/columns エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

検索条件の ID。

x

Body (本文)

Array of String (文字列の配列)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Set Default Share Scope

<jira:update-rest-api3-filter-default-share-scope>

ユーザーの新しい検索条件とダッシュボードのデフォルト共有を設定します。

必要な権限:

Jira にアクセスするための権限。

この操作では、/rest/api/3/filter/defaultShareScope エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Set Favourite For Filter

<jira:update-rest-api3-filter-favourite-by-id>

検索条件をユーザーのお気に入りとして追加します。

必要な権限:

Jira にアクセスするための権限。ただし、ユーザーは次の検索条件のみをお気に入りとすることができます。

  • ユーザーが所有する検索条件。

  • ユーザーがメンバーであるグループと共有される検索条件。

  • ユーザーが​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​を持っている非公開プロジェクトと共有される検索条件。

  • 公開プロジェクトと共有される検索条件。

  • 一般に共有される検索条件。

この操作では、/rest/api/3/filter/{id}/favourite エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

検索条件の ID。

x

expand (展開)

String (文字列)

expand​ を使用して、検索条件に関する追加情報を応答に含めます。このパラメーターは、カンマ区切りのリストを受け入れます。expand (展開) には次のオプションがあります。

  • sharedUsers​: 検索条件が共有されているユーザーを返します。これには、検索条件が共有されているプロジェクトを参照できるユーザーが含まれます。​sharedUsers​ を指定しない場合、​sharedUsers​ オブジェクトは返されますが、ユーザーはリストされません。返されるユーザーのリストは 1000 個に制限され、追加ユーザーにアクセスするには、展開要求に ​[start-index:end-index]​ を追加します。たとえば、次の 1000 ユーザーにアクセスするには、​?expand=sharedUsers[1001:2000]​ を使用します。

  • subscriptions​: 検索条件にサブスクライブしているユーザーを返します。​subscriptions​ を指定しない場合、​subscriptions​ オブジェクトは返されますが、サブスクリプションはリストされません。返されるサブスクリプションのリストは 1000 個に制限され、追加サブスクリプションにアクセスするには、展開要求に ​[start-index:end-index]​ を追加します。たとえば、次の 1000 サブスクリプションにアクセスするには、​?expand=subscriptions[1001:2000]​ を使用します。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Assign Issue

<jira:update-rest-api3-issue-assignee-by-issue-id-or-key>

課題をユーザーに割り当てます。この操作は、コール元ユーザーに、課題を含むプロジェクトに対する​「Edit Issues (課題の編集)」​権限がなく、​「Assign issue (課題の割り当て)」​権限がある場合に使用します。 ​accountId​ または ​name​ は次のように設定できます。

  • "-1"​: 課題はプロジェクトのデフォルトの担当者に割り当てられます。

  • null​: 画題は未割り当てに設定されます。この操作には匿名でアクセスできます。

必要な権限:

この操作では、/rest/api/3/issue/{issueIdOrKey}/assignee エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

割り当てる課題の ID またはキー。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Edit Issue

<jira:update-rest-api3-issue-by-issue-id-or-key>

課題を編集します。編集の一環として移行を適用し、課題プロパティを更新することができます。課題の項目の編集は、​update​ と ​fields​ を使用して定義されます。編集可能な項目は、[Get edit issue metadata](#api-rest-api-3-issue-issueIdOrKey-editmeta-get) を使用して判別されます。親項目はキーまたは ID により設定できます。標準の課題種別の場合、​update.parent.set.none​ を ​true​ に設定して親を削除できます。​description​、​environment​、および ​textarea​ 型のカスタム項目 (複数行のテキスト項目) は、Atlassian Document Format のコンテンツを使用します。単一行のカスタム項目 (​textfield​) は文字列を受け入れ、Atlassian Document Format のコンテンツを処理しません。管理者権限 (ユーザー権限とアプリケーションスコープから) のある Connect アプリケーションユーザーは、​overrideScreenSecurity​ と ​overrideEditableFlag​ を使用して画面のセキュリティ設定を上書きできます。この操作には匿名でアクセスできます。

必要な権限:

  • 課題を含むプロジェクトに対する​「Browse projects (プロジェクトの参照)」​および​「Edit issues (課題の編集)」 プロジェクト権限Leaving the Site​。

  • 課題レベルのセキュリティLeaving the Site​が設定されている場合、課題を表示する課題レベルのセキュリティ権限。

この操作では、/rest/api/3/issue/{issueIdOrKey} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

Notify Users (ユーザーに通知)

Boolean (ブール)

課題の更新に関する通知メールをすべてのウォッチャーに送信するかどうか。この通知を無効にするには、「administer Jira (Jira の管理)」または「administer project (プロジェクトの管理)」権限が必要です。必要な権限がユーザーにない場合、要求は無視されます。

true

Override Screen Security (画面セキュリティを上書き)

Boolean (ブール)

非表示項目を編集できるように画面のセキュリティを上書きする必要があるかどうか。管理者権限のある Connect アプリケーションユーザーが使用できます。

false

Override Editable Flag (編集可能なフラグを上書き)

Boolean (ブール)

編集不可の項目を編集できるように画面のセキュリティを上書きする必要があるかどうか。管理者権限のある Connect アプリケーションユーザーが使用できます。

false

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Comment

<jira:update-rest-api3-issue-comment-by-issue-id-or-key-id>

コメントを更新します。この操作には匿名でアクセスできます。

必要な権限:

この操作では、/rest/api/3/issue/{issueIdOrKey}/comment/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

id

String (文字列)

コメントの ID。

x

expand (展開)

String (文字列)

expand​ を使用して、コメントに関する追加情報を応答に含めます。このパラメーターは、HTML で表示されるコメント本文を返す ​renderedBody​ を受け入れます。

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Issue Link Type

<jira:update-rest-api3-issue-link-type-by-issue-link-type-id>

課題リンク種別を更新します。この操作を使用するには、サイトで 課題のリンクLeaving the Site​が有効になっている必要があります。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/issueLinkType/{issueLinkTypeId} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Link Type Id

String (文字列)

課題リンク種別の ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Set Issue Property

<jira:update-rest-api3-issue-properties-by-issue-id-or-key-property-key>

課題のプロパティの値を設定します。このリソースを使用して、課題に対するカスタムデータを保存します。リクエストボディの値は、 有効Leaving the Site​な空でない JSON blob である必要があります。最大長は 32768 文字です。この操作には匿名でアクセスできます。

必要な権限:

この操作では、/rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

Property Key (プロパティキー)

String (文字列)

課題プロパティのキー。最大長は 255 文字です。

x

Body (本文)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Bulk Set Issue Property

<jira:update-rest-api3-issue-properties-by-property-key>

複数の課題のプロパティ値を設定します。設定する値は定数にしたり、 Jira 式Leaving the Site​で決定したりできます。課題セットに適用する場合、式は一定の複雑さで計算できる必要があります。また、式は、すべての Jira 式に適用される 制限事項Leaving the Site​に準拠する必要があります。更新する課題は、検索条件により指定できます。検索条件では、次の条件を使用して更新対象の課題を特定します。

  • entityIds​: このリストの課題のみが対象となります。

  • currentValue​: この値に設定されたプロパティを使用する課題のみが対象となります。

  • hasProperty​: * ​true​ の場合、プロパティのある課題のみが対象になります。

  • false​ の場合、プロパティのない課題のみが対象になります。複数の条件を指定した場合、条件は論理 ​AND​ で結合されるため、すべての条件を満たす課題のみが対象になります。条件の無効な組み合わせを指定した場合、エラーが返されます。たとえば、​currentValue​ と ​hasProperty​ を ​false​ として指定した場合、どの課題にも一致しません (プロパティがない場合、プロパティは値を持つことができません)。

検索条件は省略可能です。検索条件がない場合、ユーザーが表示できるすべての課題のうち、ユーザーが EDIT\_ISSUES 権限を持っている課題が対象とみなされます。この操作は次の特性があります。

  • トランザクション型。対象のすべての課題が更新されるか、何も更新されません (エラーが発生した場合)。

  • [非同期](#async)。応答の ​location​ リンクに従ってタスクの状況を確認し、[Get task](#api-rest-api-3-task-taskId-get) を使用して後続の更新を取得します。

必要な権限:

この操作では、/rest/api/3/issue/properties/{propertyKey} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Property Key (プロパティキー)

String (文字列)

プロパティのキー。最大長は 255 文字です。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Remote Issue Link

<jira:update-rest-api3-issue-remotelink-by-issue-id-or-key-link-id>

課題のリモートの課題リンクを更新します。注意: 要求内で値のない項目は null に設定されます。この操作では、[課題のリンクがアクティブ](https://confluence.atlassian.com/x/yoXKMLeaving the Site) になっている必要があります。この操作には匿名でアクセスできます。

必要な権限:

  • 課題を含むプロジェクトに対する​「Browse projects (プロジェクトの参照)」​および​「Link issues (課題のリンク)」 プロジェクト権限Leaving the Site​。

  • 課題レベルのセキュリティLeaving the Site​が設定されている場合、課題を表示する課題レベルのセキュリティ権限。

この操作では、/rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

Link Id (リンク ID)

String (文字列)

リモート課題リンクの ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Worklog

<jira:update-rest-api3-issue-worklog-by-issue-id-or-key-id>

作業ログを更新します。Jira でタイムトラッキングを有効にする必要があります。有効にしないと、この操作でエラーが返されます。詳細は、 「Configuring time tracking (タイムトラッキングの設定)」Leaving the Site​を参照してください。この操作には匿名でアクセスできます。

必要な権限:

  • 課題を含むプロジェクトに対する​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

  • 課題レベルのセキュリティLeaving the Site​が設定されている場合、課題を表示する課題レベルのセキュリティ権限。

  • 任意の作業ログを更新するための​「Edit all worklogs (すべての作業ログの編集)」 プロジェクト権限Leaving the Site​、またはユーザーが作成した作業ログを更新するための​「Edit own worklogs (作業ログの編集)」​。

  • 作業ログの表示制限がある場合、グループに属しているか、表示が制限されているロールがある。

この操作では、/rest/api/3/issue/{issueIdOrKey}/worklog/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

id

String (文字列)

作業ログの ID。

x

Notify Users (ユーザーに通知)

Boolean (ブール)

課題を監視しているユーザーにメールで通知するかどうか。

true

Adjust Estimate (見積を調整)

Enumeration (列挙)。次のいずれかになります。

  • NEW

  • LEAVE

  • MANUAL

  • AUTO

課題の時間の見積を更新する方法を定義します。オプションは次のとおりです。

  • new​: newEstimate​ で定義された特定の値に見積を設定します。

  • leave​: 見積は変更されません。

  • auto​: timeSpent​ または ​timeSpentSeconds​ の元の値と更新された値との差で見積を更新します。

AUTO

New Estimate (新規見積)

String (文字列)

課題の残り時間の見積として設定する値 (日 (#d)、時間 (\#h)、または分 (\#m or \#))。たとえば、​2d​ と指定します。​adjustEstimate​ が ​new​ の場合は必須です。

expand (展開)

String (文字列)

expand​ を使用して、作業ログに関する追加情報を応答に含めます。このパラメーターは、作業ログのプロパティを返す ​properties​ を受け入れます。

Override Editable Flag (編集可能なフラグを上書き)

Boolean (ブール)

課題が編集可能でなくても作業ログを課題に追加する必要があるかどうか。たとえば、課題が閉じている場合です。管理者権限のある Connect アプリケーションユーザーのみがこのフラグを使用できます。

false

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Set Worklog Property

<jira:update-rest-api3-issue-worklog-properties-by-issue-id-or-key-worklog-id-property-key>

作業ログプロパティの値を設定します。この操作を使用して、作業ログに対するカスタムデータを保存します。リクエストボディの値は、[有効な](http://tools.ietf.org/html/rfc4627Leaving the Site) 空でない JSON blob である必要があります。最大長は 32768 文字です。この操作には匿名でアクセスできます。

必要な権限:

この操作では、/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Id Or Key (課題 ID またはキー)

String (文字列)

課題の ID またはキー。

x

Worklog Id (作業ログ ID)

String (文字列)

作業ログの ID。

x

Property Key (プロパティキー)

String (文字列)

課題プロパティのキー。最大長は 255 文字です。

x

Body (本文)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Issue Type

<jira:update-rest-api3-issuetype-by-id>

課題種別を更新します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/issuetype/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

課題種別の ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Set Issue Type Property

<jira:update-rest-api3-issuetype-properties-by-issue-type-id-property-key>

課題種別プロパティLeaving the Site​の値を作成または更新します。このリソースを使用して、課題種別に対するデータを保存および更新します。リクエストボディの値は、 有効Leaving the Site​な空でない JSON blob である必要があります。最大長は 32768 文字です。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Type Id (課題種別 ID)

String (文字列)

課題種別の ID。

x

Property Key (プロパティキー)

String (文字列)

課題種別プロパティのキー。最大長は 255 文字です。

x

Body (本文)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Issue Type Scheme

<jira:update-rest-api3-issuetypescheme-by-issue-type-scheme-id>

課題種別スキームを更新します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/issuetypescheme/{issueTypeSchemeId} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Type Scheme Id (課題種別スキーム ID)

Number (数値)

課題種別スキームの ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Add Issue Types To Issue Type Scheme

<jira:update-rest-api3-issuetypescheme-issuetype-by-issue-type-scheme-id>

課題種別を課題種別スキームに追加します。追加した課題種別は、課題種別リストに追加されます。いずれかの課題種別が課題種別スキームに存在する場合、操作は失敗し、どの課題種別も追加されません。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetype エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Type Scheme Id (課題種別スキーム ID)

Number (数値)

課題種別スキームの ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Reorder Issue Types In Issue Type Scheme

<jira:update-rest-api3-issuetypescheme-issuetype-move-by-issue-type-scheme-id>

課題種別スキーム内の課題種別の順序を変更します。リクエストボディパラメーターは次の要件を満たす必要があります。

  • すべての課題種別が課題種別スキームに属していること。

  • after​ または ​position​ のいずれかが指定されていること。

  • after​ 内の課題種別が課題種別リストに含まれていないこと。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetype/move エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Type Scheme Id (課題種別スキーム ID)

Number (数値)

課題種別スキームの ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Assign Issue Type Scheme To Project

<jira:update-rest-api3-issuetypescheme-project>

課題種別スキームをプロジェクトに割り当てます。プロジェクト内のいずれかの課題が、新しいスキームに存在しない課題種別に割り当てられている場合、操作は失敗します。割り当てを完了するには、新しいスキーム内の課題種別を使用するようにこの課題を更新する必要があります。課題種別スキームは従来のプロジェクトにのみ割り当てることができます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/issuetypescheme/project エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Issue Type Screen Scheme

<jira:update-rest-api3-issuetypescreenscheme-by-issue-type-screen-scheme-id>

課題種別画面スキームを更新します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Type Screen Scheme Id (課題種別画面スキーム ID)

String (文字列)

課題種別画面スキームの ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Append Mappings For Issue Type Screen Scheme

<jira:update-rest-api3-issuetypescreenscheme-mapping-by-issue-type-screen-scheme-id>

課題種別と画面スキームのマッピングを課題種別画面スキームに追加します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Type Screen Scheme Id (課題種別画面スキーム ID)

String (文字列)

課題種別画面スキームの ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Default Screen Scheme

<jira:update-rest-api3-issuetypescreenscheme-mapping-default-by-issue-type-screen-scheme-id>

課題種別画面スキームのデフォルト画面スキームを更新します。デフォルト画面スキームは、マップされていないすべての課題種別で使用されます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping/default エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Issue Type Screen Scheme Id (課題種別画面スキーム ID)

String (文字列)

課題種別画面スキームの ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Assign Issue Type Screen Scheme To Project

<jira:update-rest-api3-issuetypescreenscheme-project>

課題種別画面スキームをプロジェクトに割り当てます。課題種別画面スキームは従来のプロジェクトにのみ割り当てることができます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/issuetypescreenscheme/project エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Set Preference

<jira:update-rest-api3-mypreferences>

プレーンテキスト文字列を送信して、ユーザーのプリファレンスを作成したり、プリファレンスの値を更新したりします。例: false​。最大 255 文字を含む値で任意のプリファレンスを作成できます。また、次のキーで、設定または作成できるシステムプリファレンスを定義します。

  • user.notifications.mimetype​ ユーザーに送信する通知で使用する MIME タイプ。デフォルトは ​html​ です。

  • user.notify.own.changes​: ユーザー自身が行った変更をユーザーに通知するかどうか。デフォルトは ​false​ です。

  • user.default.share.private​: 新しい [検索条件](https://confluence.atlassian.com/x/eQiiLQLeaving the Site) を非公開に設定するかどうか。デフォルトは ​true​ です。

  • user.keyboard.shortcuts.disabled​: キーボードショートカットを無効にするかどうか。デフォルトは ​false​ です。

  • user.autowatch.disabled​: ユーザーが作成した課題やユーザーがコメントを追加した課題をユーザーが自動的にウォッチするかどうか。デフォルトでは、設定されません。ユーザーはインスタンスの自動ウォッチ設定を使用します。次のキーは非推奨です。

  • jira.user.locale​ ユーザーのロケール。デフォルトでは、設定されていません。ユーザーにはインスタンスのロケールが設定されます。

  • jira.user.timezone​ ユーザーのタイムゾーン。デフォルトでは、設定されていません。ユーザーにはインスタンスのタイムゾーンが設定されます。代わりにタイムゾーンとロケールを管理するには、ユーザー管理 REST API の Update a user profileLeaving the Site​ を使用します。

必要な権限:

Jira にアクセスするための権限。

この操作では、/rest/api/3/mypreferences エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

key (キー)

String (文字列)

設定のキー。最大長は 255 文字です。

x

Body (本文)

String (文字列)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Permission Scheme

<jira:update-rest-api3-permissionscheme-by-scheme-id>

権限スキームを更新します。このリソースを使用する場合に注意すべき重要な点を次にいくつか示します。

  • 要求に権限リストが存在する場合、その権限リストが権限スキームに設定され、​すべての既存の​権限付与が上書きされます。

  • 名前と説明のみを更新する場合は、要求で権限リストを送信しないでください。

  • 空のリストを送信すると、すべての権限付与が権限スキームから削除されます。リスト全体を更新する代わりに 1 つの権限付与を追加または削除する場合は、[Create permission grant](api-rest-api-3-permissionscheme-schemeId-permission-post) または [Delete permission scheme entity](api-rest-api-3-permissionscheme-schemeId-permission-permissionId-delete) を参照してください。詳細は、[「権限スキームおよび付与について」](about-permission-schemes) を参照してください。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/permissionscheme/{schemeId} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Scheme Id (スキーム ID)

Number (数値)

更新する権限スキームの ID。

x

expand (展開)

String (文字列)

expand​ を使用して、追加情報を応答に含めます。このパラメーターは、カンマ区切りのリストを受け入れます。値を指定すると、権限は常に含まれるます。expand (展開) には次のオプションがあります。

  • all​: すべての展開可能な情報を返します。

  • field​: 権限が付与されたカスタム項目に関する情報を返します。

  • group​: 権限が付与されたグループに関する情報を返します。

  • permissions​: 各権限スキームのすべての権限付与を返します。

  • projectRole​: 権限が付与されたプロジェクトロールに関する情報を返します。

  • user​: 権限が付与されたユーザーに関する情報を返します。

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Project Avatar

<jira:update-rest-api3-project-avatar-by-project-id-or-key>

プロジェクトで表示するアバターを設定します。この操作を使用して表示されるアバターを設定する前に、[Load project avatar](#api-rest-api-3-project-projectIdOrKey-avatar2-post) を使用してプロジェクトに対するアバターを保存します。

必要な権限:

「Administer projects (プロジェクトの管理)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/project/{projectIdOrKey}/avatar エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Id Or Key (プロジェクト ID またはキー)

String (文字列)

プロジェクトの ID または (大文字と小文字を区別する) キー。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Project

<jira:update-rest-api3-project-by-project-id-or-key>

プロジェクトの [プロジェクト詳細](https://confluence.atlassian.com/x/ahLpNwLeaving the Site) を更新します。リクエストボディ内のすべてのパラメーターが省略可能です。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/project/{projectIdOrKey} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Id Or Key (プロジェクト ID またはキー)

String (文字列)

プロジェクト ID またはプロジェクトキー (大文字と小文字を区別)。

x

expand (展開)

String (文字列)

expand​ を使用して、追加情報を応答に含めます。このパラメーターは、カンマ区切りのリストを受け入れます。プロジェクトの説明、課題種別、およびプロジェクトリーダーは、デフォルトですべての応答に含まれます。expand (展開) には次のオプションがあります。

  • description​: プロジェクトの説明。

  • issueTypes​: プロジェクトに関連付けられた課題種別。

  • lead​: プロジェクトリーダー。 *​projectKeys​ プロジェクトに関連付けられたすべてのプロジェクトキー。

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Project Category

<jira:update-rest-api3-project-category-by-id>

プロジェクトカテゴリを更新します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/projectCategory/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

id

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Project Email

<jira:update-rest-api3-project-email-by-project-id>

[プロジェクトの送信者メールアドレス](https://confluence.atlassian.com/x/dolKLgLeaving the Site) を設定します。​emailAddress​ が空の文字列の場合、デフォルトのメールアドレスが復元されます。

必要な権限:

プロジェクトに対する​「Browse projects (プロジェクトの参照)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/project/{projectId}/email エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Id (プロジェクト ID)

Number (数値)

プロジェクト ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Assign Permission Scheme

<jira:update-rest-api3-project-permissionscheme-by-project-key-or-id>

権限スキームをプロジェクトに割り当てます。権限スキームについての詳細は、 「Managing project permissions (プロジェクト権限の管理)」Leaving the Site​を参照してください。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/project/{projectKeyOrId}/permissionscheme エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Key Or Id (プロジェクトキーまたは ID)

String (文字列)

プロジェクト ID またはプロジェクトキー (大文字と小文字を区別)。

x

expand (展開)

String (文字列)

expand​ を使用して、追加情報を応答に含めます。このパラメーターは、カンマ区切りのリストを受け入れます。値を指定すると、権限が含まれます。expand (展開) には次のオプションがあります。

  • all​: すべての展開可能な情報を返します。

  • field​: 権限が付与されたカスタム項目に関する情報を返します。

  • group​: 権限が付与されたグループに関する情報を返します。

  • permissions​: 各権限スキームのすべての権限付与を返します。

  • projectRole​: 権限が付与されたプロジェクトロールに関する情報を返します。

  • user​: 権限が付与されたユーザーに関する情報を返します。

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Set Project Property

<jira:update-rest-api3-project-properties-by-project-id-or-key-property-key>

プロジェクトプロパティLeaving the Site​の値を設定します。プロジェクトプロパティを使用して、プロジェクトに対するカスタムデータを保存できます。リクエストボディの値は、 有効Leaving the Site​な空でない JSON blob である必要があります。最大長は 32768 文字です。

この操作には匿名でアクセスできます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​、またはプロパティの作成先のプロジェクトに対する​「Administer Projects (プロジェクトの管理)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/project/{projectIdOrKey}/properties/{propertyKey} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Id Or Key (プロジェクト ID またはキー)

String (文字列)

プロジェクト ID またはプロジェクトキー (大文字と小文字を区別)。

x

Property Key (プロパティキー)

String (文字列)

プロジェクトプロパティのキー。最大長は 255 文字です。

x

Body (本文)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Set Actors

<jira:update-rest-api3-project-role-by-project-id-or-key-id>

プロジェクトのプロジェクトロールのアクターを設定し、すべての既存のアクターを置き換えます。既存のリストを上書きすることなくプロジェクトにアクターを追加するには、[Add actors to project role](#api-rest-api-3-project-projectIdOrKey-role-id-post) を使用します。

必要な権限:

プロジェクトに対する​「Administer Projects (プロジェクトの管理)」 プロジェクト権限Leaving the Site​、または​「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/project/{projectIdOrKey}/role/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Project Id Or Key (プロジェクト ID またはキー)

String (文字列)

プロジェクト ID またはプロジェクトキー (大文字と小文字を区別)。

x

id

Number (数値)

プロジェクトロールの ID。[Get all project roles](#api-rest-api-3-role-get) を使用して、プロジェクトロール ID のリストを取得します。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Fully Update Project Role

<jira:update-rest-api3-role-by-id>

プロジェクトロールの名前と説明を更新します。名前と説明の両方を要求に含める必要があります。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/role/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

プロジェクトロールの ID。[Get all project roles](#api-rest-api-3-role-get) を使用して、プロジェクトロール ID のリストを取得します。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Screen

<jira:update-rest-api3-screens-by-screen-id>

画面を更新します。従来のプロジェクトで使用されている画面のみを更新できます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/screens/{screenId} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Screen Id (画面 ID)

Number (数値)

画面の ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Rename Screen Tab

<jira:update-rest-api3-screens-tabs-by-screen-id-tab-id>

画面タブの名前を更新します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/screens/{screenId}/tabs/{tabId} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Screen Id (画面 ID)

Number (数値)

画面の ID。

x

Tab Id (タブ ID)

Number (数値)

画面タブの ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Screen Scheme

<jira:update-rest-api3-screenscheme-by-screen-scheme-id>

画面スキームを更新します。従来のプロジェクトで使用されている画面スキームのみを更新できます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/screenscheme/{screenSchemeId} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Screen Scheme Id (画面スキーム ID)

String (文字列)

画面スキームの ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Set Issue Navigator Default Columns

<jira:update-rest-api3-settings-columns>

デフォルトの課題ナビゲーター列を設定します。​columns​ パラメーターはナビゲート可能な項目値を受け入れ、HTML フォームデータとして表されます。複数の列を指定するには、複数の ​columns​ パラメーターを渡します。たとえば、curl では、​curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/settings/columnsLeaving the Site​ のようになります。列の詳細を送信しない場合、すべてのデフォルト列が削除されます。ナビゲート可能な項目は、課題ナビゲーターの列として使用できる項目です。ナビゲート可能な課題列の詳細を参照するには、[Get fields](#api-rest-api-3-field-get) を使用します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/settings/columns エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Array of String (文字列の配列)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Set User Columns

<jira:update-rest-api3-user-columns>

ユーザーのデフォルトの 課題テーブル列Leaving the Site​を設定します。アカウント ID を渡さない場合、コール元ユーザーのデフォルト列が設定されます。列の詳細を送信しない場合、すべてのデフォルト列が削除されます。このリソースのパラメーターは HTML フォームデータとして表されます。たとえば、curl では ​curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/user/columns?accountId=5b10ac8d82e05b22cc7d4ef5'Leaving the Site​ のようになります。

必要な権限:

  • 他のユーザーの権限を確認する場合は​「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

  • コール元ユーザーの列を設定する場合は Jira へのアクセス権。

この操作では、/rest/api/3/user/columns エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Account Id (アカウント ID)

String (文字列)

ユーザーのアカウント ID。これは、すべての Atlassian 製品でユーザーを一意に識別します。例: 5b10ac8d82e05b22cc7d4ef5​。

Body (本文)

Array of String (文字列の配列)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Set User Property

<jira:update-rest-api3-user-properties-by-property-key>

ユーザーのプロパティの値を設定します。このリソースを使用して、ユーザーに対するカスタムデータを保存します。注意: この操作は、Jira で作成および管理されている ユーザープロパティLeaving the Site​にはアクセスしません。

必要な権限:

  • 「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。任意のユーザーのプロパティを設定します。

  • Jira へのアクセス権。コール元ユーザーのレコードのプロパティを設定します。

この操作では、/rest/api/3/user/properties/{propertyKey} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Property Key (プロパティキー)

String (文字列)

ユーザーのプロパティのキー。最大長は 255 文字です。

x

Account Id (アカウント ID)

String (文字列)

ユーザーのアカウント ID。これは、すべての Atlassian 製品でユーザーを一意に識別します。例: 5b10ac8d82e05b22cc7d4ef5​。

User Key (ユーザーキー)

String (文字列)

このパラメーターは使用できなくなり、まもなくドキュメントから削除されます。詳細は、 廃止通知Leaving the Site​を参照してください。

username (ユーザー名)

String (文字列)

このパラメーターは使用できなくなり、まもなくドキュメントから削除されます。詳細は、 廃止通知Leaving the Site​を参照してください。

Body (本文)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Version

<jira:update-rest-api3-version-by-id>

プロジェクトバージョンを更新します。この操作には匿名でアクセスできます。

必要な権限:

バージョンを含むプロジェクトに対する​「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​または​「Administer Projects (プロジェクトの管理)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/version/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

バージョンの ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Merge Versions

<jira:update-rest-api3-version-mergeto-by-id-move-issues-to>

2 つのプロジェクトバージョンをマージします。マージでは、​id​ で指定されたバージョンが削除され、​fixVersion​ に出現する該当のすべての ID が、​moveIssuesTo​ で指定されたバージョン ID に置き換えられます。代わりに [Delete and replace version](#api-rest-api-3-version-id-removeAndSwap-post) を使用することを考慮してください。このリソースでは、​fixVersion​、​affectedVersion​、およびカスタム項目のバージョン値のスワップがサポートされます。この操作には匿名でアクセスできます。

必要な権限:

バージョンを含むプロジェクトに対する​「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​または​「Administer Projects (プロジェクトの管理)」 プロジェクト権限Leaving the Site​。

この操作では、/rest/api/3/version/{id}/mergeto/{moveIssuesTo} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

削除するバージョンの ID。

x

Move Issues To (課題の移動先)

String (文字列)

マージ先のバージョンの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Refresh Webhooks

<jira:update-rest-api3-webhook-refresh>

REST API を介して登録された Web フックは、30 日後に期限切れになります。このリソースを定期的にコールして、有効な状態を維持します。(存在しないまたは他のアプリケーションに属している) 認識されない Web フック ID は無視されます。

必要な権限:

Connect アプリケーションLeaving the Site​のみがこの操作を使用できます。

この操作では、/rest/api/3/webhook/refresh エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Workflow Transition Rule Configurations

<jira:update-rest-api3-workflow-rule-config>

ワークフロー移行ルールの設定を更新します。以下のルール種別がサポートされています。

コール元の Connect アプリケーションで作成されたルールのみを更新できます。

必要な権限:

Connect アプリケーションのみがこの操作を使用できます。

この操作では、/rest/api/3/workflow/rule/config エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Workflow Transition Property

<jira:update-rest-api3-workflow-transitions-properties-by-transition-id>

プロパティ値を変更することで、ワークフロー移行を更新します。存在しないプロパティを更新すると、新しいプロパティが移行に追加されます。移行のプロパティは、移行の動作を変更するために使用されます。詳細は、 「Transition properties (移行のプロパティ)」Leaving the Site​と 「Workflow properties (ワークフローのプロパティ)」Leaving the Site​を参照してください。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflow/transitions/{transitionId}/properties エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Transition Id (移行 ID)

Number (数値)

移行の ID。ID を取得するには、Jira 管理者設定でワークフローをテキストモードで表示します。ID は移行の横に表示されます。

x

key (キー)

String (文字列)

更新するプロパティのキー (プロパティの名前とも呼ばれる)。これをリクエストボディで定義されている ​key​ と同じ値に設定します。

x

Workflow Name (ワークフロー名)

String (文字列)

移行が属するワークフローの名前。

x

Workflow Mode (ワークフローモード)

Enumeration (列挙)。次のいずれかになります。

  • LIVE

  • DRAFT (ドラフト)

ワークフロー状況。非アクティブなワークフローの場合は ​live​、ドラフトワークフローの場合は ​draft​ に設定します。アクティブなワークフローは編集できません。

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Workflow Scheme

<jira:update-rest-api3-workflowscheme-by-id>

名前、デフォルトワークフロー、課題種別とプロジェクト間のマッピングなど、ワークフロースキームを更新します。ワークフロースキームがアクティブな (つまり、1 つ以上のプロジェクトで使用されている) 場合、​updateDraftIfNeeded​ が ​true​ に設定されていると、代わりにドラフトワークフロースキームが作成または更新されます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflowscheme/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

ワークフロースキームの ID。この ID を見つけるには、Jira で目的のワークフロースキームを編集します。ID は URL に ​schemeId​ として表示されます。例: schemeId=10301​。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Default Workflow

<jira:update-rest-api3-workflowscheme-default-by-id>

ワークフロースキームのデフォルトワークフローを設定します。アクティブなワークフロースキームは編集できません。ワークフロースキームがアクティブな場合、要求オブジェクトで ​updateDraftIfNeeded​ を ​true​ に設定すると、新しいデフォルトワークフローでドラフトワークフロースキームが作成または更新されます。ドラフトワークフロースキームは Jira でパブリッシュできます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflowscheme/{id}/default エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

ワークフロースキームの ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Workflow Scheme Draft

<jira:update-rest-api3-workflowscheme-draft-by-id>

ドラフトワークフロースキームを更新します。アクティブなワークフロースキームのドラフトワークフロースキームが存在しない場合、ドラフトが作成されます。アクティブなワークフロースキームは、1 つのドラフトワークフロースキームのみを持つことができます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflowscheme/{id}/draft エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

ドラフトの作成元であるアクティブなワークフロースキームの ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Draft Default Workflow

<jira:update-rest-api3-workflowscheme-draft-default-by-id>

ワークフロースキームのドラフトのデフォルトワークフローを設定します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflowscheme/{id}/draft/default エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

ドラフトが属するワークフロースキームの ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Set Workflow Scheme Draft Issue Type

<jira:update-rest-api3-workflowscheme-draft-issuetype-by-id-issue-type>

ワークフロースキームのドラフト内の課題種別のワークフローを設定します。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site​。

この操作では、/rest/api/3/workflowscheme/{id}/draft/issuetype/{issueType} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

ドラフトが属するワークフロースキームの ID。

x

Issue Type (課題種別)

String (文字列)

課題種別の ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Draft Workflow Mapping

<jira:update-rest-api3-workflowscheme-draft-workflow-by-id>

ワークフロースキームのドラフト内のワークフローの課題種別を設定します。ワークフローは、ドラフトワークフロースキームのデフォルトワークフローとして設定することもできます。マップされていない課題種別はデフォルトワークフローにマップされます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflowscheme/{id}/draft/workflow エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

ドラフトが属するワークフロースキームの ID。

x

Workflow Name (ワークフロー名)

String (文字列)

ワークフローの名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Set Workflow Scheme Issue Type

<jira:update-rest-api3-workflowscheme-issuetype-by-id-issue-type>

ワークフロースキーム内の課題種別のワークフローを設定します。アクティブなワークフロースキームは編集できません。ワークフロースキームがアクティブな場合、リクエストボディで ​updateDraftIfNeeded​ を ​true​ に設定すると、新しい課題種別-ワークフローマッピングでドラフトワークフロースキームが作成または更新されます。ドラフトワークフロースキームは Jira でパブリッシュできます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflowscheme/{id}/issuetype/{issueType} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

ワークフロースキームの ID。

x

Issue Type (課題種別)

String (文字列)

課題種別の ID。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Associate Scheme With Project

<jira:update-rest-api3-workflowscheme-project>

ワークフロースキームをプロジェクトに割り当てます。この操作は、プロジェクトに課題がない場合にのみ実行されます。ワークフロースキームは従来のプロジェクトにのみ割り当てることができます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflowscheme/project エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Update Workflow Mapping

<jira:update-rest-api3-workflowscheme-workflow-by-id>

ワークフロースキーム内のワークフローの課題種別を設定します。ワークフローは、ワークフロースキームのデフォルトワークフローとして設定することもできます。マップされていない課題種別はデフォルトワークフローにマップされます。アクティブなワークフロースキームは編集できません。ワークフロースキームがアクティブな場合、リクエストボディで ​updateDraftIfNeeded​ を ​true​ に設定すると、新しいワークフロー-課題種別マッピングでドラフトワークフロースキームが作成または更新されます。ドラフトワークフロースキームは Jira でパブリッシュできます。

必要な権限:

「Administer Jira (Jira の管理)」 グローバル権限Leaving the Site

この操作では、/rest/api/3/workflowscheme/{id}/workflow エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

Number (数値)

ワークフロースキームの ID。

x

Workflow Name (ワークフロー名)

String (文字列)

ワークフローの名前。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

Addon Properties Resource put Addon Property put

<jira:update-rest-atlassian-connect1-addons-properties-by-addon-key-property-key>

アプリケーションのプロパティの値を設定します。このリソースを使用して、アプリケーションに対するカスタムデータを保存します。リクエストボディの値は、[有効な](http://tools.ietf.org/html/rfc4627Leaving the Site) 空でない JSON blob である必要があります。最大長は 32768 文字です。

必要な権限:

この要求を実行できるのは、キーが ​addonKey​ に一致する Connect アプリケーションのみです。

この操作では、/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Addon Key (アドオンキー)

String (文字列)

記述子で定義されるアプリケーションのキー。

x

Property Key (プロパティキー)

String (文字列)

プロパティのキー。

x

Body (本文)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Response Timeout (応答タイムアウト)​ の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値を ​AUTO​ に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • JIRA:BAD_REQUEST

  • JIRA:CLIENT_ERROR

  • JIRA:CONNECTIVITY

  • JIRA:INTERNAL_SERVER_ERROR

  • JIRA:NOT_ACCEPTABLE

  • JIRA:NOT_FOUND

  • JIRA:RETRY_EXHAUSTED

  • JIRA:SERVER_ERROR

  • JIRA:SERVICE_UNAVAILABLE

  • JIRA:TIMEOUT

  • JIRA:TOO_MANY_REQUESTS

  • JIRA:UNAUTHORIZED

  • JIRA:UNSUPPORTED_MEDIA_TYPE

ソース

On New Issue Trigger

<jira:on-new-issue-trigger>

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Start Date (開始日)

String (文字列)

課題が作成された日付。日付の形式は yyyy-mm-dd です。

x

Project Id or Key (プロジェクト ID またはキー)

String (文字列)

プロジェクト ID またはプロジェクトキー (大文字と小文字を区別)。

Status (状況)

String (文字列)

課題の状況。

Priority (優先度)

String (文字列)

課題の優先度。

Issue Type (課題種別)

String (文字列)

課題種別。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Primary Node Only (プライマリノードのみ)

Boolean (ブール)

クラスターでの実行時、このソースをプライマリノード上でのみ実行する必要があるかどうか。

Scheduling Strategy (スケジュール戦略)

scheduling-strategy

ポーリングをトリガーするスケジューラーを設定します。

x

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Redelivery Policy (再配信ポリシー)

Redelivery Policy (再配信ポリシー)

同じメッセージの再配信を処理するためのポリシーを定義します。

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

On new and updated issue trigger

<jira:on-updated-issue-trigger>

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Start Date (開始日)

String (文字列)

課題が更新された日付。日付の形式は yyyy-mm-dd です。

x

Project Id or Key (プロジェクト ID またはキー)

String (文字列)

プロジェクト ID またはプロジェクトキー (大文字と小文字を区別)。

Status (状況)

String (文字列)

課題の状況。

Priority (優先度)

String (文字列)

課題の優先度。

Issue Type (課題種別)

String (文字列)

課題種別。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Primary Node Only (プライマリノードのみ)

Boolean (ブール)

クラスターでの実行時、このソースをプライマリノード上でのみ実行する必要があるかどうか。

Scheduling Strategy (スケジュール戦略)

scheduling-strategy

ポーリングをトリガーするスケジューラーを設定します。

x

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Redelivery Policy (再配信ポリシー)

Redelivery Policy (再配信ポリシー)

同じメッセージの再配信を処理するためのポリシーを定義します。

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

型

Default Header (デフォルトヘッダー)

項目 型 説明 デフォルト値 必須

Key (キー)

String (文字列)

x

Value (値)

String (文字列)

x

Default Query Param (デフォルトクエリパラメーター)

項目 型 説明 デフォルト値 必須

Key (キー)

String (文字列)

x

Value (値)

String (文字列)

x

Proxy (プロキシ)

項目 型 説明 デフォルト値 必須

Host (ホスト)

String (文字列)

x

Port (ポート)

Number (数値)

x

Username (ユーザー名)

String (文字列)

Password (パスワード)

String (文字列)

Non Proxy Hosts (非プロキシホスト)

String (文字列)

TLS

項目 型 説明 デフォルト値 必須

Enabled Protocols (有効化されたプロトコル)

String (文字列)

このコンテキストで有効化されたプロトコルのカンマ区切りリスト。

Enabled Cipher Suites (有効化された暗号化スイート)

String (文字列)

このコンテキストで有効化された暗号化スイートのカンマ区切りリスト。

Trust Store (トラストストア)

​トラストストア​

Key Store (キーストア)

​Key Store (キーストア)​

Revocation Check (取り消し確認)

トラストストア

項目 型 説明 デフォルト値 必須

Path (パス)

String (文字列)

トラストストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。

Password (パスワード)

String (文字列)

トラストストアを保護するために使用するパスワード。

Type (型)

String (文字列)

使用するストアの型。

Algorithm (アルゴリズム)

String (文字列)

トラストストアで使用するアルゴリズム。

Insecure (安全ではない)

Boolean (ブール)

true の場合、証明書の検証が実行されず、攻撃に対して接続が脆弱になります。各自の責任で使用してください。

Key Store (キーストア)

項目 型 説明 デフォルト値 必須

Path (パス)

String (文字列)

キーストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。

Type (型)

String (文字列)

使用するストアの型。

Alias (別名)

String (文字列)

キーストアに多数の非公開キーがある場合、この属性は、使用するキーの別名を示します。定義しない場合、デフォルトでファイル内の最初の鍵が使用されます。

Key Password (キーパスワード)

String (文字列)

非公開キーを保護するために使用するパスワード。

Password (パスワード)

String (文字列)

キーストアを保護するために使用するパスワード。

Algorithm (アルゴリズム)

String (文字列)

キーストアで使用するアルゴリズム。

Standard Revocation Check (標準の取り消し確認)

項目 型 説明 デフォルト値 必須

Only End Entities (最後のエンティティのみ)

Boolean (ブール)

証明書チェーンの最後の要素のみを確認します。

Prefer Crls (CRL を優先)

Boolean (ブール)

最初に OCSP ではなく CRL を試みます。

No Fallback (代替なし)

Boolean (ブール)

第 2 の確認方法 (以前に選択されていない方法) を使用しません。

Soft Fail (ソフトフェール)

Boolean (ブール)

取り消しサーバーに到達できない場合や取り消しサーバーが混雑している場合に検証エラーを回避します。

Custom Ocsp Responder (カスタム Ocsp レスポンダー)

項目 型 説明 デフォルト値 必須

Url

String (文字列)

OCSP レスポンダーの URL。

Cert Alias (証明書の別名)

String (文字列)

(トラストストアに含まれている) OCSP 応答の署名証明書の別名 (存在する場合)。

Crl File (Crl ファイル)

項目 型 説明 デフォルト値 必須

Path (パス)

String (文字列)

CRL ファイルへのパス。

Reconnection (再接続)

項目 型 説明 デフォルト値 必須

Fails Deployment (デプロイに失敗)

Boolean (ブール)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Reconnection Strategy (再接続戦略)

使用する再接続戦略。

Reconnect (再接続)

項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Blocking (ブロック)

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

Count (数)

Number (数値)

再接続を試みる回数。

Reconnect Forever (繰り返し再接続)

項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Blocking (ブロック)

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

Expiration Policy (有効期限ポリシー)

項目 型 説明 デフォルト値 必須

Max Idle Time (最大アイドル時間)

Number (数値)

有効期限の対象とみなされるまで、動的設定インスタンスがアイドル状態を維持できる最大時間のスカラー時間値。

Time Unit (時間単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

maxIdleTime 属性の時間単位。

Http Response Attributes (HTTP 応答属性)

項目 型 説明 デフォルト値 必須

Status Code (状況コード)

Number (数値)

x

Headers (ヘッダー)

Object (オブジェクト)

x

Reason Phrase (理由を示す語句)

String (文字列)

x

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)

項目 型 説明 デフォルト値 必須

Initial Buffer Size (初期バッファサイズ)

Number (数値)

これは、ストリームをコンシュームし、ストリームへのランダムアクセスを提供する目的で割り当てられるメモリの容量です。ストリームに含まれているデータがこのバッファに適合できる量を超えている場合、bufferSizeIncrement 属性に従って拡張され、上限は maxInMemorySize となります。

Buffer Size Increment (バッファサイズ増分)

Number (数値)

バッファサイズが初期サイズを超えた場合に、どれだけ拡張するか。値を 0 以下に設定すると、バッファが拡張されません。つまり、バッファがフルになると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。

Max Buffer Size (最大バッファサイズ)

Number (数値)

使用するメモリの最大量。これを超えると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。0 以下の値は無制限を意味します。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE

  • KB

  • MB

  • GB

これらのすべての属性の単位

Repeatable File Store Stream (反復可能なファイルストアストリーム)

項目 型 説明 デフォルト値 必須

In Memory Size (メモリ内サイズ)

Number (数値)

データをメモリ内に保持するためにストリームで使用する最大メモリを定義します。これを超えると、ディスクへのコンテンツのバッファが開始されます。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE

  • KB

  • MB

  • GB

maxInMemorySize で表される単位

Redelivery Policy (再配信ポリシー)

エラーを生成する要求を実行するための再配信ポリシーを設定します。再配信ポリシーは、フロー内のあらゆる提供元に追加できます。

項目 型 説明 デフォルト値 必須

Max Redelivery Count (最大再配信数)

Number (数値)

​REDELIVERY_EXHAUSTED​ エラーが返されるまでに、配信された要求が処理に失敗できる最大回数。

Message Digest Algorithm (メッセージダイジェストアルゴリズム)

String (文字列)

​[Use Secure Hash (セキュアハッシュを使用)]​ 項目が ​true​ の場合に使用するセキュアハッシュアルゴリズム。メッセージのペイロードが Java オブジェクトの場合、Mule ではこの値が無視され、ペイロードの ​hashCode()​ が返した値が返されます。

Message Identifier (メッセージ識別子)

​Redelivery Policy Message Identifier (再配信ポリシーメッセージ識別子)​

Mule での反復可能ストリームの無効化の基準となる反復不可能ストリーミング戦略を設定します。ユースケースでコンテンツの読み取りが 1 回のみ必要な場合に、この戦略を使用します。

Object Store (オブジェクトストア)

ObjectStore

各メッセージの再配信カウンターが保存されるオブジェクトストアを設定します。

Redelivery Policy Message Identifier (再配信ポリシーメッセージ識別子)

再配信されたメッセージを識別する方法と、メッセージがいつ再配信されたのかを見つける方法を設定します。

項目 型 説明 デフォルト値 必須

Use Secure Hash (セキュアハッシュを使用)

Boolean (ブール)

​true​ の場合、再配信されたメッセージの識別にセキュアハッシュアルゴリズムが使用されます。

Id Expression (ID の式)

String (文字列)

メッセージがいつ再配信されたのかを判断する 1 つ以上の式。このプロパティは、​[Use Secure Hash (セキュアハッシュを使用)]​ 項目が ​false​ の場合にのみ設定できます。

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)

項目 型 説明 デフォルト値 必須

Initial Buffer Size (初期バッファサイズ)

Number (数値)

これは、ストリームをコンシュームし、ストリームへのランダムアクセスを提供する目的で、メモリ内に保持することが許可されるインスタンスの初期容量です。このバッファに収めることができる量よりも多くのデータがストリームに含まれる場合、バッファは、bufferSizeIncrement 属性に従って maxInMemorySize の上限まで拡張されます。デフォルト値は 100 インスタンスです。

Buffer Size Increment (バッファサイズ増分)

Number (数値)

これは、初期サイズを超えた場合に、バッファサイズがどれだけ拡張されるかです。値を 0 以下に設定すると、バッファが拡張されません。つまり、バッファがフルになると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。デフォルト値は 100 インスタンスです。

Max Buffer Size (最大バッファサイズ)

Number (数値)

使用するメモリの最大量。これを超えると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。0 以下の値は無制限を意味します。

Repeatable File Store Iterable (反復可能なファイルストアイテラブル)

項目 型 説明 デフォルト値 必須

In Memory Objects (メモリ内オブジェクト)

Number (数値)

メモリ内に保持されるインスタンスの最大量。これ以上の量が必要な場合、コンテンツはディスク上にバッファされます。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE

  • KB

  • MB

  • GB

maxInMemorySize で表される単位