This topic applies only to the IBM Business Process Manager Advanced configuration.

HTTP ヘッダー・フィールドと汎用 URI パラメーター

IBM® Business Process Manager REST リソースの URI は、特定の HTTP ヘッダー・フィールドと汎用 URI パラメーターをサポートしています。

以下の HTTP ヘッダー・フィールドは、すべての REST リソースによってサポートされています。
表 1. サポートされる HTTP ヘッダー・フィールド
フィールド名 説明
Accept 応答メッセージで許容されるメディア・タイプを指定するために要求メッセージで使用されます。 要求されたコンテンツ・タイプでサーバーが応答できない場合は、406 Not Acceptable HTTP 状況コードが戻されます。

要求が BPD 関連リソースに対するものである場合は、HTTP ヘッダー・フィールドの代わりに対応する URI パラメーターを使用できます。

Accept-Encoding 応答メッセージで許容されるコンテンツ・エンコードを制限するために要求メッセージで使用されます。 値を指定しない場合、応答メッセージのエンコードはデフォルトで identity (エンコードなし) に設定されます。

リストされたコンテンツ・エンコードのいずれによってもサーバーが応答できない場合は、406 Not Acceptable HTTP 状況コードが戻されます。

要求が BPD 関連リソースに対するものである場合は、HTTP ヘッダー・フィールドの代わりに対応する URI パラメーターを使用できます。

Accept-Language 応答メッセージで許容される言語のリストを送信するために要求メッセージで使用されます。 例えば、"Accept-Language: da, en-gb" は、優先される言語はデンマーク語ですが、英語 (英国) も許容されることを意味します。

要求が BPD 関連リソースに対するものである場合は、HTTP ヘッダー・フィールドの代わりに対応する URI パラメーターを使用できます。

Content-Encoding エンティティー本体で使用されるコンテンツ・エンコードを示します。非サポートのコンテンツ・エンコードを指定すると、415 Unsupported Media Type HTTP 状況コードが戻されます。
Content-Language 受信者に戻される応答メッセージの言語を示します。
Content-Type 受信者に送信されるエンティティー本体のメディア・タイプを示します。

X-Method-Override
X-HTTP-Method-Override

現在の要求によってトンネリングされる HTTP 操作を示します。

要求が BPD 関連リソースに対するものである場合は、HTTP ヘッダー・フィールドの代わりに対応する URI パラメーターを使用できます。

すべての IBM Business Process Manager REST リソースは、federationMode パラメーターをサポートします。
表 2. フェデレートされたドメインによってサポートされる URI パラメーター
URI パラメーター 説明
federationMode BPD 関連リソースによって公開されるメソッドの場合は、この URI パラメーターを使用して応答データの形式を指定できます。応答メッセージにはデフォルトで、メソッドの「status」プロパティーと、メソッド固有の応答データを含む「data」プロパティーで構成されるルート構造があります。「federationMode=true」と指定すると、ラッパー構造が抑制され、メソッド固有の応答データのみが戻されます。

BPEL 関連リソースおよびフェデレートされたリソースによって公開されるメソッドの場合は、「federationMode=true」だけがサポートされる値です。「federationMode=false」と指定すると、400 Bad Request HTTP 状況コードが戻されます。

REST リソースが BPD 関連リソースである場合は、HTTP ヘッダー・フィールドの代わりに以下の URI パラメーターを使用できます。HTTP ヘッダー・フィールドおよび対応する URI パラメーターの両方を使用可能な場合は、URI パラメーターの値が HTTP ヘッダーの値より優先されます。
表 3. BPD 関連リソースによってサポートされる URI パラメーター
URI パラメーター 説明
accept 応答メッセージで許容されるメディア・タイプを指定するために要求メッセージで使用されます。 このパラメーターは、Accept HTTP フィールドに相当します。
accept-encoding 応答メッセージで許容されるコンテンツ・エンコードを制限するために要求メッセージで使用されます。 このパラメーターは、Accept-Encoding HTTP フィールドに相当します。
accept-language 応答メッセージで許容される言語のリストを送信するために要求メッセージで使用されます。 このパラメーターは、Accept-Language HTTP フィールドに相当します。
callback JSONP 応答で使用される JavaScript コールバック関数の名前。
parts 1 つ以上のパーツのリストが応答メッセージで戻されるように指定するために要求メッセージで使用されます。リスト内の項目を区切るには、縦線 (|) を使用します。all または noneparts パラメーターの値として指定することもできます。all はデフォルトです。例:
parts=header|data
parts=all
parts=none

x-method-override
x-http-method-override

現在の要求によってトンネリングされる HTTP 操作を示します。 これらのパラメーターは、X-Method-Override HTTP フィールドおよび X-HTTP-Method-Override HTTP フィールドに相当します。