Get a performance measure goal
get
/fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureGoals/{ParticipantGoalId}
Request
Path Parameters
-
ParticipantGoalId(required): integer(int64)
The unique identifier of the goal associated with the participant performance measure.
-
ParticipantPerformanceMeasureId(required): integer(int64)
The unique identifier of the performance measure associated with the participant plan component.
-
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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-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 : 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-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
Links
- ParticipantGoalIntervalGoals
-
Parameters:
- ParticipantGoalId:
$request.path.ParticipantGoalId
- ParticipantPerformanceMeasureId:
$request.path.ParticipantPerformanceMeasureId
- ParticipantPlanComponentId:
$request.path.ParticipantPlanComponentId
- participantCompensationPlansUniqID:
$request.path.participantCompensationPlansUniqID
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. - ParticipantGoalId:
- ParticipantGoalPeriodGoals
-
Parameters:
- ParticipantGoalId:
$request.path.ParticipantGoalId
- ParticipantPerformanceMeasureId:
$request.path.ParticipantPerformanceMeasureId
- ParticipantPlanComponentId:
$request.path.ParticipantPlanComponentId
- participantCompensationPlansUniqID:
$request.path.participantCompensationPlansUniqID
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. - ParticipantGoalId: