機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. ラップ・アップ

要約の取得

get

/crmRestApi/resources/11.13.18.05/wrapUps/{SummaryId}

リクエスト

パス・パラメータ
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: 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
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : wrapUps-item-response
タイプ: object
ソースを表示
  • タイトル: Account ID
    読取り専用: true
    顧客対応に関連付けられたアカウントの一意の識別子。
  • タイトル: Party Account Number
    読取り専用: true
    最大長: 30
    cccountの公開一意識別子。
  • タイトル: Account Unique Name
    読取り専用: true
    最大長: 900
    顧客対応に関連付けられているアカウントの一意のアカウント名。
  • Attachments
    タイトル: Attachments
    添付リソースは、添付の表示、作成および更新に使用されます。
  • タイトル: Call Notes
    コール・ノートは、コールに関連する大きなコンテンツを格納するために使用されます。
  • タイトル: Display Name
    読取り専用: true
    最大長: 400
    このチャネル・インスタンスに対して表示される名前。
  • タイトル: Channel ID
    読取り専用: true
    顧客対応に関連付けられたチャネルの一意の識別子。
  • タイトル: Channel Type
    読取り専用: true
    最大長: 30
    相互作用チャネルのタイプを示すコード。 受け入れられる値のリストは、参照ORA_SVC_CHANNEL_TYPE_CDで定義されます。
  • 読取り専用: true
    チャネル・タイプ・コードの摘要。
  • タイトル: Communication Reason Code
    最大長: 30
    顧客対応が発生した理由を示すコード。 受け入れられる値のリストは、参照ORA_SVC_MCA_COMM_REASON_CDで定義されます。
  • 読取り専用: true
    方向コードの摘要。
  • タイトル: Contact ID
    読取り専用: true
    顧客対応に関連付けられている担当者の一意の識別子。
  • タイトル: Contact Name
    読取り専用: true
    最大長: 360
    顧客対応担当者のパーティ名。
  • タイトル: Party Contact Number
    読取り専用: true
    最大長: 30
    顧客対応に関連付けられている担当者の一意の識別子。
  • タイトル: Contact Unique Name
    読取り専用: true
    最大長: 900
    担当者の公開一意識別子。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    ラップ・アップを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日時。
  • 読取り専用: true
    ラップ・アップが削除済としてマークされているかどうかを示します。 デフォルト値はtrueです。
  • タイトル: Direction
    読取り専用: true
    最大長: 30
    デフォルト値: ORA_SVC_INBOUND
    顧客対応がインバウンドかアウトバウンドかを示すコード。 デフォルト値はORA_SVC_INBOUNDで、インバウンド相互作用を示します。 値は、アウトバウンド・インタラクションのORA_SVC_OUTBOUNDです。
  • 読取り専用: true
    顧客対応方向コードの摘要。
  • タイトル: Description
    読取り専用: true
    最大長: 1000
    顧客対応の摘要。
  • タイトル: End Time
    読取り専用: true
    顧客対応が開始した時間。
  • タイトル: Interaction ID
    読取り専用: true
    顧客対応の一意の識別子。 ラップ・アップは顧客対応の子リソースです。
  • タイトル: Interaction ID
    顧客対応の一意の識別子。 ラップ・アップは、顧客対応の子リソースです。
  • タイトル: Interaction Notes
    最大長: 4000
    顧客対応に関連付けられたノート。
  • タイトル: Start Time
    読取り専用: true
    顧客対応が終了した時間。
  • タイトル: Status
    読取り専用: true
    最大長: 30
    デフォルト値: ORA_SVC_OPEN
    顧客対応のステータスを示すために使用される事前定義コード。 受け入れられる値のリストは、参照ORA_SVC_IM_STATUS_CDで定義されます。
  • タイトル: Substatus Code
    読取り専用: true
    最大長: 30
    このコードは、顧客対応のサブステータスを示します。 受け入れられる値のリストは、ORA_SVC_IM_CLOSED_SUBSTATUS_CDで定義されます。
  • タイトル: Last Updated Date
    読取り専用: true
    ラップ・アップが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    ラップ・アップを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    要約を最後に更新したユーザーのログイン。
  • Links
  • タイトル: Media Item ID
    読取り専用: true
    最大長: 80
    サード・パーティ・ツールを介してルーティングされた顧客対応中に生成されるイベントID。
  • タイトル: Owner Resource ID
    読取り専用: true
    顧客対応の所有者の一意の識別子。
  • タイトル: Resolution Code
    最大長: 30
    顧客対応の解決コードを示すコード。 受け入れられる値のリストは、参照ORA_SVC_MCA_RESOLUTION_CODEで定義されます。
  • 読取り専用: true
    解決コードの説明。
  • タイトル: Resource Name
    読取り専用: true
    最大長: 360
    所有者リソースのパーティ名。
  • タイトル: Resource Party Number
    読取り専用: true
    最大長: 30
    所有者リソースの公開一意識別子。
  • タイトル: Resource Unique Name
    読取り専用: true
    最大長: 900
    所有者リソースの一意に識別された名前。
  • タイトル: Message ID
    サービス・リクエスト・メッセージの一意の識別子。
  • タイトル: Summary ID
    読取り専用: true
    まとめの一意の識別子。 この値は作成時に生成されます。
  • タイトル: Transfer Reason
    最大長: 400
    顧客対応が別のユーザーに転送された事由。 これはオプションであり、通常は転送された顧客対応にのみ提供されます。
  • 読取り専用: true
    ラップ・アップが更新されたかどうかを示します。 デフォルト値はtrueです。
  • タイトル: Verified
    最大長: 1
    関連担当者が検証されたかどうかを示します。
  • タイトル: Wrap Up End Time
    まとめが終了する日時。
  • タイトル: Wrap Up Start Time
    まとめが開始される日時。
