Sage CRM「オブジェクトの照会」アクティビティーの使用

「オブジェクトの照会」アクティビティーを使用して、Sage CRM から、指定したオブジェクト・タイプに対する SData 照会を実行します。

このタスクについて

Sage CRM インスタンスで、指定したオブジェクト・タイプに対する SData 照会を実行するには、このタスクを使用します。このアクティビティーの呼び出しは、同期呼び出しです。同期呼び出しでは、入力データが処理のためにアクティビティーに送信され、オーケストレーションに応答が返信されます。

手順

  1. 「オーケストレーション」セクションを右クリックし、新規オーケストレーションを選択します。
  2. 新しく作成した Sage CRM エンドポイントをオーケストレーションにドラッグし、「オブジェクトの照会」アクティビティーを選択します。
  3. 「オブジェクトの照会」アクティビティーがオーケストレーションに追加されます。アクティビティーを選択します。 Sage CRM オブジェクトの照会「チェックリスト」が表示されます。
  4. 「チェックリスト」で「構成」をクリックします。
  5. 値のプレースホルダーとして「?」を使用して有効な照会パラメーターを入力します。複数の照会パラメーターを構成するには、各照会パラメーターを「&」で区切ります。照会の例を以下にいくつか示します。
    select=?&where=?
    startIndex=?&count=?
    orderBy=?
    select=?&where=?orderBy=?
      where=Lead_UpdatedDate lt @2016-01-10@

    照会ストリングを「?」で開始することはできません。

  6. 参照」をクリックして、オブジェクト・タイプを選択します。 「SageCRM の参照」ウィンドウが表示されます。
  7. 「SageCRM の参照」では、オブジェクト・タイプ・リストからオブジェクト・タイプを選択できます。「OK」をクリックします。
  8. チェックリスト」から「入力のマップ」を選択します。 「オブジェクトの照会」アクティビティーの選択したオブジェクトから生成された XML スキーマが、「アクティビティーへ」パネルの request 入力パラメーターの下にノードとして表示されます。
  9. チェックリスト」で、「再試行」をクリックします。 デフォルト設定を確認して、必要な変更を行います。
    注: 詳しくは、『Sage CRM REST API アクティビティーの再試行オプションの指定』を参照してください。
  10. オーケストレーション変数とアクティビティーの入力パラメーターとの間のマップを作成します。
    注: 入力構造の必須エレメントの値は、実行時に指定されている必要があります。 この値は、エレメントのデフォルト値を指定するか、エレメントを入力ノードにリンクすることによって指定できます。 実行時に必須エレメントの値が指定されていないと、アクティビティーは Web 管理コンソールから報告された例外をスローします。 実行時にオプションの入力パラメーターの値が指定されていなくても、実行時に例外はスローされません。
  11. チェックリスト」から「出力のマップ」を選択します。 アクティビティーの応答保持のために生成された XML スキーマが、「アクティビティーから」パネルの response 出力パラメーターの下にノードとして表示されます。
  12. 出力パラメーターとオーケストレーション変数との間のマップを作成します。

    照会パラメーター:

    表 1. 「オブジェクトの照会」の一般的な照会パラメーター
    フィールド名 説明
    startIndex レコードの開始インデックス。ここから、API 呼び出しの結果が始まります。
    count 応答に表示するオブジェクトの数。
    where フィルター基準を指定します。where パラメーターで指定された基準と一致するリソースのみが返されます。
    orderBy 並べ替えの基準を指定します。このパラメーターで指定された属性名の昇順または降順でコレクションがソートされます。
    select ペイロード内で返されるプロパティーを選択します。クライアントはこのパラメーターを使用して、特定のプロパティーのリストをペイロード内で返すように要求できます。返される情報の幅広さや深さを正確に制御できるようにします。

    アクティビティーを正常に実行するには、上記の照会パラメーターの 1 つ以上に値がマップされているか、デフォルト値が設定されている必要があります。

タスクの結果

Sage CRM「オブジェクトの照会」アクティビティーを構成しました。
注:

このアクティビティーは、指定されたタイプの複数のレコードをフェッチできます。すなわち、入力応答は単一であり、単一の「すべて取得」 API 呼び出しで複数のオブジェクトをフェッチするのに相当します。