Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

ロールアップの取得

get

/crmRestApi/resources/11.13.18.05/rollups/{RollupId}

リクエスト

パス・パラメータ

RollupId(required): string

このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。例: products?q=InventoryItemId=

問合せパラメータ

dependency: string

このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。通常、これらは属性変更の影響をプレビューするために使用されます。このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。この問合せパラメータの値は、依存性フィールドのセットです。例: dependency=ProductId=2

フォーマット: <attr1>=<val1>,<attr2>=<value2>
expand: string

このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。この問合せパラメータの値は"all"または""です。カンマをセパレータとして使用して、複数の子を指定できます。例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
fields: string

このパラメータは、リソース・フィールドをフィルタします。指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。両方を指定した場合、フィールドのみが考慮されます。

フォーマット : ?fields=Attribute1,Attribute2

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
onlyData: boolean

リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : rollups-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

ロールアップを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

ロールアップが作成された日時。
Description: string

タイトル: Description

最大長: 400

ロールアップに指定された摘要。
ErrorMessage: string

タイトル: Error Message

読取り専用: true

最大長: 4000

ロールアップに定義されたエラー・メッセージ。
頻度: 整数(int32)

タイトル: Calculation Frequency

デフォルト値: 1

周期ユニット・コードによって提供されるユニット単位でのロールアップのリフレッシュ頻度。
FrequencyUnitCode: string

タイトル: Calculation Frequency Unit

最大長: 30

デフォルト値: ORA_HOUR

リフレッシュ頻度に使用される単位。
FunctionCode: string

タイトル: Aggregation Function

最大長: 30

積上計算に使用される演算子。
HierarchyAttribute: string

タイトル: Hierarchy Rollup Attribute

最大長: 100

積上からの階層値の格納に使用される属性。
HierarchyFlag: boolean

タイトル: Hierarchy Rollup

最大長: 1

ロールアップに階層属性があるかどうかを示します。
LastProcessedDate: string (date-time)

タイトル: Last Refreshed Date

読取り専用: true

積上値が最後にリフレッシュされた日時。
LastProcessedStatusCode: string

タイトル: Refresh Status

読取り専用: true

最大長: 30

最後のリフレッシュ・プロセスのステータス・コード。
LastSuccessfulRun: string (date-time)

タイトル: Last Successful Refresh

読取り専用: true

ロールアップが最後に正常にリフレッシュされた日時。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

積上構成が最後に更新された日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

ロールアップ構成を最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

ロールアップを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
Name: string

タイトル: Name

最大長: 128

ロールアップに指定された名前。
PublishedBy: string

タイトル: Published By

読取り専用: true

最大長: 64

ロールアップを発行したユーザー。
PublishedDate: string (date-time)

タイトル: Published Date

読取り専用: true

ロールアップが公開された日時。
PublishedFlag: boolean

タイトル: Published

読取り専用: true

最大長: 1

デフォルト値: false

ロールアップが公開されているかどうかを示します。
RefreshThreshold: 整数(int32)

タイトル: Maximum Number of Days for Data Selection

アクティビティおよび顧客対応ロールアップのローリング・データ選択の最大日数。
RelatedObjectAttribute: string

タイトル: Attribute

最大長: 100

積上計算に使用される関連オブジェクトの属性。
RelatedObjectCode: string

タイトル: Related Object

最大長: 128

ロールアップの関連オブジェクトとして選択されたオブジェクト・タイプ。
RelatedObjectFilter: string

タイトル: Related Object Filter

最大長: 1000

ロールアップで使用される関連オブジェクトのフィルタ式。
RelationshipCode: string

タイトル: Relationship

最大長: 100

ターゲットと関連オブジェクト間の関係。
RollupId: string

タイトル: Rollup ID

読取り専用: true

最大長: 64

ロールアップの一意の識別子。
RollupTypeCode: string

タイトル: Type

最大長: 30

デフォルト値: ORA_REGULAR

積上タイプが通常か年齢調べかを示します。
SourceObjectAttribute: string

タイトル: Rollup Attribute

最大長: 100

ロールアップからの値の格納に使用される属性。
SourceObjectCode: string

タイトル: Source Object

最大長: 128

デフォルト値: Account

ロールアップのターゲット・オブジェクトとして選択されたオブジェクト・タイプ。
SourceObjectFilter: string

タイトル: Source Object Filter

最大長: 1000

