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

すべてのロールアップの取得

get

/crmRestApi/resources/11.13.18.05/rollups

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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主キーを使用してロールアップを検索します。
      ファインダ変数
      • RollupId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • CreatedBy; string;ロールアップを作成したユーザー。
    • CreationDate; string; ロールアップが作成された日時。
    • 頻度;整数;頻度単位コードで指定された単位でのロールアップのリフレッシュ頻度。
    • FrequencyUnitCode; string; リフレッシュ頻度に使用される単位。
    • FunctionCode; string; ロールアップ計算に使用される演算子。
    • HierarchyAttribute; string; ロールアップから階層値を格納するために使用される属性。
    • HierarchyFlag; boolean;ロールアップに階層属性があるかどうかを示します。
    • LastProcessedDate; string;ロールアップ値が最後にリフレッシュされた日時。
    • LastProcessedStatusCode; string;最後のリフレッシュ・プロセスのステータス・コード。
    • LastSuccessfulRun; string; ロールアップが最後に正常にリフレッシュされた日時。
    • LastUpdateDate; string; ロールアップ構成が最後に更新された日時。
    • LastUpdateLogin; string;ロールアップを最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; ロールアップ構成を最後に更新したユーザー。
    • Name; string;ロールアップに指定された名前。
    • PublishedDate; string; ロールアップが公開された日時。
    • PublishedFlag; boolean;ロールアップがパブリッシュされるかどうかを示します。
    • RelatedObjectAttribute; string; ロールアップ計算に使用される関連オブジェクトの属性。
    • RelatedObjectCode; string; ロールアップの関連オブジェクトとして選択されたオブジェクト・タイプ。
    • RelationshipCode; string;ターゲットと関連オブジェクト間の関係。
    • RollupId; string;ロールアップの一意の識別子。
    • RollupTypeCode; string; ロールアップ・タイプが通常かエージングかを示します。
    • SourceObjectAttribute; string; ロールアップからの値の格納に使用される属性。
    • SourceObjectCode; string; ロールアップのターゲット・オブジェクトとして選択されたオブジェクト・タイプ。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : ロールアップ
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : rollups-item-response
タイプ: object
ソースを表示
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    ロールアップを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    ロールアップが作成された日時。
  • タイトル: Description
    最大長: 400
    ロールアップに指定された摘要。
  • タイトル: Error Message
    読取り専用: true
    最大長: 4000
    ロールアップに定義されたエラー・メッセージ。
  • タイトル: Calculation Frequency
    デフォルト値: 1
    周期ユニット・コードによって提供されるユニット単位でのロールアップのリフレッシュ頻度。
  • タイトル: Calculation Frequency Unit
    最大長: 30
    デフォルト値: ORA_HOUR
    リフレッシュ頻度に使用される単位。
  • タイトル: Aggregation Function
    最大長: 30
    積上計算に使用される演算子。
  • タイトル: Hierarchy Rollup Attribute
    最大長: 100
    積上からの階層値の格納に使用される属性。
  • タイトル: Hierarchy Rollup
    最大長: 1
    ロールアップに階層属性があるかどうかを示します。
  • タイトル: Last Refreshed Date
    読取り専用: true
    積上値が最後にリフレッシュされた日時。
  • タイトル: Refresh Status
    読取り専用: true
    最大長: 30
    最後のリフレッシュ・プロセスのステータス・コード。
  • タイトル: Last Successful Refresh
    読取り専用: true
    ロールアップが最後に正常にリフレッシュされた日時。
  • タイトル: Last Updated Date
    読取り専用: true
    積上構成が最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    ロールアップ構成を最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    ロールアップを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Name
    最大長: 128
    ロールアップに指定された名前。
  • タイトル: Published By
    読取り専用: true
    最大長: 64
    ロールアップを発行したユーザー。
  • タイトル: Published Date
    読取り専用: true
    ロールアップが公開された日時。
  • タイトル: Published
    読取り専用: true
    最大長: 1
    デフォルト値: false
    ロールアップが公開されているかどうかを示します。
  • タイトル: Maximum Number of Days for Data Selection
    アクティビティおよび顧客対応ロールアップのローリング・データ選択の最大日数。
  • タイトル: Attribute
    最大長: 100
    積上計算に使用される関連オブジェクトの属性。
  • タイトル: Related Object
    最大長: 128
    ロールアップの関連オブジェクトとして選択されたオブジェクト・タイプ。
  • タイトル: Related Object Filter
    最大長: 1000
    ロールアップで使用される関連オブジェクトのフィルタ式。
  • タイトル: Relationship
    最大長: 100
    ターゲットと関連オブジェクト間の関係。
  • タイトル: Rollup ID
    読取り専用: true
    最大長: 64
    ロールアップの一意の識別子。
  • タイトル: Type
    最大長: 30
    デフォルト値: ORA_REGULAR
    積上タイプが通常か年齢調べかを示します。
  • タイトル: Rollup Attribute
    最大長: 100
    ロールアップからの値の格納に使用される属性。
  • タイトル: Source Object
    最大長: 128
    デフォルト値: Account
    ロールアップのターゲット・オブジェクトとして選択されたオブジェクト・タイプ。
  • タイトル: Source Object Filter
    最大長: 1000
    ロールアップで使用されるターゲット・オブジェクトのフィルタ式。
「トップに戻る」