ネストされたスキーマ : 添付ファイル
タイプ: array
タイトル: Attachments
添付リソースは、添付の表示、作成および更新に使用されます。
ソースを表示
ネストされたスキーマ : wrapUps-Attachments-item-response
タイプ: object
ソースを表示
リンク
添付
パラメータ:
  • SummaryId: $request.path.SummaryId
添付リソースは、添付の表示、作成および更新に使用されます。
CommReasonLov
パラメータ:
  • ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_MCA_COMM_REASON_CD
顧客対応の事由を示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: CommReasonCd;ターゲット属性: LookupCode
  • 表示属性: 意味
InteractionStatusCdLov
パラメータ:
  • ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_IM_STATUS_CD
顧客対応のステータスを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: InteractionStatusCd;ターゲット属性: LookupCode
  • 表示属性: 意味
InteractionSubstatusCdLov
パラメータ:
  • ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_IM_CLOSED_SUBSTATUS_CD
顧客対応のサブステータスを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: InteractionSubstatusCd;ターゲット属性: LookupCode
  • 表示属性: 意味
ResolutionCdLov
パラメータ:
  • ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_MCA_RESOLUTION_CD
顧客対応の解決コードを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: ResolutionCd;ターゲット属性: LookupCode
  • 表示属性: 意味
トップに戻る

例:

次のURI構文でGETを使用して、特定のラップ・アップの詳細を取得します:

リクエストURIの例

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

https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/wrapUps/300100095286192

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

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

GET /crmRestApi/resources/11.13.18.05/wrapUps/300100095286192 HTTP/1.1
HOST: servername.fa.us2.oraclecloud.com
authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE=
content-type: application/vnd.oracle.adf.resourceitem+json

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

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

HTTP/1.1 200: OK
Date: Mon, 16 Jan 2017 13:30:04 GMT
Server: Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourceitem+json
Content-Language: en

レスポンス本文の例

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

Content type:
{
"SummaryId": 300100095286192,
"InteractionId": 300100091808024,
"CommReasonCd": "GENERAL_QUESTION",
"ResolutionCd": "ANSWERED_QUESTION",
"TransferReason": null,
"InteractionNotes": "I really like REST",
"InteractionDescription": null,
"InteractionFKId": 300100091808024,
"InteractionObjectVersionNumber": 4,
"InteractionStatusCd": "ORA_SVC_CLOSED",
"links": [
  {
"rel": "self",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/wrapUps/300100095286192",
"name": "wrapUps",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
}
},
  {
"rel": "canonical",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/wrapUps/300100095286192",
"name": "wrapUps",
"kind": "item"
},
  {
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/wrapUps/300100095286192/lov/ResolutionCdLov",
"name": "ResolutionCdLov",
"kind": "collection"
},
  {
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/wrapUps/300100095286192/lov/CommReasonLov",
"name": "CommReasonLov",
"kind": "collection"
}
],
}
「トップに戻る」