ロールアップで使用されるターゲット・オブジェクトのフィルタ式。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the rollup was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":400,
            "type":"string",
            "description":"The description provided for the rollup.",
            "nullable":true,
            "x-queryable":false
        },
        "HierarchyFlag":{
            "title":"Hierarchy Rollup",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the rollup has a hierarchy attribute.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "SourceObjectCode"
                ]
            },
            "x-queryable":true
        },
        "RelatedObjectFilter":{
            "title":"Related Object Filter",
            "maxLength":1000,
            "type":"string",
            "description":"The filter expressions for the related object used in the rollup.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "RelatedObjectCode"
                ]
            }
        },
        "PublishedBy":{
            "title":"Published By",
            "maxLength":64,
            "type":"string",
            "description":"The user that published the rollup.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RelatedObjectCode":{
            "title":"Related Object",
            "maxLength":128,
            "type":"string",
            "description":"The object type selected as the related object for the rollup.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RefreshThreshold":{
            "title":"Maximum Number of Days for Data Selection",
            "type":"integer",
            "description":"The maximum number of days in the rolling data selection for activity and interactions rollups.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":3,
                "dependencies":[
                    "RelatedObjectCode"
                ]
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":128,
            "type":"string",
            "description":"The name given for the rollup.",
            "nullable":false,
            "x-queryable":true
        },
        "RelatedObjectAttribute":{
            "title":"Attribute",
            "maxLength":100,
            "type":"string",
            "description":"The attribute from the related object that's used for the rollup calculation.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RelatedObjectCode"
                ]
            },
            "x-queryable":true
        },
        "RollupTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the rollup type is regular or aging.",
            "nullable":false,
            "default":"ORA_REGULAR",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastProcessedStatusCode":{
            "title":"Refresh Status",
            "maxLength":30,
            "type":"string",
            "description":"The status code from the last refresh process.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Source Object",
            "maxLength":128,
            "type":"string",
            "description":"The object type selected as the target object for the rollup.",
            "nullable":false,
            "default":"Account",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RelationshipCode":{
            "title":"Relationship",
            "maxLength":100,
            "type":"string",
            "description":"The relationship between the target and related object.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RelatedObjectCode"
                ]
            },
            "x-queryable":true
        },
        "FrequencyUnitCode":{
            "title":"Calculation Frequency Unit",
            "maxLength":30,
            "type":"string",
            "description":"The units used for the refresh frequency.",
            "nullable":false,
            "default":"ORA_HOUR",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SourceObjectFilter":{
            "title":"Source Object Filter",
            "maxLength":1000,
            "type":"string",
            "description":"The filter expressions for the target object used in the rollup.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SourceStorageObjectCode"
                ]
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RollupId":{
            "title":"Rollup ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier for the rollup.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceObjectAttribute":{
            "title":"Rollup Attribute",
            "maxLength":100,
            "type":"string",
            "description":"The attribute used to store the value from the rollup.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceObjAttrLovSwitcher"
                ]
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user that last updated the rollup configuration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the rollup.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HierarchyAttribute":{
            "title":"Hierarchy Rollup Attribute",
            "maxLength":100,
            "type":"string",
            "description":"The attribute used to store the hierarchy value from the rollup.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "HierarchyFlag"
                ]
            },
            "x-queryable":true
        },
        "FunctionCode":{
            "title":"Aggregation Function",
            "maxLength":30,
            "type":"string",
            "description":"The operator used on the rollup calculation.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastProcessedDate":{
            "title":"Last Refreshed Date",
            "type":"string",
            "description":"The date and time when the rollup value was last refreshed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastSuccessfulRun":{
            "title":"Last Successful Refresh",
            "type":"string",
            "description":"The date and time that the rollup was last successfully refreshed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Frequency":{
            "title":"Calculation Frequency",
            "type":"integer",
            "description":"The refresh frequency of the rollup in units provided by the frequency unit code.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "PublishedDate":{
            "title":"Published Date",
            "type":"string",
            "description":"The date and time when the rollup was published.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorMessage":{
            "title":"Error Message",
            "maxLength":4000,
            "type":"string",
            "description":"The error message defined for the rollup.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PublishedFlag":{
            "title":"Published",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the rollup is published.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the rollup configuration was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the rollup.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

href: string

タイトル: hyperlink reference

関連リソースへのURI。
kind: string

タイトル: kind

許可された値: [ "collection", "item", "describe", "other" ]

関連リソースの種類。
name: string

タイトル: name

関連リソースへのリンクの名前。
properties: object properties
rel: string

タイトル: relation

許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

リソース・インスタンスとの関係の名前。例: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

リンク

FrequncyUnitCodeVA

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_ZCA_ROLLUP_FREQ_UNIT

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: FrequencyUnitCode;ターゲット属性: LookupCode
表示属性: 意味

FunctionCodeVA

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_ZCA_ROLLUP_FUNCTION_CODE

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: FunctionCode;ターゲット属性: LookupCode
表示属性: 意味

LastProcessedStatusCodeVA

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_ZCA_ROLLUP_PROCESS_STATUS

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: LastProcessedStatusCode;ターゲット属性: LookupCode
表示属性: 意味

RollupTypeCodeVA

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_ZCA_ROLLUP_TYPE

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: RollupTypeCode;ターゲット属性: LookupCode
表示属性: 意味

「トップに戻る」