計算シミュレーションの取得
get
/fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimationInsights/{SimulationId}
リクエスト
パス・パラメータ
- SimulationId(required): integer(int64)
このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: 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のデフォルト・バージョンを選択します。
ルート・スキーマ : incentiveCompensationEstimationInsights-item-response
タイプ:
ソースを表示
object
-
AsynchronousRequestId: integer (int64)
読取り専用:
true
計算シミュレーションを非同期で実行するために使用されるジョブの一意の識別子。 -
CalculationCurrencyCode: string
読取り専用:
true
最大長:15
計算通貨コード。 -
CreatedBy: string
読取り専用:
true
最大長:64
計算シミュレーションを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
計算シミュレーションが作成された日時。 -
CurrentEarningsSumCalculation: number
読取り専用:
true
計算シミュレーションの前に、参加者がすでに獲得した計算通貨での支給の合計です。 -
CurrentEarningsSumFunctional: number
読取り専用:
true
計算シミュレーションの前に参加者がすでに獲得した機能通貨での支給の合計です。 -
CurrentEarningsSumHome: number
読取り専用:
true
計算シミュレーションの前に、参加者がすでに獲得したホーム通貨での支給の合計です。 -
EndPayPeriodId: integer (int64)
読取り専用:
true
この計算シミュレーションの支給に対する支給期間の最高額ID。 -
ErrorCode: string
読取り専用:
true
最大長:30
計算シミュレーションがエラーまたは警告ステータスで終了した場合、この値はエラー・タイプを示します。 -
GainSumCalculation: number
読取り専用:
true
計算シミュレーション中に計算された計算通貨での利益の合計です。 -
GainSumFunctional: number
読取り専用:
true
計算シミュレーション中に計算された機能通貨での利益の合計です。 -
GainSumHome: number
読取り専用:
true
計算シミュレーション中に計算されたホーム通貨での利益の合計。 -
HomeCurrencyCode: string
読取り専用:
true
最大長:15
参加者のホーム通貨コード。 -
LastUpdateDate: string (date-time)
読取り専用:
true
計算シミュレーションが最後に更新された日時。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
計算シミュレーションを最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
計算シミュレーションを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
OrgId: integer (int64)
読取り専用:
true
シミュレーションに関連付けられたビジネス・ユニットの一意の識別子。 -
ParticipantId: integer (int64)
読取り専用:
true
シミュレーションが作成された関係者の一意の識別子。 -
ParticipantName: string
読取り専用:
true
最大長:360
シミュレーションが作成された参加者の名前。 -
PartyNumber: string
読取り専用:
true
最大長:30
シミュレーションが作成された参加者のパーティ番号。 -
ProcessAuditId: integer (int64)
読取り専用:
true
プロセス監査ログの検索に使用されるプロセス監査の一意の識別子。 -
ProcessingDate: string (date-time)
読取り専用:
true
シミュレーションが処理された日付。 -
ProcessingStatus: string
読取り専用:
true
最大長:20
デフォルト値:ORA_CN_NOT_READY
シミュレーション・プロセスのステータス。 -
SimulationId: integer (int64)
読取り専用:
true
計算シミュレーションの一意の識別子。 -
SimulationName: string
読取り専用:
true
最大長:160
計算シミュレーションを識別するためのオプションのわかりやすい名前。 -
SourceObjectId: integer (int64)
読取り専用:
true
シミュレーションが作成されたオブジェクトのシステム識別子。 -
SourceObjectNumber: string
読取り専用:
true
最大長:30
シミュレーションが作成されたオブジェクトのユーザー指定識別子。 商談ベースのシミュレーションの場合、これは商談番号になります。 -
SourceObjectType: string
読取り専用:
true
最大長:30
シミュレーションが作成されたオブジェクトのタイプ。 -
StartPayPeriodId: integer (int64)
読取り専用:
true
この計算シミュレーションの支給項目の最下位の支給期間識別子。 -
SummaryByPlanComponent: array Estimation Summary by Plan Components
タイトル:
Estimation Summary by Plan Components
計算シミュレーション・リソースは、シミュレーション結果をプラン・コンポーネント別に表示するために使用されます。 -
UpdateQueued: string
読取り専用:
true
最大長:1
処理対象のキューに同じ名前の新規シミュレーションがあることを示します。
ネストされたスキーマ : プラン・コンポーネント別見積要約
タイプ:
array
タイトル:
Estimation Summary by Plan Components
計算シミュレーション・リソースは、シミュレーション結果をプラン・コンポーネント別に表示するために使用されます。
ソースを表示
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
ネストされたスキーマ : incentiveCompensationEstimationInsights-SummaryByPlanComponent-item-response
タイプ:
ソースを表示
object
-
CalculationCurrencyCode: string
読取り専用:
true
最大長:15
計算通貨コード。 -
CompensationPlanDisplayName: string
読取り専用:
true
最大長:80
見積結果が生成される報酬プランのユーザー指定表示名。 -
CompensationPlanId: integer (int64)
読取り専用:
true
見積結果が生成される報酬プランの一意の識別子。 -
CompensationPlanName: string
読取り専用:
true
最大長:80
見積結果が生成される報酬プランを識別する一意の名前。 -
CurrentEarningsSumCalculation: number
読取り専用:
true
計算シミュレーションの前に、参加者がすでに獲得した計算通貨での支給の合計です。 -
CurrentEarningsSumFunctional: number
読取り専用:
true
計算シミュレーションの前に参加者がすでに獲得した機能通貨での支給の合計です。 -
CurrentEarningsSumHome: number
読取り専用:
true
計算シミュレーションの前に、参加者がすでに獲得したホーム通貨での支給の合計です。 -
FormulaId: integer (int64)
読取り専用:
true
推定結果を導出するためにプラン・コンポーネントで使用される式の一意の識別子。 -
GainSumCalculation: number
読取り専用:
true
計算シミュレーション中に計算された計算通貨での利益の合計です。 -
GainSumFunctional: number
読取り専用:
true
計算シミュレーション中に計算された機能通貨での利益の合計です。 -
GainSumHome: number
タイトル:
Estimated Earnings
読取り専用:true
計算シミュレーション中に計算されたホーム通貨での利益の合計。 -
HomeCurrencyCode: string
読取り専用:
true
最大長:15
参加者のホーム通貨コード。 -
IntervalEndDate: 文字列(日付)
読取り専用:
true
この計算シミュレーションにおけるプラン・コンポーネントの支給の間隔のカレンダ終了日。 -
IntervalNumber: string
読取り専用:
true
最大長:50
この計算シミュレーションにおけるプラン・コンポーネントの支給項目の間隔番号。 -
IntervalStartDate: 文字列(日付)
読取り専用:
true
この計算シミュレーションにおけるプラン・コンポーネントの支給の間隔のカレンダ開始日。 -
IntervalTypeName: string
読取り専用:
true
最大長:80
プラン・コンポーネントで使用される間隔タイプの名前。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
OrgId: integer (int64)
読取り専用:
true
シミュレーションに関連付けられたビジネス・ユニットの一意の識別子。 -
PayPeriodEndDate: 文字列(日付)
読取り専用:
true
この計算シミュレーションにおけるプラン・コンポーネントの支給の支給期間のカレンダ終了日。 -
PayPeriodId: integer (int64)
読取り専用:
true
この計算シミュレーションにおけるプラン・コンポーネントの支給項目の支払期間識別子。 -
PayPeriodName: string
タイトル:
Period
読取り専用:true
最大長:30
この計算シミュレーションにおけるプラン・コンポーネントの支給項目の支払期間の名前。 -
PayPeriodStartDate: 文字列(日付)
読取り専用:
true
この計算シミュレーションにおけるプラン・コンポーネントの支給の支給期間のカレンダ開始日。 -
PlanComponentDisplayName: string
タイトル:
Plan Component
読取り専用:true
最大長:80
見積結果が生成されるプラン・コンポーネントのユーザーが指定した表示名。 -
PlanComponentId: integer (int64)
読取り専用:
true
推定結果が生成されるプラン・コンポーネントの一意の識別子。 -
PlanComponentName: string
読取り専用:
true
最大長:80
見積結果が生成される報酬プランを識別する一意の名前。 -
SimulationId: integer (int64)
読取り専用:
true
親計算シミュレーションの一意の識別子。 -
SrpCompensationPlanId: integer (int64)
読取り専用:
true
参加者プランの一意の識別子。 -
SummaryByPlanComponentId: integer
読取り専用:
true
推定結果が生成される参加者報酬プランの一意の識別子。
リンク
- SummaryByPlanComponent
-
パラメータ:
- SimulationId:
$request.path.SimulationId
計算シミュレーション・リソースは、シミュレーション結果をプラン・コンポーネント別に表示するために使用されます。 - SimulationId:
例:
次の例は、RESTリソースに対してGETリクエストを発行して、計算シミュレーションを取得する方法を示しています。
cURLコマンド
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimationInsights/10034 \ -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json' | json_pp
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "SimulationId": 10034, "SimulationName": "300100052468154_300100562426638", "SourceObjectType": "opportunities", "SourceObjectId": 300100562426638, "SourceObjectNumber": "CDRM_128503", "ParticipantId": 19001, "ParticipantName": "Stephanie Rodriquez", "PartyNumber": "CDRM_91767", "OrgId": 204, "ProcessingDate": "2022-12-07T00:59:37+00:00", "ProcessingStatus": "ORA_CN_ERROR", "ErrorCode": "ORA_CN_CLASSIFICATION", "CurrentEarningsSumCalculation": null, "CurrentEarningsSumFunctional": null, "CurrentEarningsSumHome": null, "GainSumCalculation": null, "GainSumFunctional": null, "GainSumHome": null, "CalculationCurrencyCode": null, "HomeCurrencyCode": null, "StartPayPeriodId": null, "EndPayPeriodId": null, "ProcessAuditId": null, "AsynchronousRequestId": 113248, "CreationDate": "2022-12-07T00:59:20+00:00", "CreatedBy": "OIC_MGR_OPERATIONS", "LastUpdateDate": "2022-12-07T00:59:20+00:00", "LastUpdatedBy": "OIC_MGR_OPERATIONS", "LastUpdateLogin": "EF32F6361D0B9F77E0536902F40A94FC", "UpdateQueued": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimationInsights/10034", "name": "incentiveCompensationEstimationInsights", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimationInsights/10034", "name": "incentiveCompensationEstimationInsights", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimationInsights/10034/child/SummaryByPlanComponent", "name": "SummaryByPlanComponent", "kind": "collection" } ] }