すべてのシミュレーション・メジャー結果の取得
get
/fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/MeasureResults
リクエスト
パス・パラメータ
- SimulationId(required): integer(int64)
計算シミュレーションの一意の識別子。
問合せパラメータ
- 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 - finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。
フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します:- MeasureResultIdFinder : 指定されたシミュレーション・メジャー結果識別子を持つシミュレーション支給を検索します。
ファインダ変数:- MeasureResultId; integer;シミュレーション・メジャー結果の一意の識別子。
- PrimaryKey : 指定された主キーを持つシミュレーション・メジャー結果を検索します。
ファインダ変数:- MeasureResultId; integer;シミュレーション・メジャー結果の一意の識別子。
- SimulationId; integer;計算シミュレーションの一意の識別子。
- MeasureResultIdFinder : 指定されたシミュレーション・メジャー結果識別子を持つシミュレーション支給を検索します。
- limit: integer
このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
- links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- offset: integer
リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
- orderBy: string
このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
- q: string
この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY
フォーマット : ?q=expression1;expression2
次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- CalculationCurrency; string;計算通貨コード。
- CommissionValue; number;レート表のレート。
- CompensationPlanId; integer; メジャー結果が計算される報酬プランの一意の識別子。
- CompensationPlanName; string;メジャー結果が計算される報酬プランの名前。
- CreatedBy; string; メジャー結果レコードを作成したユーザー。
- CreatedDuring; string; このレコードが作成されたフェーズ。 指定可能な値は、ロールアップ、適格、計算です。
- CreationDate; string; メジャー結果レコードが作成された日付。
- CreditAmount; number;計算通貨での貸方金額。
- CreditFactor; number。パフォーマンス・メジャーに関連付けられたクレジット・カテゴリに適用されるクレジット・ファクタ。
- CreditId; integer; クレジット・トランザクションの一意の識別子。
- CreditedParticipantId; integer;トランザクションのクレジットを受け取る関係者の一意の識別子。
- CreditedParticipantName; string;トランザクションのクレジットを受け取る参加者の名前。
- EarningFactor; number。パフォーマンス・メジャーに関連付けられた支給係数。
- EarningTypeId; integer;支給タイプの識別子。
- EligibleCatId; integer;分類中に移入されるトランザクション・クレジット・カテゴリ。
- ErrorReason; string;計算中のエラーの理由。
- EventFactorValue; number。パフォーマンス・メジャーに関連付けられたクレジット・カテゴリに適用されるトランザクション・タイプのイベント・ファクタ。
- FormulaId; integer; メジャー結果が計算されるパフォーマンス・メジャーの一意の識別子。
- FormulaWeight; number;プラン・コンポーネント内のパフォーマンス・メジャーの重み。
- InputAchieved; number。パフォーマンス・メジャーで定義された入力式に基づいてレート表に渡される金額。
- LastUpdateDate; string; レコードが最後に更新された日付。
- LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
- LastUpdatedBy; string; レコードを最後に更新したユーザー。
- MeasureResultId; integer;シミュレーション・メジャー結果の識別子。
- ObjectStatus; string;計算済、計算エラー、適格または戻し処理済など、メジャー結果レコードの現在のステータス。
- ObjectStatusMeaning; string;プロセス・ステータス参照コードの表示ラベル。
- OrgId; integer; メジャー結果レコードに関連付けられたビジネス・ユニットの一意の識別子。
- OutputAchieved; number。パフォーマンス・メジャーの出力式によって計算される金額。
- PerformanceMeasureName; string;メジャー結果が計算されるパフォーマンス・メジャーの名前。
- PlanComponentId; integer; メジャー結果が計算されるプラン・コンポーネントの一意の識別子。
- PlanComponentName; string; メジャー結果が計算されるプラン・コンポーネントの名前。
- SimulationDeleteFlag; boolean。計算シミュレーション処理中にメジャー結果が削除されたかどうかを示します。
- SimulationId; integer; このシミュレーション・メジャー結果が属するシミュレーションの識別子。
- SimulationResultType; string; メジャー結果がシミュレーション実行によるものか、既存の計算済メジャー結果からのものかを示します。
- SourceEventDate; string;シミュレーション・トランザクションの日付。
- SourceEventPeriodId; integer;ソース・イベント日の期間識別子。
- SourceTrxNumber; string; トランザクションを識別するトランザクション番号。
- SrpCompensationPlanId; integer;参加者報酬プラン割当レコードの一意の識別子。
- TierSplits; integer;レート表の層。
- TransactionAmount; number;計算通貨でのトランザクション金額。
- TransactionId; integer;トランザクションの一意の識別子。
- TransactionType; string;トランザクションのタイプ。 この値は、オーダー、請求書、クレジット・メモなど、トランザクションのソースを示します。 設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、参照タイプCN_TP_TRANSACTION_TYPEの使用可能な参照コードをレビューします。
- TransactionTypeMeaning; string;トランザクション・タイプ参照コードの表示ラベル。
- totalResults: boolean
"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : incentiveCompensationCalculationSimulations-MeasureResults
タイプ:
ソースを表示
object
-
count(required): integer
現在の範囲で返されたリソース・インスタンスの数。
-
hasMore(required): boolean
サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースがさらにあります。 デフォルト値はfalseです。
-
items: array Items
タイトル:
Items
コレクション内のアイテム。 -
limit(required): integer
サーバーで使用される実際のページング・サイズ。
-
links(required): array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
offset(required): integer
現在のページで使用されるオフセット値。
-
totalResults: integer
"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : incentiveCompensationCalculationSimulations-MeasureResults-item-response
タイプ:
ソースを表示
object
-
CalculationCurrency: string
読取り専用:
true
最大長:15
計算通貨コード。 -
CommissionValue: number
読取り専用:
true
レート表のレート。 -
CompensationPlanId: integer (int64)
読取り専用:
true
メジャー結果が計算される報酬プランの一意の識別子。 -
CompensationPlanName: string
タイトル:
Name
読取り専用:true
最大長:80
メジャー結果が計算される報酬プランの名前。 -
CreatedBy: string
読取り専用:
true
最大長:64
測定結果レコードを作成したユーザー。 -
CreatedDuring: string
読取り専用:
true
最大長:30
このレコードが作成されたフェーズ。 指定可能な値は、ロールアップ、適格、計算です。 -
CreationDate: string (date-time)
読取り専用:
true
メジャー結果レコードが作成された日付。 -
CreditAmount: number
読取り専用:
true
計算通貨での貸方金額。 -
CreditedParticipantId: integer (int64)
読取り専用:
true
トランザクションのクレジットを受け取る関係者の一意の識別子。 -
CreditedParticipantName: string
タイトル:
Participant Name
読取り専用:true
最大長:360
トランザクションのクレジットを受け取る参加者の名前。 -
CreditFactor: number
読取り専用:
true
パフォーマンス・メジャーに関連付けられたクレジット・カテゴリに適用されるクレジット・ファクタ。 -
CreditId: integer (int64)
読取り専用:
true
クレジット・トランザクションの一意の識別子。 -
EarningFactor: number
読取り専用:
true
パフォーマンス・メジャーに関連付けられた支給係数。 -
EarningTypeId: integer (int64)
読取り専用:
true
支給タイプの識別子。 -
EligibleCatId: integer (int64)
読取り専用:
true
分類中に移入されたトランザクション・クレジット・カテゴリ。 -
ErrorReason: string
読取り専用:
true
最大長:150
計算中のエラーの理由。 -
EventFactorValue: number
読取り専用:
true
パフォーマンス・メジャーに関連付けられたクレジット・カテゴリに適用されるトランザクション・タイプのイベント・ファクタ。 -
FormulaId: integer (int64)
読取り専用:
true
メジャー結果が計算されるパフォーマンス・メジャーの一意の識別子。 -
FormulaWeight: number
読取り専用:
true
プラン・コンポーネント内のパフォーマンス・メジャーの加重。 -
InputAchieved: number
読取り専用:
true
パフォーマンス・メジャーで定義された入力式に基づいてレート表に渡される金額。 -
LastUpdateDate: string (date-time)
読取り専用:
true
レコードが最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
レコードを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MeasureResultId: integer (int64)
読取り専用:
true
シミュレーション・メジャー結果の識別子。 -
ObjectStatus: string
読取り専用:
true
最大長:30
計算済、計算エラー、適格または戻し処理済など、メジャー結果レコードの現在のステータス。 -
ObjectStatusMeaning: string
読取り専用:
true
最大長:80
プロセス・ステータス参照コードの表示ラベル。 -
OrgId: integer (int64)
読取り専用:
true
メジャー結果レコードに関連付けられたビジネス・ユニットの一意の識別子です。 -
OutputAchieved: number
読取り専用:
true
パフォーマンス・メジャーの出力式によって計算された金額。 -
PerformanceMeasureName: string
タイトル:
Name
読取り専用:true
最大長:80
メジャー結果が計算されるパフォーマンス・メジャーの名前。 -
PlanComponentId: integer (int64)
読取り専用:
true
メジャー結果が計算されるプラン・コンポーネントの一意の識別子。 -
PlanComponentName: string
タイトル:
Name
読取り専用:true
最大長:80
メジャー結果が計算されるプラン・コンポーネントの名前。 -
SimulationDeleteFlag: boolean
読取り専用:
true
最大長:1
計算シミュレーション処理中にメジャー結果が削除されたかどうかを示します。 -
SimulationId: integer (int64)
読取り専用:
true
このシミュレーション・メジャー結果が属するシミュレーションの識別子。 -
SimulationResultType: string
読取り専用:
true
最大長:30
メジャー結果がシミュレーション実行からのものか、既存の計算済メジャー結果からのものかを示します。 -
SourceEventDate: 文字列(日付)
読取り専用:
true
シミュレーション・トランザクションの日付。 -
SourceEventPeriodId: integer (int64)
読取り専用:
true
ソース・イベント日の期間識別子。 -
SourceTrxNumber: string
読取り専用:
true
最大長:30
トランザクションを識別するトランザクション番号。 -
SrpCompensationPlanId: integer (int64)
読取り専用:
true
参加者報酬プラン割当レコードの一意の識別子。 -
TierSplits: integer (int64)
読取り専用:
true
レート表の階層。 -
TransactionAmount: number
読取り専用:
true
計算通貨でのトランザクション金額。 -
TransactionId: integer (int64)
読取り専用:
true
トランザクションの一意の識別子。 -
TransactionType: string
読取り専用:
true
最大長:30
トランザクションのタイプ。 この値は、オーダー、請求書、クレジット・メモなど、トランザクションのソースを示します。 設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、参照タイプCN_TP_TRANSACTION_TYPEの使用可能な参照コードをレビューします。 -
TransactionTypeMeaning: string
読取り専用:
true
最大長:80
トランザクション・タイプ参照コードの表示ラベル。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。