機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 顧客対応
  4. 顧客対応参照

すべての顧客対応参照の取得

get

/crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/interactionReferences

リクエスト

パス・パラメータ
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • InteractionRowFinderById : 顧客対応識別子で顧客対応を検索します。
      ファインダ変数:
      • BindInteractionId; integer;相互作用の一意の識別子。
      • BindObjectTypeCd; string; オブジェクトのタイプを示すコード。
    • PrimaryKey : 指定された主キーとの相互作用参照を検索します。
      ファインダ変数:
      • ReferenceId; integer; 相互作用参照の一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

    フォーマット : ?q=expression1;expression2

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • CreatedBy; string;参照を作成したユーザー。
    • CreationDate; string;参照が作成された日時。
    • InteractionId; integer; 相互作用参照の一意の識別子。
    • InteractionNumber; string;相互作用の代替キー識別子。
    • LastUpdateDate; string; 参照が最後に更新された日時。
    • LastUpdateLogin; string; 参照を最後に更新したユーザーのセッション・ログイン。
    • LastUpdatedBy; string; 参照を最後に更新したユーザー。
    • ObjectId; integer; 相互作用参照に関連付けられたオブジェクトの一意の識別子。
    • ObjectNumber; string;相互作用参照に関連付けられたオブジェクトの代替キー識別子。
    • ObjectTypeCd; string; 相互作用参照に存在するオブジェクトのタイプを示すコード。 有効な値のリストは、参照ORA_SVC_IM_REF_OBJECT_TYPE_CDで定義されます。
    • ReferenceId; integer; 外部システムとの統合に使用される一意の識別子。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : interactions-interactionReferences
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : interactions-interactionReferences-item-response
タイプ: object
ソースを表示
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    参照を作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    参照が作成された日時。
  • 読取り専用: true
    顧客対応参照を現在のユーザーが削除できるかどうかを示します。 デフォルト値はfalseです。
  • タイトル: Interaction ID
    顧客対応参照の一意の識別子。
  • タイトル: Interaction Number
    最大長: 30
    顧客対応の代替キー識別子。
  • タイトル: Last Updated Date
    読取り専用: true
    参照が最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    参照を最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    参照を最後に更新したユーザーのセッション・ログイン。
  • Links
  • タイトル: Object ID
    顧客対応参照に関連付けられたオブジェクトの一意の識別子。
  • タイトル: Reference Number
    読取り専用: true
    最大長: 255
    顧客対応参照に関連付けられたオブジェクトの代替キー識別子。
  • タイトル: Object Type
    最大長: 30
    顧客対応参照に存在するオブジェクトのタイプを示すコード。 有効な値のリストは、参照ORA_SVC_IM_REF_OBJECT_TYPE_CDで定義されます。
  • タイトル: Reference ID
    読取り専用: true
    外部システムとの統合に使用される一意の識別子。
  • 読取り専用: true
    顧客対応参照を現在のユーザーが更新できるかどうかを示します。 ユーザーが顧客対応参照を更新するアクセス権を持っている場合、デフォルト値はtrueです。
トップに戻る

例:

次の例は、RESTリソースに対してGETリクエストを発行して、すべての相互作用参照を取得する方法を示しています。

リクエスト・ヘッダーの例

次に、リクエスト・ヘッダーの例を示します。

GET  /crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/interactionReferences

レスポンス・ヘッダーの例

次に、レスポンス・ヘッダーの例を示します。

HTTP/1.1 200: OK
Date: Fri, 03 Mar 2017 07:54:53 GMT
Server : Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourcecollection+json
Content-Language: en

応答本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
  "items" : [ {
    "ReferenceId" : 300100096307926,
    "InteractionId" : 300100096307925,
    "ObjectTypeCd" : "SVC_SERVICE_REQUESTS",
    "ObjectId" : 300100096307611,
    "CreatedBy" : "FUSION_APPS_CRM_ESS_APPID",
    "CreationDate" : "2017-02-20T04:09:17-08:00",
    "LastUpdatedBy" : "FUSION_APPS_CRM_ESS_APPID",
    "LastUpdateDate" : "2017-02-20T04:09:17-08:00",
    "LastUpdateLogin" : "48F584F941357435E05307B3F20AB8E8",
    "UpdateFlag" : "true",
    "DeleteFlag" : "true",
    "links" : [ {
      "rel" : "self",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/interactionReferences/300100096307926",
      "name" : "interactionReferences",
      "kind" : "item",
      "properties" : {
        "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
      }
    }, {
      "rel" : "canonical",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/interactionReferences/300100096307926",
      "name" : "interactionReferences",
      "kind" : "item"
    }, {
      "rel" : "parent",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925",
      "name" : "interactions",
      "kind" : "item"
    } ]
  }, {
    "ReferenceId" : 300100097921285,
    "InteractionId" : 300100096307925,
    "ObjectTypeCd" : "SVC_CHATS",
    "ObjectId" : 30001233322,
    "CreatedBy" : "SALES_ADMIN",
    "CreationDate" : "2017-03-10T00:31:09-08:00",
    "LastUpdatedBy" : "SALES_ADMIN",
    "LastUpdateDate" : "2017-03-10T00:39:47-08:00",
    "LastUpdateLogin" : "4A49E601416B05A8E05307B3F20A1B38",
    "UpdateFlag" : "true",
    "DeleteFlag" : "true",
    "links" : [ {
      "rel" : "self",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/interactionReferences/300100097921285",
      "name" : "interactionReferences",
      "kind" : "item",
      "properties" : {
        "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
      }
    }, {
      "rel" : "canonical",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/interactionReferences/300100097921285",
      "name" : "interactionReferences",
      "kind" : "item"
    }, {
      "rel" : "parent",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925",
      "name" : "interactions",
      "kind" : "item"
    } ]
  } ],
  "count" : 2,
  "hasMore" : false,
  "limit" : 25,
  "offset" : 0,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/interactionReferences",
    "name" : "interactionReferences",
    "kind" : "collection"
  } ]
}
「トップに戻る」