JSON ペイロードの生成

現在のプロセス、ケースの定義またはフラグメント、あるいは選択した API のこれらの項目内の特定のアクティビティに JSON ペイロードを生成して、JSON 要求と応答を迅速に取得できます。

同期プロセスの場合、アクティビティ セクションは表示されません。

プロセスの JSON ペイロードの生成

現在のプロセスに JSON ペイロードを生成できます。

  1. プロセスの [ファイル] タブで、[開発者ツール] をクリックします。

    プロセス ID が読み取り専用モードで表示されます。

  2. [API のタイプ] のいずれかのオプションを選択します。
    • [SDK REST API] (デフォルト): REST サービス上の API および特定のプロセスに JSON ペイロードを生成できます。

    • [SDK JSON API]: API および特定のプロセスに JSON ペイロードを生成できます。

    選択した API のタイプに応じて、[API] リストが表示されます。

  3. [API] リストで、必要な API を選択します。
  4. [JSON ペイロードを生成] をクリックします。

    [JSON ペイロード] ポップアップ ウィンドウが表示され、選択した API の JSON 要求と応答が表示されます。

  5. 再利用するには、JSON を手動でコピーするか、[コピー] リンクをクリックします。たとえば、データ モデルで JSON を使用できます (「データ モデル」を参照)。

特定のアクティビティの JSON ペイロードの生成

プロセスの特定のアクティビティに JSON ペイロードを生成できます。

  1. プロセスの [ファイル] タブで、[開発者ツール] をクリックします。
  2. [アクティビティ] リストで、必要なアクティビティを選択します。

    リストには手動アクティビティのみが表示されます。アクティビティまたはノード ID でフィルタリングすることもできます。

  3. [API のタイプ] のいずれかのオプションを選択します。
    • [SDK REST API] (デフォルト): REST サービス上の API および特定のアクティビティに JSON ペイロードを生成できます。

    • [SDK JSON API]: API および特定のアクティビティに JSON ペイロードを生成できます。

    選択した API のタイプに応じて、[API] リストが表示されます。

  4. [API] リストで、必要な API を選択します。
  5. [JSON ペイロードを生成] をクリックします。

    [JSON ペイロード] ポップアップ ウィンドウが表示され、選択したアクティビティの JSON 要求と応答、および現在のプロセスの API が表示されます。

    API に対する要求本文がない場合、「要求」タブは使用できません。

  6. 再利用するには、JSON を手動でコピーするか、[コピー] リンクをクリックします。たとえば、データ モデルで JSON を使用できます (「データ モデル」を参照)。

    SDK API 応答には、JSON 内の各オブジェクトに対する「_type」が含まれます。ただし、簡素化のために、[JSON ペイロードの応答] タブには表示されません。コードからの API 応答を処理する場合は、これらの「_type」ノードを無視できます。