パフォーマンス・メジャー・スコア・カードの取得
get
/fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureScorecards/{ParticipantPerformanceMeasureScorecardId}
リクエスト
パス・パラメータ
- ParticipantPerformanceMeasureId(required): integer(int64)
参加者プラン・コンポーネントに関連付けられたパフォーマンス・メジャーの一意の識別子。
- ParticipantPerformanceMeasureScorecardId(required): integer(int64)
関係者パフォーマンス・メジャーに関連付けられたスコア・カード・レート表の一意の識別子です。
- ParticipantPlanComponentId(required): integer(int64)
参加者報酬プランに関連付けられたプラン・コンポーネントの一意の識別子です。
- participantCompensationPlansUniqID(required): string
これは、関係者報酬プラン・リソースの複合キーを構成し、関係者報酬プランのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、参加者報酬プラン・コレクション・リソースを問い合せて、ハッシュ・キーを取得するために参加者報酬プランの特定のインスタンスに移動する必要があります。
問合せパラメータ
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureScorecards-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
読取り専用:
true
最大長:64
参加者スコア・カード・レート表を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
参加者スコア・カード・レート表が作成された日時。 -
EndDate: 文字列(日付)
読取り専用:
true
パフォーマンス・メジャーに関連付けられたスコア・カード・レート表が非アクティブになる日付。 -
LastUpdateDate: string (date-time)
読取り専用:
true
参加者スコア・カード・レート表が最後に更新された日時。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
関係者スコア・カード・レート表を最後に更新したユーザー。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ParticipantPerformanceMeasureId: integer (int64)
読取り専用:
true
参加者プラン・コンポーネントに関連付けられたパフォーマンス・メジャーの一意の識別子。 -
ParticipantPerformanceMeasureScorecardId: integer (int64)
読取り専用:
true
関係者パフォーマンス・メジャーに関連付けられたスコア・カード・レート表の一意の識別子です。 -
ParticipantScorecardRates: array Scorecard Rates
タイトル:
Scorecard Rates
スコア・カード・レート・リソースは、個別設定できる参加者スコア・カードのレートを作成、表示および更新するために使用されます。 関連する参加者プラン・コンポーネントの個別設定オプションをはいに設定して、スコア・カードの個別設定を有効にします。 -
PerformanceMeasureId: integer (int64)
読取り専用:
true
基本報酬プランに関連付けられたパフォーマンス・メジャーの一意の識別子。 ベース・プランはプラン管理者によってモデル化され、参加者プランのソースです。 -
ScorecardDescription: string
タイトル:
Description
読取り専用:true
最大長:1000
スコア・カードの作成時にユーザーが入力したスコア・カード・レート表の摘要。 -
ScorecardId: integer (int64)
基本報酬プランに関連付けられたスコア・カード・レート表の一意の識別子です。 ベース・プランはプラン管理者によってモデル化され、参加者プランのソースです。
-
ScorecardName: string
タイトル:
Name
読取り専用:true
最大長:80
スコア・カード・レート表の名前。 -
StartDate: 文字列(日付)
読取り専用:
true
パフォーマンス・メジャーに関連付けられたスコア・カード・レート表がアクティブになる日付。
ネストされたスキーマ : スコア・カード・レート
タイプ:
array
タイトル:
Scorecard Rates
スコア・カード・レート・リソースは、個別設定できる参加者スコア・カードのレートを作成、表示および更新するために使用されます。 関連する参加者プラン・コンポーネントの個別設定オプションをはいに設定して、スコア・カードの個別設定を有効にします。
ソースを表示
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
ネストされたスキーマ : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureScorecards-ParticipantScorecardRates-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
読取り専用:
true
最大長:64
参加者レートを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
参加者レートが作成された日時。 -
LastUpdateDate: string (date-time)
読取り専用:
true
参加者レートが最後に更新された日時。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
関係者レートを最後に更新したユーザー。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ParticipantPerformanceMeasureScorecardId: integer (int64)
読取り専用:
true
関係者パフォーマンス・メジャーに関連付けられたスコア・カード・レート表の一意の識別子です。 -
ParticipantScorecardRateId: integer (int64)
読取り専用:
true
参加者スコア・カードに関連付けられたレートの一意の識別子。 -
レート: number
タイトル:
Rate
スコア・カード・レート表の出力値は、様々なパフォーマンス・レベルに対して達成レートまたは固定金額を設定するために使用されます。 レート表に設定されたレート表タイプに応じて、この値はパーセントまたは金額になります。 レート表タイプがパーセントの場合、実際の値を取得するには、ここに保存されている値を100で割る必要があります。 たとえば、レート表タイプがパーセントで、レート値が10%の場合、出力値は10です。 -
RateDimension10Id: integer
レートに関連付けられた10番目のディメンションの一意の識別子。 スコア・カード・レート表に10個のディメンションがある場合にのみ使用されます。
-
RateDimension10Name: string
タイトル:
Name
読取り専用:true
10番目のディメンションの名前。 -
RateDimension10TierId: integer
レートに関連付けられた10番目のディメンションの階層の一意の識別子。
-
RateDimension10TierSequence: integer
タイトル:
Sequence
読取り専用:true
ディメンション内の階層連番。 -
RateDimension1Id: integer
レートに関連付けられた最初のディメンションの一意の識別子。
-
RateDimension1Name: string
タイトル:
Name
読取り専用:true
最初のディメンションの名前。 -
RateDimension1TierId: integer
レートに関連付けられた最初のディメンションの階層の一意の識別子。
-
RateDimension1TierSequence: integer
タイトル:
Sequence
読取り専用:true
ディメンション内の階層連番。 -
RateDimension2Id: integer
レートに関連付けられた2番目のディメンションの一意の識別子。 スコア・カード・レート表に2つ以上のディメンションがある場合にのみ使用されます。
-
RateDimension2Name: string
タイトル:
Name
読取り専用:true
2番目のディメンションの名前。 -
RateDimension2TierId: integer
レートに関連付けられた2番目のディメンションの階層の一意の識別子。
-
RateDimension2TierSequence: integer
タイトル:
Sequence
読取り専用:true
ディメンション内の階層連番。 -
RateDimension3Id: integer
レートに関連付けられた3番目のディメンションの一意の識別子。 スコア・カード・レート表に3つ以上のディメンションがある場合にのみ使用されます。
-
RateDimension3Name: string
タイトル:
Name
読取り専用:true
3番目のディメンションの名前。 -
RateDimension3TierId: integer
レートに関連付けられた第3ディメンションの階層の一意の識別子。
-
RateDimension3TierSequence: integer
タイトル:
Sequence
読取り専用:true
ディメンション内の階層連番。 -
RateDimension4Id: integer
レートに関連付けられた4番目のディメンションの一意の識別子。 スコア・カード・レート表に4つ以上のディメンションがある場合にのみ使用されます。
-
RateDimension4Name: string
タイトル:
Name
読取り専用:true
4番目のディメンションの名前。 -
RateDimension4TierId: integer
レートに関連付けられた4番目のディメンションの階層の一意の識別子。
-
RateDimension4TierSequence: integer
タイトル:
Sequence
読取り専用:true
ディメンション内の階層連番。 -
RateDimension5Id: integer
レートに関連付けられた5番目のディメンションの一意の識別子。 スコア・カード・レート表に少なくとも5つのディメンションがある場合にのみ使用されます。
-
RateDimension5Name: string
タイトル:
Name
読取り専用:true
5番目のディメンションの名前。 -
RateDimension5TierId: integer
レートに関連付けられた5番目のディメンションの階層の一意の識別子。
-
RateDimension5TierSequence: integer
タイトル:
Sequence
読取り専用:true
ディメンション内の階層連番。 -
RateDimension6Id: integer
レートに関連付けられた6番目のディメンションの一意の識別子。 スコア・カード・レート表に少なくとも6つのディメンションがある場合にのみ使用されます。
-
RateDimension6Name: string
タイトル:
Name
読取り専用:true
6番目のディメンションの名前。 -
RateDimension6TierId: integer
レートに関連付けられた6番目のディメンションの階層の一意の識別子。
-
RateDimension6TierSequence: integer
タイトル:
Sequence
読取り専用:true
ディメンション内の階層連番。 -
RateDimension7Id: integer
レートに関連付けられた7番目のディメンションの一意の識別子。 スコア・カード・レート表に少なくとも7つのディメンションがある場合にのみ使用されます。
-
RateDimension7Name: string
タイトル:
Name
読取り専用:true
7番目のディメンションの名前。 -
RateDimension7TierId: integer
レートに関連付けられた7番目のディメンションの階層の一意の識別子。
-
RateDimension7TierSequence: integer
タイトル:
Sequence
読取り専用:true
ディメンション内の階層連番。 -
RateDimension8Id: integer
レートに関連付けられた8番目のディメンションの一意の識別子。 スコア・カード・レート表に8つ以上のディメンションがある場合にのみ使用されます。
-
RateDimension8Name: string
タイトル:
Name
読取り専用:true
第8ディメンションの名前。 -
RateDimension8TierId: integer
レートに関連付けられた8番目のディメンションの階層の一意の識別子。
-
RateDimension8TierSequence: integer
タイトル:
Sequence
読取り専用:true
ディメンション内の階層連番。 -
RateDimension9Id: integer
レートに関連付けられた9番目のディメンションの一意の識別子。 スコア・カード・レート表に少なくとも9つのディメンションがある場合にのみ使用されます。
-
RateDimension9Name: string
タイトル:
Name
読取り専用:true
9番目のディメンションの名前。 -
RateDimension9TierId: integer
レートに関連付けられた9番目のディメンションの階層の一意の識別子。
-
RateDimension9TierSequence: integer
タイトル:
Sequence
読取り専用:true
ディメンション内の階層連番。 -
ScorecardId: integer (int64)
読取り専用:
true
基本報酬プランに関連付けられたスコア・カード・レート表の一意の識別子です。 ベース・プランはプラン管理者によってモデル化され、参加者プランのソースです。 -
ScorecardRateId: integer (int64)
基本報酬プランに関連付けられたレートの一意の識別子です。 ベース・プランはプラン管理者によってモデル化され、参加者プランのソースです。
リンク
- ParticipantScorecardRates
-
パラメータ:
- ParticipantPerformanceMeasureId:
$request.path.ParticipantPerformanceMeasureId
- ParticipantPerformanceMeasureScorecardId:
$request.path.ParticipantPerformanceMeasureScorecardId
- ParticipantPlanComponentId:
$request.path.ParticipantPlanComponentId
- participantCompensationPlansUniqID:
$request.path.participantCompensationPlansUniqID
スコア・カード・レート・リソースは、個別設定できる参加者スコア・カードのレートを作成、表示および更新するために使用されます。 関連する参加者プラン・コンポーネントの個別設定オプションをはいに設定して、スコア・カードの個別設定を有効にします。 - ParticipantPerformanceMeasureId: