機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. チャネル・イベント

チャネル・イベントをすべて取得

get

/crmRestApi/resources/11.13.18.05/omniChannelEvents

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

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

    • PrimaryKeyチャネル・イベントの一意の識別子。
      ファインダ変数
      • EventId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • BuOrgId; integer;チャネル・イベントの作業オブジェクトに関連付けられたビジネス・ユニット組織の一意の識別子。
    • ChannelId; integer; 作業オブジェクト・チャネル・イベントに関連付けられたチャネルの一意の識別子。
    • ChannelTypeCd; string; チャネル・タイプを示すコード。 受け入れられる値のリストは、参照ORA_SVC_CHANNEL_TYPE_CDで定義されます。
    • ContactPartyId; integer; 作業オブジェクト・チャネル・イベントに関連付けられている担当者パーティの一意の識別子。
    • CreatedBy; string; チャネル・イベントを作成したユーザー。
    • CreationDate; string; チャネル・イベントが作成された日時。
    • DurationMs; integer; チャネル・イベントの終了時間と開始時間の差(ミリ秒)。
    • EndDateTrunc;文字列。チャネル・イベント終了時間の表現は1日に切り捨てられます。
    • EndTime; string; このチャネル・イベントが終了した時間。
    • EventId; integer;チャネル・イベントの一意の識別子。
    • EventNameCd; string; イベントの名前を示す参照コード。
    • InteractionId; integer; 作業オブジェクト・チャネル・イベントに関連付けられた顧客対応の一意の識別子。
    • LastUpdateDate; string; チャネル・イベントが最後に更新された日時。
    • LastUpdateLogin; string; チャネル・イベントを最後に更新したユーザー。
    • LastUpdatedBy; string; チャネル・イベントを最後に更新したユーザーのログイン。
    • ObjectId; string; チャネル・イベントに関連付けられたビジネス・オブジェクトまたはクライアント・チャネル・インスタンス識別子の一意の識別子。
    • ObjectTypeCd; string; イベントに関連付けられているビジネス・オブジェクトのタイプ(SVC_SERVICE_REQUESTSなど)。
    • 優先度、整数、イベントに関連付けられたビジネス・オブジェクトの優先度。 たとえば、SRの優先度は重大度に基づいて計算できます。
    • QueueId; integer; チャネル・イベントに関連付けられた作業オブジェクトに割り当てられたキューの識別子。
    • ResourcePartyId; integer; チャネル・イベントに関連付けられた作業オブジェクトに割り当てられたリソースの識別子。
    • StartDateTrunc;文字列。チャネル・イベント開始時間の表現は1日に切り捨てられます。
    • StartTime; string;チャネル・イベントが発生した時間または開始した時間。
    • SubmitDateTrunc; string; 基礎となる作業オブジェクトが発行された日付は、その日に切り捨てられます。
    • SubmitTime; string;基礎となる作業オブジェクトが発行された時間。
    • 値;文字列;チャネル・イベントに関連付けられた値。 値の意味はイベント固有です。
    • WorkObjectId; integer; チャネル・イベントに関連付けられた作業オブジェクトの一意の識別子。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : omniChannelEvents
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : omniChannelEvents-item-response
タイプ: object
ソースを表示
  • タイトル: Business Unit ID
    チャネル・イベントの作業オブジェクトに関連付けられたビジネス・ユニット組織の一意の識別子。
  • タイトル: Channel ID
    作業オブジェクト・チャネル・イベントに関連付けられたチャネルの一意の識別子。
  • タイトル: Channel
    最大長: 30
    チャネル・タイプを示すコード。 受け入れられる値のリストは、参照ORA_SVC_CHANNEL_TYPE_CDで定義されます。
  • 作業オブジェクト・チャネル・イベントに関連付けられた担当者パーティの一意の識別子。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    チャネル・イベントを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    チャネル・イベントが作成された日時。
  • 読取り専用: true
    チャネル・イベントを削除できるかどうかを示します。
  • タイトル: Duration in Milliseconds
    チャネル・イベントの終了時間と開始時間の差(ミリ秒)。
  • タイトル: End Date Truncated
    日に切り捨てられたチャネル・イベント終了時間の表現。
  • タイトル: End Time
    このチャネル・イベントが終了した時間。
  • タイトル: Event ID
    読取り専用: true
    チャネル・イベントの一意の識別子。
  • タイトル: Event Name
    最大長: 30
    イベントの名前を示す参照コード。
  • タイトル: Interaction ID
    作業オブジェクト・チャネル・イベントに関連付けられた顧客対応の一意の識別子。
  • タイトル: Last Updated Date
    読取り専用: true
    チャネル・イベントが最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    チャネル・イベントを最後に更新したユーザーのログイン。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    チャネル・イベントを最後に更新したユーザー。
  • Links
  • タイトル: Object ID
    最大長: 64
    チャネル・イベントに関連付けられたビジネス・オブジェクトまたはクライアント・チャネル・インスタンス識別子の一意の識別子。
  • タイトル: Object Type
    最大長: 30
    SVC_SERVICE_REQUESTSなど、イベントに関連付けられたビジネス・オブジェクトのタイプ。
  • タイトル: Priority
    イベントに関連付けられたビジネス・オブジェクトの優先度。 たとえば、SRの優先度は重大度に基づいて計算できます。
  • タイトル: Queue ID
    チャネル・イベントに関連付けられた作業オブジェクトに割り当てられたキューの識別子。
  • タイトル: Resource Party ID
    チャネル・イベントに関連付けられた作業オブジェクトに割り当てられたリソースの識別子。
  • タイトル: Start Date Truncated
    日に切り捨てられたチャネル・イベント開始時間の表現。
  • タイトル: Start Time
    チャネル・イベントが発生した時間または開始した時間。
  • タイトル: Submit Time Truncated
    基礎となる作業オブジェクトが日付に切り捨てられた日付。
  • タイトル: Submit Time
    基礎となる作業オブジェクトが発行された時間。
  • 読取り専用: true
    チャネル・イベントを更新できるかどうかを示します。
  • タイトル: Value
    最大長: 128
    チャネル・イベントに関連付けられた値。 値の意味はイベント固有です。
  • タイトル: Work Object ID
    チャネル・イベントに関連付けられた作業オブジェクトの一意の識別子。
「トップに戻る」