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

すべてのサービス・リクエスト・インタラクションの取得

get

/crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srInteractionReferences

リクエスト

パス・パラメータ
  • サービス・リクエストの識別に使用される一意の番号。 サービス・リクエスト番号は、組織の要件に最適な形式に構成できます。 たとえば、サービス・リクエストには、要件に応じて、サービスrequest0000012345、サービスrequest_000_12345、12345_00_serviceリクエストなどのフォーマットを設定できます。
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: 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>

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

    • PrimaryKey : ID別にサービス・リクエスト顧客対応を検索します。
      ファインダ変数:
      • ReferenceId; integer;顧客対応参照ID。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AccountPartyId; integer;顧客対応アカウントの一意の識別子。
    • AccountPartyUniqueName; string;顧客対応アカウントの名前。
    • ChannelDisplayName; string;表示チャネルの名前。
    • ChannelId; integer;インタラクション・チャネルの一意の識別子。
    • ChannelTypeCd; string; チャネル・タイプを示すコード。 たとえば、電子メール、電話、ソーシャルなどです。 受け入れられる値のリストは、参照ORA_SVC_CHANNEL_TYPE_CDで定義されます。
    • ContactPartyId; integer;顧客対応担当者の一意の識別子。
    • ContactPartyUniqueName; string;顧客対応担当者の名前。
    • CreatedBy; string;顧客対応を作成したユーザー。
    • CreationDate; string;顧客対応が作成された日時。
    • 説明;文字列;インタラクションの簡単な説明。
    • DirectionCd; string; 相互作用がインバウンドかアウトバウンドかを示すコード。
    • EndTime; string; 相互作用が終了する日時。
    • InteractionId; integer;相互作用の一意の識別子。
    • LastUpdateDate; string;顧客対応が最後に更新された日時。
    • LastUpdateLogin; string;顧客対応を最後に更新したユーザーのログイン。
    • LastUpdatedBy; string;顧客対応を最後に更新したユーザー。
    • OriginalSystemReference; string;インポートされた顧客対応の元の参照システム。
    • OwnerResourceId; integer; インタラクションを所有するエージェントの一意の識別子。
    • OwnerResourcePartyUniqueName; string; サービス・エージェントなど、顧客対応に関連付けられた内部顧客対応所有者であるリソースの名前。
    • ParentInteractionId; integer;親顧客対応の一意の識別子。
    • QueueId; integer;相互作用キューの一意の識別子。
    • QueueName; string;相互作用キューの名前。
    • ReferenceId; integer;サービス・リクエスト相互作用参照の一意の識別子。
    • StartTime; string;顧客対応が開始される日時。
    • StatusCd; string;顧客対応のステータスを示すコード。 受け入れられる値のリストは、参照ORA_SVC_IM_STATUS_CDで定義されます。
    • StripeCd; string;インタラクションのアプリケーション・ストライプ。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : serviceRequests-srInteractionReferences
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : serviceRequests-srInteractionReferences-item-response
タイプ: object
ソースを表示
  • タイトル: Account ID
    読取り専用: true
    顧客対応アカウントの一意の識別子。
  • タイトル: Account
    読取り専用: true
    最大長: 900
    顧客対応アカウントの名前。
  • タイトル: Display Name
    読取り専用: true
    最大長: 400
    表示チャネルの名前。
  • タイトル: Channel ID
    読取り専用: true
    インタラクション・チャネルの一意の識別子。
  • タイトル: Channel Type
    読取り専用: true
    最大長: 30
    チャネル・タイプを示すコード。 たとえば、電子メール、電話、ソーシャルなどです。 受け入れられる値のリストは、参照ORA_SVC_CHANNEL_TYPE_CDで定義されます。
  • タイトル: Contact ID
    読取り専用: true
    顧客対応担当者の一意の識別子。
  • タイトル: Contact
    読取り専用: true
    最大長: 900
    顧客対応担当者の名前。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    顧客対応を作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    顧客対応が作成された日時。
  • タイトル: Can Delete
    読取り専用: true
    顧客対応参照が削除されたかどうかを示します。
  • タイトル: Description
    読取り専用: true
    最大長: 1000
    顧客対応の簡単な説明。
  • タイトル: Direction
    読取り専用: true
    最大長: 30
    デフォルト値: ORA_SVC_INBOUND
    顧客対応がインバウンドかアウトバウンドかを示すコード。
  • タイトル: End Time
    読取り専用: true
    顧客対応が終了する日時。
  • タイトル: Interaction ID
    読取り専用: true
    顧客対応の一意の識別子。
  • タイトル: Last Updated Date
    読取り専用: true
    顧客対応が最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    顧客対応を最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    顧客対応を最後に更新したユーザーのログイン。
  • Links
  • タイトル: Original System
    読取り専用: true
    最大長: 255
    インポートされた顧客対応の元の参照システム。
  • タイトル: Owner Resource ID
    読取り専用: true
    顧客対応を所有するエージェントの一意の識別子。
  • タイトル: Resource Name
    読取り専用: true
    最大長: 900
    サービス・エージェントなど、顧客対応に関連付けられた内部顧客対応所有者であるリソースの名前。
  • タイトル: Parent Interaction ID
    読取り専用: true
    親顧客対応の一意の識別子。
  • タイトル: Payload
    読取り専用: true
    顧客対応に関連付けられたペイロード。
  • タイトル: Queue ID
    読取り専用: true
    インタラクション・キューの一意の識別子。
  • タイトル: Name
    読取り専用: true
    最大長: 400
    インタラクション・キューの名前。
  • タイトル: Reference ID
    読取り専用: true
    サービス・リクエスト顧客対応参照の一意の識別子。
  • タイトル: Start Time
    読取り専用: true
    顧客対応が開始する日時。
  • タイトル: Status
    読取り専用: true
    最大長: 30
    デフォルト値: ORA_SVC_OPEN
    顧客対応のステータスを示すコード。 受け入れられる値のリストは、参照ORA_SVC_IM_STATUS_CDで定義されます。
  • タイトル: Stripe Code
    読取り専用: true
    最大長: 30
    インタラクションのアプリケーション・ストライプ。
  • タイトル: Top Level
    読取り専用: true
    顧客対応が階層の最上位レベルの顧客対応であるかどうかを示します。
  • タイトル: Can Update
    読取り専用: true
    顧客対応参照が更新されたかどうかを示します。
