Update a period goal
patch
/fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureGoals/{ParticipantGoalId}/child/ParticipantGoalPeriodGoals/{ParticipantPeriodGoalId}
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.
-
ParticipantPeriodGoalId(required): integer(int64)
The unique identifier of the period goal.
-
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.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
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. -
PeriodTarget: number
Title:
Period Target
Default Value:0
The period target number for a measure.
Response
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-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 : 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.