機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 内部サービス・リクエスト
  4. サービス・リクエスト・メッセージ・コミュニケーション

SRのすべてのチャネル通信レコードの取得

get

/crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/channelCommunication

リクエスト

パス・パラメータ
  • このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: 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 :指定した主キーを持つサービス・リクエスト・チャネル通信レコードを検索します。
      ファインダ変数:
      • ViaId :サービス・リクエスト・チャネル通信レコードの一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • ChannelAccountName; string; チャネルに関連付けられたアカウント名。 たとえば、Eメールの場合、アカウント名はサポート用のインバウンド・メールボックスになります。
    • ChannelDisplayName; string;チャネルの表示名。
    • ChannelId; integer;チャネルの一意の識別子。
    • ChannelShortName; string;チャネルの公開一意識別子。
    • ChannelTypeCd; string; チャネル・タイプを示すコード。 たとえば、電子メールや電話などです。 受け入れられる値のリストは、参照ORA_SVC_CHANNEL_TYPE_CDで定義されます。
    • CollabId; string; Slack Idなど、対応するネットワークのコラボレーション・ネットワーク・ユーザーの一意の識別子。
    • CollabName; string;コラボレーション・ネットワーク上の外部ユーザーのユーザー名。
    • CollabResourceId; integer; 内部ユーザーが通信しているコラボレーション・ネットワーク・ユーザーの一意の識別子。
    • ContactPointId; integer;通信している担当者の担当者レコードの一意の識別子。 担当者は、特定の通信チャネルに対する担当者の識別子です。 たとえば、Eメール・チャネルの担当者はEメール・アドレスになります。
    • CreatedBy; string;通信チャネルを作成したユーザー。
    • CreationDate; string;通信チャネルが作成された日時。
    • InboundObjectId; integer; サービス・リクエストを作成したインバウンド・オブジェクトの一意の識別子。
    • LastUpdateDate; string;通信チャネルが最後に更新された日時。
    • LastUpdateLogin; string;通信チャネルを最後に更新したユーザーに関連付けられたセッション・ログイン。
    • LastUpdatedBy; string; 通信チャネルを最後に更新したユーザー。
    • NetworkTypeCd; string; ポストのソーシャル・ネットワークを示すコード。 たとえば、Facebook、Twitterです。 受け入れられる値のリストは、参照HZ_INSTANT_MESSENGER_TYPEで定義されます。
    • ObjectId; integer;オブジェクトの一意の識別子。 オブジェクト・タイプに応じて、チャネル通信に関連付けられているサービス・リクエストIDまたはサービス・リクエスト・メッセージIDを示します。
    • ObjectTypeCd; string; チャネル通信レコードがサービス・リクエストに関連付けられているか、サービス・リクエスト・メッセージに関連付けられているかを示すコード。 受け入れられる値のリストは、参照ORA_SVC_CHANNEL_OBJECT_TYPE_CDで定義されます。
    • PartyId; integer;通信している個人の一意のパーティ識別子。
    • PartyName; string;通信している個人のパーティ名。
    • PartyNumber; string; サービス・リクエスト通信に関連付けられている担当者の公開一意識別子。
    • PartyViaEndPoint; string; 顧客コンタクトとの通信に使用されるエンドポイント。 たとえば、Eメール・アドレスや電話番号などです。 Party_IDがNULLで、PartyViaEndPointがNULLでない場合、エンドポイントはパーティに属します。
    • PostIdentifier; string; サービス・リクエストまたはサービス・リクエスト・メッセージの作成に使用されたソーシャル・メディア投稿レコードの一意の識別子。
    • ResourceId; integer; サービス・リクエストに関連付けられたリソースの一意の識別子。 これは、内部ユーザーが通信しているコラボレーション・ネットワーク・ユーザーを識別できる外部キーです。
    • ResourceTypeCd; string; USER、PUBLIC_CHANNEL、PRIVATE_CHANNELなどのコラボレイティブ・ネットワーク・ユーザーのタイプを示すコード。 受け入れられる値のリストは、参照ORA_SVC_COLLAB_RES_TYPE_CDで定義されます。
    • RoutingCd; string; メッセージがエンドポイントを経由してルーティングされた方法を示すコード。 たとえば、エンドポイントが電子メール・アドレスである場合、受信者がTO、CCまたはBCC受信者のいずれであるかがフィールドに表示されます。
    • ViaId; integer; サービス・リクエスト・チャネル通信レコードの一意の識別子。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : internalServiceRequests-channelCommunication
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : internalServiceRequests-channelCommunication-item-response
タイプ: object
ソースを表示
  • タイトル: Account Name
    読取り専用: true
    最大長: 400
    チャネルに関連付けられたアカウント名。 たとえば、Eメールの場合、アカウント名はサポート用のインバウンド・メールボックスになります。
  • タイトル: Display Name
    最大長: 400
    チャネルの表示名。
  • タイトル: Channel ID
    チャネルの一意の識別子。
  • タイトル: Channel Short Name
    最大長: 450
    チャネルのパブリック一意識別子。
  • タイトル: Channel Type
    読取り専用: true
    最大長: 30
    チャネル・タイプを示すコード。 たとえば、電子メールや電話などです。 受け入れられる値のリストは、参照ORA_SVC_CHANNEL_TYPE_CDで定義されます。
  • タイトル: Collaboration ID
    読取り専用: true
    最大長: 255
    対応するネットワークのコラボレーション・ネットワーク・ユーザーの一意の識別子(Slack IDなど)。
  • タイトル: Resource Name
    読取り専用: true
    最大長: 400
    コラボレーション・ネットワーク上の外部ユーザーのユーザー名です。
  • タイトル: Collaboration Resource Identifier
    内部ユーザーが通信しているコラボレーション・ネットワーク・ユーザーの一意の識別子。
  • タイトル: Contact Point ID
    連絡中の担当者の担当者レコードの一意の識別子。 担当者は、特定の通信チャネルに対する担当者の識別子です。 たとえば、Eメール・チャネルの担当者はEメール・アドレスになります。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    通信チャネルを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    通信チャネルが作成された日時。
  • タイトル: Can Delete
    読取り専用: true
    チャネル通信が削除されたかどうかを示します。
  • タイトル: Inbound Message Object Identifier
    サービス・リクエストを作成したインバウンド・オブジェクトの一意の識別子。
  • タイトル: Last Updated Date
    読取り専用: true
    通信チャネルが最後に更新された日時。
  • タイトル: Updated By
    読取り専用: true
    最大長: 64
    通信チャネルを最後に更新したユーザー。
  • タイトル: Update Login
    読取り専用: true
    最大長: 32
    通信チャネルを最後に更新したユーザーに関連付けられたセッション・ログイン。
  • Links
  • タイトル: Network
    読取り専用: true
    最大長: 30
    ポストのソーシャル・ネットワークを示すコード。 たとえば、Facebook、Twitterです。 受け入れられる値のリストは、参照HZ_INSTANT_MESSENGER_TYPEで定義されます。
  • タイトル: Object ID
    オブジェクトの一意の識別子。 オブジェクト・タイプに応じて、チャネル通信に関連付けられているサービス・リクエストIDまたはサービス・リクエスト・メッセージIDを示します。
  • タイトル: Object Type
    読取り専用: true
    最大長: 30
    デフォルト値: SVC_SERVICE_REQUESTS
    チャネル通信レコードがサービス・リクエストに関連付けられているか、サービス・リクエスト・メッセージに関連付けられているかを示すコード。 受け入れられる値のリストは、参照ORA_SVC_CHANNEL_OBJECT_TYPE_CDで定義されます。
  • タイトル: Party ID
    連絡中の個人の一意のパーティ識別子。
  • タイトル: Party Name
    読取り専用: true
    最大長: 360
    連絡中の個人のパーティ名。
  • タイトル: Party Number
    読取り専用: true
    最大長: 30
    サービス・リクエスト通信に関連付けられている担当者の公開一意識別子。
  • タイトル: Party Endpoint
    最大長: 1000
    顧客コンタクトとの通信に使用されるエンドポイント。 たとえば、Eメール・アドレスや電話番号などです。 Party_IDがNULLで、PartyViaEndPointがNULLでない場合、エンドポイントはパーティに属します。
  • タイトル: Person ID
    担当者の一意のPerson ID。
  • タイトル: Post Identifier
    最大長: 1000
    サービス・リクエストまたはサービス・リクエスト・メッセージの作成に使用されたソーシャル・メディア・ポスト・レコードの一意の識別子。
  • タイトル: Resource ID
    読取り専用: true
    サービス・リクエストに関連付けられたリソースの一意の識別子。 これは、内部ユーザーが通信しているコラボレーション・ネットワーク・ユーザーを識別できる外部キーです。
  • タイトル: Resource Type
    読取り専用: true
    最大長: 30
    USER、PUBLIC_CHANNEL、PRIVATE_CHANNELなど、コラボレイティブ・ネットワーク・ユーザーのタイプを示すコード。 受け入れられる値のリストは、参照ORA_SVC_COLLAB_RES_TYPE_CDで定義されます。
  • タイトル: Routing Code
    最大長: 30
    エンドポイントを介したメッセージのルーティング方法を示すコード。 たとえば、エンドポイントが電子メール・アドレスである場合、受信者がTO、CCまたはBCC受信者のいずれであるかがフィールドに表示されます。
  • タイトル: Can Update
    読取り専用: true
    チャネル通信が更新されたかどうかを示します。
  • タイトル: ID
    読取り専用: true
    サービス・リクエスト・チャネル通信レコードの一意の識別子。
「トップに戻る」