機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 値リスト
  4. 構成の取得

すべての構成の取得

get

/crmRestApi/resources/11.13.18.05/getConfigs

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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 : 指定された主キーを持つ構成を検索します。 - サポートなし
      ファインダ変数:
      • billingId; string;請求の一意の識別子。 - サポートなし
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • billingId; string; 請求システムの一意の識別子。
    • billingServiceHost; string;請求システムのホスト。
    • channelCachedContentServer; string;キャッシュされたコンテンツ・サーバーの名前。
    • channelServiceEnabled; string; チャット・サービスが有効かどうかを示します。 常に「true」に設定します。
    • channelServiceHost; string;チャット・サービスのホスト名。
    • interfaceId; string;チャット・サービスのデフォルト・インタフェース。
    • isDECFlag; boolean。デジタル・エンゲージメント・チャネル・プロファイル・オプションが有効かどうかを示します。 プロファイル・オプションでは、デジタル・エンゲージメント・チャネル・サービスでサポートされる機能が有効になります。 プロファイル・オプションは、「設定およびメンテナンス」>「サービス」>「通信チャネル」>「デジタル・エンゲージメント・チャネル」で設定できます。
    • launchPage; string;チャット・サービスの開始ページ。
    • servicePoolId; string;チャット・サービスのプールID。
    • tenantName; string;チャット・サービス・テナントの名前。
    • tenantType; string;チャット・サービス・テナントのタイプ。 常に"Engagement Cloud"に設定されます。
    • tenantVersion; string;チャット・サービス・テナントのバージョン。
    • videoClientScript; string;ビデオ・クライアントjavascriptファイルのロケーション。
    • videoEnabled; string; ビデオ・クライアントが有効かどうかを示します。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : getConfigs
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : getConfigs-item-response
タイプ: object
ソースを表示
  • 読取り専用: true
    請求システムの一意の識別子。
  • 読取り専用: true
    請求システムのホスト。
  • 読取り専用: true
    キャッシュされたコンテンツ・サーバーの名前。
  • 読取り専用: true
    チャット・サービスが有効かどうかを示します。 常に「true」に設定します。
  • 読取り専用: true
    チャット・サービスのホスト名。
  • 読取り専用: true
    チャット・サービスのデフォルト・インタフェース。
  • デジタル・エンゲージメント・チャネル・プロファイル・オプションが使用可能かどうかを示します。 プロファイル・オプションでは、デジタル・エンゲージメント・チャネル・サービスでサポートされる機能が有効になります。 プロファイル・オプションは、「設定およびメンテナンス」>「サービス」>「通信チャネル」>「デジタル・エンゲージメント・チャネル」で設定できます。
  • 読取り専用: true
    チャット・サービスの開始ページ。
  • Links
  • 読取り専用: true
    チャット・サービスのプールID。
  • 読取り専用: true
    チャット・サービス・テナントの名前。
  • 読取り専用: true
    チャット・サービス・テナントのタイプ。 常に"Engagement Cloud"に設定されます。
  • 読取り専用: true
    チャット・サービス・テナントのバージョン。
  • 読取り専用: true
    ビデオ・クライアントjavascriptファイルのロケーション。
  • 読取り専用: true
    ビデオ・クライアントが有効かどうかを示します。
「トップに戻る」