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

すべてのイベントの取得

get

/crmRestApi/resources/11.13.18.05/multiChannelAdapterEvents

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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>

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

    • AltKey_McaEventNumber : 指定された公開一意識別子を持つイベントを検索します。
      ファインダ変数:
      • McaEventNumber; string;イベントの公開一意識別子。
    • PrimaryKey : 指定された主キーを持つイベントを検索します。
      ファインダ変数:
      • McaEventId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AgentId; integer; パーティ・エンティティのエージェント識別子。
    • ApplClassificationCd; string; このイベントが適用されるアプリケーション分類のコード。
    • BoEntityId; integer; ビジネス・オブジェクト・エンティティ表の自動生成された数値および主キー。
    • ChannelId; integer; channels表の自動生成された数値および主キー。
    • CommId; string; APIイベントIDで表される通信ID。
    • ContactId; integer; contact表の自動生成された数値と主キー。
    • CreatedBy; string; イベントを作成したユーザー。
    • CreationDate; string; イベントが作成された日時。
    • DirectionCd; string;トークン値のイベントの方向。
    • EntityName; string;ビジネス・オブジェクト・エンティティの一意の識別子。
    • ErrorMsg; string; イベント処理のエラー・メッセージ。
    • ErrorMsgCd; string; イベント処理のエラー・コード。
    • InTokens; string; リクエスト・ペイロードの入力トークン。
    • InteractionId; integer; 相互作用表の自動生成された数値と主キー。
    • LastUpdateDate; string; イベントを最後に更新したユーザー。
    • LastUpdateLogin; string;イベントを最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; イベントが最後に更新された日付。
    • McaEventId; integer; イベントの自動生成された数値と主キー。
    • McaEventNumber; string;行の作成中に必要な公開サロゲート・キー。
    • メソッド、文字列。呼出し元イベント・メソッドの名前。
    • NextState; string; イベント処理によって計算される次の状態。
    • ObjectVersionNumber; integer;オブジェクト・バージョン番号は、オプティミスティック・ロックの実装に使用されます。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
    • オリジン、文字列。イベント・イニシエータを表すURL。
    • OutTokens; string; レスポンス・ペイロードの出力トークン。
    • 結果、文字列。イベント処理の結果が返されます。
    • ToolbarId; integer;ツールバー表の自動生成された数値および主キー。
    • ToolbarName; string;このイベントに使用されるツールバー名。
    • Uuid; string;クライアント・レスポンスの一意の識別子。
    • Version; string;クライアント側コンシューマのバージョン。
    • WindowName; string; イベントのクライアント・ウィンドウ識別子。
    • WrapupId; integer; ラップ・アップ表の自動生成された数値と主キー。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : multiChannelAdapterEvents
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : multiChannelAdapterEvents-item-response
タイプ: object
ソースを表示
リンク
fetchUserEventConfiguration
マルチ・チャネル・アダプタ・イベントの処理に使用される現在のユーザーのツールバー構成をフェッチします。 フェッチされる情報には、debugMode、faTrustToken、AGENT_CONFIG_DATA、agentPartyId、agentId、profileMcaDisableJwt、NLS_LANGおよびNLS_LOCALEの値が含まれます
processEvent
このアクションは、入力トークンを含むイベント・リクエストを処理するために必要なデータを含むjsonStringを受け入れます。 処理されたイベントのレスポンスには、出力トークンと、クライアント側で実行する適用可能なアクションのリストが含まれます。
「トップに戻る」