トップに戻る

例:

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

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

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

GET crmRestApi/resources/11.13.18.05/serviceRequests/SR0000004951/child/srInteractionReferences
HOST: servername.fa.us2.oraclecloud.com
authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE=
content-type: application/vnd.oracle.adf.resourceitem+json

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

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

HTTP/1.1 200 OK
Server: Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourceitem+json
Content-Language: en

レスポンス本文の例

次の例は、レスポンス本文の内容を示しています。

{
  "items": [
    {
      "ReferenceId": 300100103890826,
      "InteractionId": 300100103890825,
      "ParentInteractionId": 300100103890825,
      "TopLevelFlag": "true",
      "Description": "Sent SrMessage 300100097060036",
      "ChannelId": 2,
      "ChannelDisplayName": "E-Mail (Seeded)",
      "ChannelTypeCd": "ORA_SVC_EMAIL",
      "AccountPartyId": null,
      "AccountPartyUniqueName": null,
      "ContactPartyId": 5266,
      "ContactPartyUniqueName": "Brian Adams ",
      "QueueId": null,
      "QueueName": null,
      "OwnerResourceId": 100010025532672,
      "OwnerResourcePartyUniqueName": "Gabrielle   Lee",
      "StartTime": "2017-04-10T18:01:25+00:00",
      "EndTime": "2017-04-10T17:59:40.701+00:00",
      "StatusCd": "ORA_SVC_CLOSED",
      "OriginalSystemReference": null,
      "CreatedBy": "SALES_ADMIN",
      "CreationDate": "2017-04-10T18:01:25+00:00",
      "LastUpdatedBy": "SALES_ADMIN",
      "LastUpdateDate": "2017-04-10T18:01:26.022+00:00",
      "LastUpdateLogin": "4CD4AA2920F63908E05356C0F20AD4D2",
      "DirectionCd": "ORA_SVC_OUTBOUND",
      "StripeCd": "ORA_SVC_CRM",
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000004951/child/srInteractionReferences/300100103890826",
          "name": "srInteractionReferences",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000004951/child/srInteractionReferences/300100103890826",
          "name": "srInteractionReferences",
          "kind": "item"
        },
        {
          "rel": "parent",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000004951",
          "name": "serviceRequests",
          "kind": "item"
        },
        {
          "rel": "enclosure",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000004951/child/srInteractionReferences/300100103890826/enclosure/Payload",
          "name": "Payload",
          "kind": "other"
        }
      ]
    },
    {
      "ReferenceId": 300100103890829,
      "InteractionId": 300100103890828,
      "ParentInteractionId": 300100103890828,
      "TopLevelFlag": "true",
      "Description": "Sent SrMessage 300100097060042",
      "ChannelId": 2,
      "ChannelDisplayName": "E-Mail (Seeded)",
      "ChannelTypeCd": "ORA_SVC_EMAIL",
      "AccountPartyId": null,
      "AccountPartyUniqueName": null,
      "ContactPartyId": 5266,
      "ContactPartyUniqueName": "Brian Adams ",
      "QueueId": null,
      "QueueName": null,
      "OwnerResourceId": 100010025532672,
      "OwnerResourcePartyUniqueName": "Gabrielle   Lee",
      "StartTime": "2017-04-10T18:03:51+00:00",
      "EndTime": "2017-04-10T18:02:06.587+00:00",
      "StatusCd": "ORA_SVC_CLOSED",
      "OriginalSystemReference": null,
      "CreatedBy": "SALES_ADMIN",
      "CreationDate": "2017-04-10T18:03:51+00:00",
      "LastUpdatedBy": "SALES_ADMIN",
      "LastUpdateDate": "2017-04-10T18:03:51.034+00:00",
      "LastUpdateLogin": "4CD4AA2920F63908E05356C0F20AD4D2",
      "DirectionCd": "ORA_SVC_OUTBOUND",
      "StripeCd": "ORA_SVC_CRM",
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000004951/child/srInteractionReferences/300100103890829",
          "name": "srInteractionReferences",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000004951/child/srInteractionReferences/300100103890829",
          "name": "srInteractionReferences",
          "kind": "item"
        },
        {
          "rel": "parent",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000004951",
          "name": "serviceRequests",
          "kind": "item"
        },
        {
          "rel": "enclosure",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000004951/child/srInteractionReferences/300100103890829/enclosure/Payload",
          "name": "Payload",
          "kind": "other"
        }
      ]
    }
  ],
  "count": 2,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000004951/child/srInteractionReferences",
      "name": "srInteractionReferences",
      "kind": "collection"
    }
  ]
}
「トップに戻る」