REST API からの Integration Procedure の呼び出し

REST API では、GET コールまたは POST コールを使用して Integration Procedure を呼び出し、結果を取得できます。この 2 つの違いは、GET コールで JSON リクエストボディを含むデータを渡せないことです。

次のような形式の URL を使用して REST コールを呼び出します。

/services/apexrest/{namespace}/v1/integrationprocedure/{Type}_{SubType}/

通常、名前空間は omnistudio です。Integration Procedure の Type と SubType を指定します。

パラメーターを使用して、次の 3 つの方法で Integration Procedure にデータを渡します。

• URL パスのインライン値として (GET または POST)

• URL (GET または POST) への query parameter=value ペアの追加

• JSON リクエストボディを指定する (POST のみ)

メモ

REST API で Integration Procedure を使用する場合、次のガイドラインに従ってください。

• JSON 表記では、中括弧はリテラルです。これらは JSON オブジェクトを区切ります。

• REST URL 表記では、中括弧で変数値を囲み、置き換える必要があります。実際の要求には中括弧を含めないでください。

• REST URL のすべての部分は大文字と小文字を区別します。

Integration Procedure のオプション (chainable や queueableChainable など) を REST コールのクエリパラメーターとして設定することもできます。

/services/apexrest/vlocity_ins/v1/integrationprocedure/Create_Cases/?queueableChainable=true

Integration Procedure への REST コールの例は、「Invoke a Chainable Integration Procedure with REST Calls (REST コールを使用したチェーン可能な Integration Procedure の呼び出し)」を参照してください。

• GET を使用した Integration Procedure の呼び出し
  Integration Procedure から JSON データの結果を要求および受信するには、GET コールを発行します。GET コールでは、インライン URL パスパラメーターを指定し、クエリパラメーターを URL に追加できます。JSON リクエストボディを使用してデータを渡す必要がある場合は、代わりに POST コールを使用します。
• POST を使用した Integration Procedure の呼び出し
  Integration Procedure との間で JSON データを送受信するには、POST コールを発行します。POST コールでは、インライン URL パスパラメーターを指定し、クエリパラメーターを URL に追加して、JSON リクエストボディを含めることができます。

/services/apexrest/{namespace}/v1/integrationprocedure/{Type}_{SubType}/{inlinevalue1}/{inlinevalue2}/?{Param1}={Value1}

/services/apexrest/vlocity_cmt/v1/integrationprocedure/IP_Rest/Apple/Phones/?product=iPhoneX

{
  "options": {
    "Path1": "Apple",
    "Path2": "Phones",
    "product": "iPhoneX",
    "isDebug": "true"
  }

}

/services/apexrest/{namespace}/v1/integrationprocedure/{Type}_{SubType}/{inlinevalue1}/{inlinevalue2}/?{Param1}={Value1}

/services/apexrest/vlocity_cmt/v1/integrationprocedure/IP_Rest/Apple/Phones/?product=iPhoneX

{
  "options": {
    "Path1": "Apple",
    "Path2": "Phones",
    "product": "iPhoneX",
    "isDebug": "true"
  }
}