Get all performance measures
get
/fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures
Request
Path Parameters
-
ParticipantPlanComponentId(required): integer(int64)
The unique identifier of the plan component associated with the participant compensation plan.
-
participantCompensationPlansUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Participant Compensation Plans resource and used to uniquely identify an instance of Participant Compensation Plans. The client should not generate the hash key value. Instead, the client should query on the Participant Compensation Plans collection resource in order to navigate to a specific instance of Participant Compensation Plans to get the hash key.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds a participant performance measure with the specified primary key.
Finder Variables:- ParticipantPerformanceMeasureId; integer; The unique identifier of the participant performance measure.
- PrimaryKey: Finds a participant performance measure with the specified primary key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- CalculationSequence; integer; Indicates the order in which the calculation engine considers a performance measure within a plan component.
- CreatedBy; string; The user who created the participant performance measure.
- CreationDate; string; The date and time when the participant performance measure is created.
- Description; string; The description of the performance measure entered while creating the performance measure.
- EarningBasis; string; Indicates whether attainment and earnings calculations use the same credit categories and whether the incentive formula uses the measure attainment in calculations.
- EndDate; string; The date when the performance measure associated with the plan component becomes inactive.
- IncludeInParticipantReportsFlag; boolean; Indicates the intent to display or exclude the measure attainment in reports. Valid values are Y and N. If No, then the intent is to exclude the measure attainment in reports. It is useful if the measure results are intermediate calculations which need not be shown in reports.
- LastUpdateDate; string; The date and time when the participant performance measure is last updated.
- LastUpdatedBy; string; The user who last updated the participant performance measure.
- MeasureFormulaExpressionDescription; string; The description of the measure formula expression entered while creating the expression.
- MeasureFormulaExpressionId; integer; The unique identifier of the measure formula expression for this performance measure. The measure formula expression is used to calculate attainment of the performance measure.
- MeasureFormulaExpressionName; string; The name of the expression used in measure formula to calculate attainment of the performance measure.
- NumberOfDimensions; integer; The number of dimensions of the scorecard used in the performance measure.
- ParticipantPerformanceMeasureId; integer; The unique identifier of the performance measure associated with the participant plan component.
- ParticipantPlanComponentId; integer; The unique identifier of the plan component associated with the participant compensation plan.
- PerformanceInterval; string; This is the interval value for the performance measurement. Where a running total is considered, the accumulated value is reset based on this interval value. Interval would represent a unit of time like month, quarter, year.
- PerformanceMeasureId; integer; The unique identifier of the performance measure associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
- PerformanceMeasureName; string; The name of the performance measure, which is an indicator used to measure the progress toward a specified outcome or goal.
- PlanComponentId; integer; The unique identifier of the plan component associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
- ProcessTransactions; string; Indicates how the application processes transactions in a measure. The possible values include GROUP, for grouping transactions for the specified interval, and INDIVIDUAL to evaluate each transaction independently. A list of acceptable values is defined in the lookup CN_PROCESS_TXN. Review the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
- RunningTotalFlag; boolean; Indicates whether to accumulate a calculation input, such as credit amount or credit quantity, over a period.
- SplitOption; string; Indicates how to split the input number to a scorecard dimension. Possible values include NONE to apply a single rate for the entire attainment, NON_PROPORTIONAL to apply multiple rates, which are fixed for an attainment within a tier, and PROPORTIONAL to apply multiple rates, which are proportional for an attainment within a tier. A list of acceptable values is defined in the lookup CN_SPLIT_TYPE_OPTION. Review the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
- StartDate; string; The date when the performance measure associated with the plan component becomes active.
- TotalTarget; number; The total target for the performance measure.
- UnitOfMeasure; string; The standardized quantity used as a factor to express occurring quantities of the performance measure property. Possible values include AMOUNT for measure attainment is based on an amount, PERCENT for measure attainment is based on a percent, QUANTITY for measure attainment is based on a quantity, and SCORE for measure attainment is based on a score. A list of acceptable values is defined in the lookup CN_MEASURE_UOM. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
- UseExternalFormulaFlag; boolean; Indicates whether the performance measure uses an external formula from an external package.
- Weight; integer; The percentage of influence a performance measure has on the plan component.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-item-response
Type:
Show Source
object
-
CalculationSequence: integer
(int32)
Read Only:
true
Indicates the order in which the calculation engine considers a performance measure within a plan component. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the participant performance measure. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the participant performance measure is created. -
Description: string
Title:
Description
Read Only:true
Maximum Length:1000
The description of the performance measure entered while creating the performance measure. -
EarningBasis: string
Title:
Earning Basis
Read Only:true
Maximum Length:1
Indicates whether attainment and earnings calculations use the same credit categories and whether the incentive formula uses the measure attainment in calculations. -
EndDate: string
(date)
Title:
End Date
Read Only:true
The date when the performance measure associated with the plan component becomes inactive. -
IncludeInParticipantReportsFlag: boolean
Title:
Include in participant reports
Read Only:true
Maximum Length:1
Indicates the intent to display or exclude the measure attainment in reports. Valid values are Y and N. If No, then the intent is to exclude the measure attainment in reports. It is useful if the measure results are intermediate calculations which need not be shown in reports. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the participant performance measure is last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the participant performance measure. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MeasureFormulaExpressionDescription: string
Title:
Expression Description
Read Only:true
Maximum Length:1000
The description of the measure formula expression entered while creating the expression. -
MeasureFormulaExpressionId: integer
(int64)
Read Only:
true
The unique identifier of the measure formula expression for this performance measure. The measure formula expression is used to calculate attainment of the performance measure. -
MeasureFormulaExpressionName: string
Title:
Expression Name
Read Only:true
Maximum Length:160
The name of the expression used in measure formula to calculate attainment of the performance measure. -
NumberOfDimensions: integer
(int64)
Title:
Number of Dimensions
Read Only:true
The number of dimensions of the scorecard used in the performance measure. -
ParticipantPerformanceMeasureGoals: array
Goals
Title:
Goals
The performance measure goals resource is used to view and update the total target of a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component. The total target defines the performance target across a timeline. -
ParticipantPerformanceMeasureId: integer
(int64)
Read Only:
true
The unique identifier of the performance measure associated with the participant plan component. -
ParticipantPerformanceMeasureScorecards: array
Scorecards
Title:
Scorecards
The performance measure scorecards resource is used to view the scorecards of a participant performance measure. A scorecard is used to establish attainment rates or fixed amounts for different performance levels. -
ParticipantPlanComponentId: integer
(int64)
Read Only:
true
The unique identifier of the plan component associated with the participant compensation plan. -
PerformanceInterval: string
Title:
Performance Interval
Read Only:true
Maximum Length:80
This is the interval value for the performance measurement. Where a running total is considered, the accumulated value is reset based on this interval value. Interval would represent a unit of time like month, quarter, year. -
PerformanceMeasureId: integer
(int64)
Title:
Name
Read Only:true
The unique identifier of the performance measure associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan. -
PerformanceMeasureName: string
Title:
Name
Read Only:true
Maximum Length:80
The name of the performance measure, which is an indicator used to measure the progress toward a specified outcome or goal. -
PlanComponentId: integer
(int64)
Read Only:
true
The unique identifier of the plan component associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan. -
ProcessTransactions: string
Title:
Process Transactions
Read Only:true
Maximum Length:30
Indicates how the application processes transactions in a measure. The possible values include GROUP, for grouping transactions for the specified interval, and INDIVIDUAL to evaluate each transaction independently. A list of acceptable values is defined in the lookup CN_PROCESS_TXN. Review the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
RenderedMeasureFormulaExpression: string
(byte)
Title:
Rendered Expression
Read Only:true
The entire measure formula expression with all the expression components like operators, attributes, functions, etc. This attribute is used to display the entire expression on the user interface. -
RunningTotalFlag: boolean
Title:
Running total
Read Only:true
Maximum Length:1
Indicates whether to accumulate a calculation input, such as credit amount or credit quantity, over a period. -
SplitOption: string
Title:
Split Option
Read Only:true
Maximum Length:30
Indicates how to split the input number to a scorecard dimension. Possible values include NONE to apply a single rate for the entire attainment, NON_PROPORTIONAL to apply multiple rates, which are fixed for an attainment within a tier, and PROPORTIONAL to apply multiple rates, which are proportional for an attainment within a tier. A list of acceptable values is defined in the lookup CN_SPLIT_TYPE_OPTION. Review the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
StartDate: string
(date)
Title:
Start Date
Read Only:true
The date when the performance measure associated with the plan component becomes active. -
TotalTarget: number
Title:
Total Target
Read Only:true
Default Value:0
The total target for the performance measure. -
UnitOfMeasure: string
Title:
Unit of Measure
Read Only:true
Maximum Length:30
The standardized quantity used as a factor to express occurring quantities of the performance measure property. Possible values include AMOUNT for measure attainment is based on an amount, PERCENT for measure attainment is based on a percent, QUANTITY for measure attainment is based on a quantity, and SCORE for measure attainment is based on a score. A list of acceptable values is defined in the lookup CN_MEASURE_UOM. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
UseExternalFormulaFlag: boolean
Title:
Use external formula
Read Only:true
Maximum Length:1
Indicates whether the performance measure uses an external formula from an external package. -
Weight: integer
(int64)
Title:
Weight
Read Only:true
The percentage of influence a performance measure has on the plan component.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Goals
Type:
array
Title:
Goals
The performance measure goals resource is used to view and update the total target of a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component. The total target defines the performance target across a timeline.
Show Source
Nested Schema : Scorecards
Type:
array
Title:
Scorecards
The performance measure scorecards resource is used to view the scorecards of a participant performance measure. A scorecard is used to establish attainment rates or fixed amounts for different performance levels.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-item-response
Type:
Show Source
object
-
AlternateTarget1: number
Title:
Alternate Target 1
Default Value:0
The alternate target number for a measure, for example, stretch goal. -
AlternateTarget2: number
Title:
Alternate Target 2
Default Value:0
The alternate target number for a measure, for example, stretch goal. -
AlternateTarget3: number
Title:
Alternate Target 3
Default Value:0
The alternate target number for a measure, for example, stretch goal. -
AlternateTarget4: number
Title:
Alternate Target 4
Default Value:0
The alternate target number for a measure, for example, stretch goal. -
AlternateTarget5: number
Title:
Alternate Target 5
Default Value:0
The alternate target number for a measure, for example, stretch goal. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the participant performance measure goal. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the participant performance measure goal is created. -
DistributeEvenlyFlag: boolean
The instruction for the application to evenly distribute the total target and alternate targets to the respective interval and period amounts for this web service request. The possible values are TRUE and FALSE.
-
GoalId: integer
(int64)
Read Only:
true
The unique identifier of the goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan. -
GoalInterval: string
Title:
Interval
Read Only:true
The performance interval that describes the span of time to be measured for the attainment of the goal amounts, such as period, quarter, or year. This interval is the same as the corresponding performance (measure) interval. -
GoalTarget: number
Title:
Total Target
Default Value:0
The expected level of attainment assigned to the participant for the measure. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the participant performance measure goal is last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the participant performance measure goal. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParticipantGoalId: integer
(int64)
Read Only:
true
The unique identifier of the goal associated with the participant performance measure. -
ParticipantGoalIntervalGoals: array
Interval Goals
Title:
Interval Goals
The performance measure interval goals service is used to view the interval target amounts for a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component. -
ParticipantGoalPeriodGoals: array
Period Goals
Title:
Period Goals
The performance measure period goals service is used to view and update the period target amounts for a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component. -
ParticipantPerformanceMeasureId: integer
(int64)
Read Only:
true
The unique identifier of the participant performance measure. -
PerformanceMeasureId: integer
(int64)
Read Only:
true
The unique identifier of the performance measure associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan. -
PerformanceMeasureName: string
Title:
Name
Read Only:true
The name of the performance measure.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Interval Goals
Type:
array
Title:
Interval Goals
The performance measure interval goals service is used to view the interval target amounts for a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component.
Show Source
Nested Schema : Period Goals
Type:
array
Title:
Period Goals
The performance measure period goals service is used to view and update the period target amounts for a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component.
Show Source
Nested Schema : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-ParticipantGoalIntervalGoals-item-response
Type:
Show Source
object
-
AlternateIntervalTarget1: number
Title:
Alternate Interval Target 1
Read Only:true
Default Value:0
The alternate interval target for a measure, for example, stretch goal for an interval. -
AlternateIntervalTarget2: number
Title:
Alternate Interval Target 2
Read Only:true
Default Value:0
The alternate interval target for a measure, for example, stretch goal for an interval. -
AlternateIntervalTarget3: number
Title:
Alternate Interval Target 3
Read Only:true
Default Value:0
The alternate interval target for a measure, for example, stretch goal for an interval. -
AlternateIntervalTarget4: number
Title:
Alternate Interval Target 4
Read Only:true
Default Value:0
The alternate interval target for a measure, for example, stretch goal for an interval. -
AlternateIntervalTarget5: number
Title:
Alternate Interval Target 5
Read Only:true
Default Value:0
The alternate interval target for a measure, for example, stretch goal for an interval. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the interval goal. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the interval goal is created. -
GoalId: integer
(int64)
Read Only:
true
The unique identifier of the goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan. -
IntervalGoalId: integer
(int64)
Title:
Period
Read Only:true
The unique identifier of the interval goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan. -
IntervalNumber: number
Title:
Period
Read Only:true
The display number for the interval. -
IntervalTarget: number
Title:
Interval Target
Read Only:true
Default Value:0
The target number specified for the goal interval. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the interval is last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the interval goal. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParticipantGoalId: integer
(int64)
Read Only:
true
The unique identifier of the goal. -
ParticipantIntervalGoalId: integer
(int64)
Read Only:
true
The unique identifier of the participant interval goal details.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-ParticipantGoalPeriodGoals-item-response
Type:
Show Source
object
-
AlternateITDTarget1: number
Title:
Alternate ITD Target 1
Read Only:true
Default Value:0
The alternate interval-to-date target number for a measure. -
AlternateITDTarget2: number
Title:
Alternate ITD Target 2
Read Only:true
Default Value:0
The alternate interval-to-date target number for a measure. -
AlternateITDTarget3: number
Title:
Alternate ITD Target 3
Read Only:true
Default Value:0
The alternate interval-to-date target number for a measure. -
AlternateITDTarget4: number
Title:
Alternate ITD Target 4
Read Only:true
Default Value:0
The alternate interval-to-date target number for a measure. -
AlternateITDTarget5: number
Title:
Alternate ITD Target 5
Read Only:true
Default Value:0
The alternate interval-to-date target number for a measure. -
AlternatePeriodTarget1: number
Title:
Alternate Period Target 1
Default Value:0
The alternate period target number for a measure, for example, stretch goal for a period. -
AlternatePeriodTarget2: number
Title:
Alternate Period Target 2
Default Value:0
The alternate period target number for a measure, for example, stretch goal for a period. -
AlternatePeriodTarget3: number
Title:
Alternate Period Target 3
Default Value:0
The alternate period target number for a measure, for example, stretch goal for a period. -
AlternatePeriodTarget4: number
Title:
Alternate Period Target 4
Default Value:0
The alternate period target number for a measure, for example, stretch goal for a period. -
AlternatePeriodTarget5: number
Title:
Alternate Period Target 5
Default Value:0
The alternate period target number for a measure, for example, stretch goal for a period. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the period goal. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the period goal is created. -
GoalId: integer
(int64)
Read Only:
true
The unique identifier of the goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan. -
IntervalGoalId: integer
(int64)
Read Only:
true
The unique identifier of the interval goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan. -
ITDTarget: number
Title:
ITD Target
Read Only:true
Default Value:0
The interval-to-date target number for a measure. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the period goal is last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the period goal. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParticipantGoalId: integer
(int64)
Read Only:
true
The unique identifier of the goal. -
ParticipantIntervalGoalId: integer
(int64)
Read Only:
true
The unique identifier of the participant interval goal details. -
ParticipantPeriodGoalId: integer
(int64)
Read Only:
true
The unique identifier of the period goal. -
PeriodEndDate: string
(date)
Title:
End Date
Read Only:true
The date when the period of time ends. -
PeriodGoalId: integer
(int64)
Read Only:
true
The unique identifier of the period goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan. -
PeriodId: integer
(int64)
Title:
Period
Read Only:true
The unique identifier for the period of time defined in the calendar. -
PeriodName: string
Title:
Period
Read Only:true
Maximum Length:30
The name for a period of time defined in the calendar. -
PeriodStartDate: string
(date)
Title:
Start Date
Read Only:true
The date when the period of time begins. -
PeriodTarget: number
Title:
Period Target
Default Value:0
The period target number for a measure.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureScorecards-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the participant scorecard rate table. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the participant scorecard rate table is created. -
EndDate: string
(date)
Read Only:
true
The date when the scorecard rate table associated with the performance measure becomes inactive. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the participant scorecard rate table is last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the participant scorecard rate table. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParticipantPerformanceMeasureId: integer
(int64)
Read Only:
true
The unique identifier of the performance measure associated with the participant plan component. -
ParticipantPerformanceMeasureScorecardId: integer
(int64)
Read Only:
true
The unique identifier of the scorecard rate table associated with the participant performance measure. -
ParticipantScorecardRates: array
Scorecard Rates
Title:
Scorecard Rates
The scorecard rates resource is used to create, view, and update the rates for a participant scorecard that can be individualized. You enable individualization for a scorecard by setting the Individualize option to Yes for the related participant plan component. -
PerformanceMeasureId: integer
(int64)
Read Only:
true
The unique identifier of the performance measure associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan. -
ScorecardDescription: string
Title:
Description
Read Only:true
Maximum Length:1000
The description of the scorecard rate table entered by the user while creating the scorecard. -
ScorecardId: integer
(int64)
The unique identifier of the scorecard rate table associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
-
ScorecardName: string
Title:
Name
Read Only:true
Maximum Length:80
The name of the scorecard rate table. -
StartDate: string
(date)
Read Only:
true
The date when the scorecard rate table associated with the performance measure becomes active.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Scorecard Rates
Type:
array
Title:
Scorecard Rates
The scorecard rates resource is used to create, view, and update the rates for a participant scorecard that can be individualized. You enable individualization for a scorecard by setting the Individualize option to Yes for the related participant plan component.
Show Source
Nested Schema : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureScorecards-ParticipantScorecardRates-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the participant rate. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the participant rate is created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the participant rate is last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the participant rate. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParticipantPerformanceMeasureScorecardId: integer
(int64)
Read Only:
true
The unique identifier of the scorecard rate table associated with the participant performance measure. -
ParticipantScorecardRateId: integer
(int64)
Read Only:
true
The unique identifier of the rate associated with the participant scorecard. -
Rate: number
Title:
Rate
The output value of the scorecard rate table is used to establish attainment rates or fixed amounts for different performance levels. This value is a percent or an amount depending on the rate table type set for the rate table. If the rate table type is percent, then the value stored here needs to be divided by 100 to get the actual value. For example, if the rate table type is percent and the rate value is 10%, then 10 is the output value. -
RateDimension10Id: integer
The unique identifier of the tenth dimension associated with the rate. Used only when the scorecard rate table has ten dimensions.
-
RateDimension10Name: string
Title:
Name
Read Only:true
The name of the tenth dimension. -
RateDimension10TierId: integer
The unique identifier of the tier for the tenth dimension associated with the rate.
-
RateDimension10TierSequence: integer
Title:
Sequence
Read Only:true
The tier sequence number within the dimension. -
RateDimension1Id: integer
The unique identifier of the first dimension associated with the rate.
-
RateDimension1Name: string
Title:
Name
Read Only:true
The name of the first dimension. -
RateDimension1TierId: integer
The unique identifier of the tier for the first dimension associated with the rate.
-
RateDimension1TierSequence: integer
Title:
Sequence
Read Only:true
The tier sequence number within the dimension. -
RateDimension2Id: integer
The unique identifier of the second dimension associated with the rate. Used only when the scorecard rate table has at least two dimensions.
-
RateDimension2Name: string
Title:
Name
Read Only:true
The name of the second dimension. -
RateDimension2TierId: integer
The unique identifier of the tier for the second dimension associated with the rate.
-
RateDimension2TierSequence: integer
Title:
Sequence
Read Only:true
The tier sequence number within the dimension. -
RateDimension3Id: integer
The unique identifier of the third dimension associated with the rate. Used only when the scorecard rate table has at least three dimensions.
-
RateDimension3Name: string
Title:
Name
Read Only:true
The name of the third dimension. -
RateDimension3TierId: integer
The unique identifier of the tier for the third dimension associated with the rate.
-
RateDimension3TierSequence: integer
Title:
Sequence
Read Only:true
The tier sequence number within the dimension. -
RateDimension4Id: integer
The unique identifier of the fourth dimension associated with the rate. Used only when the scorecard rate table has at least four dimensions.
-
RateDimension4Name: string
Title:
Name
Read Only:true
The name of the fourth dimension. -
RateDimension4TierId: integer
The unique identifier of the tier for the fourth dimension associated with the rate.
-
RateDimension4TierSequence: integer
Title:
Sequence
Read Only:true
The tier sequence number within the dimension. -
RateDimension5Id: integer
The unique identifier of the fifth dimension associated with the rate. Used only when the scorecard rate table has at least five dimensions.
-
RateDimension5Name: string
Title:
Name
Read Only:true
The name of the fifth dimension. -
RateDimension5TierId: integer
The unique identifier of the tier for the fifth dimension associated with the rate.
-
RateDimension5TierSequence: integer
Title:
Sequence
Read Only:true
The tier sequence number within the dimension. -
RateDimension6Id: integer
The unique identifier of the sixth dimension associated with the rate. Used only when the scorecard rate table has at least six dimensions.
-
RateDimension6Name: string
Title:
Name
Read Only:true
The name of the sixth dimension. -
RateDimension6TierId: integer
The unique identifier of the tier for the sixth dimension associated with the rate.
-
RateDimension6TierSequence: integer
Title:
Sequence
Read Only:true
The tier sequence number within the dimension. -
RateDimension7Id: integer
The unique identifier of the seventh dimension associated with the rate. Used only when the scorecard rate table has at least seven dimensions.
-
RateDimension7Name: string
Title:
Name
Read Only:true
The name of the seventh dimension. -
RateDimension7TierId: integer
The unique identifier of the tier for the seventh dimension associated with the rate.
-
RateDimension7TierSequence: integer
Title:
Sequence
Read Only:true
The tier sequence number within the dimension. -
RateDimension8Id: integer
The unique identifier of the eighth dimension associated with the rate. Used only when the scorecard rate table has at least eight dimensions.
-
RateDimension8Name: string
Title:
Name
Read Only:true
The name of the eighth dimension. -
RateDimension8TierId: integer
The unique identifier of the tier for the eighth dimension associated with the rate.
-
RateDimension8TierSequence: integer
Title:
Sequence
Read Only:true
The tier sequence number within the dimension. -
RateDimension9Id: integer
The unique identifier of the ninth dimension associated with the rate. Used only when the scorecard rate table has at least nine dimensions.
-
RateDimension9Name: string
Title:
Name
Read Only:true
The name of the ninth dimension. -
RateDimension9TierId: integer
The unique identifier of the tier for the ninth dimension associated with the rate.
-
RateDimension9TierSequence: integer
Title:
Sequence
Read Only:true
The tier sequence number within the dimension. -
ScorecardId: integer
(int64)
Read Only:
true
The unique identifier of the scorecard rate table associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan. -
ScorecardRateId: integer
(int64)
The unique identifier of the rate associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source