REST API for Oracle Integration

機械翻訳について

Webフォームのフォーム・インスタンスの取得

get

/ic/api/process/v1/process-definitions/{processDefId}/{serviceName}/webform

指定されたIDを持つプロセス定義のフォーム・インスタンスとオプションのペイロードを取得します。ペイロード属性とJSON形式の値は、保存処理を使用してプロセスの開始時にフォーム・ペイロードが保存された場合にのみ設定されます。

リクエスト

パス・パラメータ

processDefId(required): string

プロセス定義IDの値
serviceName(required): string

プロセスのサービス名の値。

問合せパラメータ

includeAttachments: boolean

true (デフォルト)である場合、保存されている添付ファイルが本体パートとしてフォームURLとともに返されます

デフォルト値: true
operation(required): string

実行する操作を指定します。プロセス定義の取得エンドポイントを使用して、操作を含むプロセス定義データをリストします。

トップに戻る

レスポンス

サポートされているメディア・タイプ

multipart/mixed

200レスポンス

成功。マルチパートのレスポンスが返されます。最初の本文パートは、フォーム・インスタンスのURLおよびオプションのペイロード(保存済の場合)を含むJSONです。残りの本文パートは、そのプロセスに保存された添付ファイルが含まれている場合に添付ファイルになります。

401レスポンス

未認可

404レスポンス

Form not found.

500レスポンス

フォーム・インスタンスのURLの取得中のエラー

トップに戻る

例

次の例は、RESTリソースのWebフォームのフォーム・インスタンスを取得する方法を示しています。

リクエストの送信

https://example.com/ic/api/process/v1/process-definitions/{processDefId}/{serviceName}/webform?operation=<operation>

説明

example.comは、Oracle Integrationが実行されているホストです。
<version>はREST APIバージョンです。
<processDefId>は、/process-definitions エンドポイントから取得したプロセス定義IDです。詳細は、プロセス定義の取得を参照してください。
<serviceName>は、 /process-definitions endpointから取得したプロセス定義のサービス名です。詳細は、プロセス定義の取得を参照してください。
<operation>は、/process-definitions エンドポイントから取得したプロセス定義の操作です。たとえば、startです。詳細は、プロセス定義の取得を参照してください。

レスポンス本文の例

このAPIはマルチパートの応答を返します。次の例は、フォームURLとオプションのペイロードを含む最初の部分を示しています。

例1:

--Boundary_5_532764984_1485338960344
Content-Type: text/plain
{"form": http://example.com/ic/api/process/<version>/process-definitions/{processDefId}/{serviceName}/webforms/default~NewFormsRestApp!1.0~NewPCSForms~d5fb3e55-682b-4dd7-8836-3f670d1c9b3a~c162fd27-99d7-4f81-944d-33ae26c0f089"}
--Boundary_5_532764984_1485338960344--

JSON形式のペイロード属性とその値は、「保存」アクションを使用してプロセスの開始時にフォームのペイロードが保存されている場合にのみ設定されます。

例2:

次の例には、オプションのペイロードが含まれています:

--Boundary_6_543235965_1488307245682
Content-Type: text/plain
{"form":
"http://example.com/ic/api/process/<version>/process-definitions/{processDefId}/{serviceName}/webforms/default~SequentialApplication!1.0~SeqProcess~033924ee-94fe-407c-8441-8e0bad75c553~e7b6b5ea-3f3b-4901-9532-9a65e032c9b3", "payload":
{"travelPurpose":"purpose","travelJustification":"justification","travelCost":


"111","approvers.assignees":["jstein","achrist","cdoyle"]}}
--Boundary_6_543235965_1488307245682--

先頭に戻る