Update a goal
patch
/fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureGoals/{GoalId}
Request
Path Parameters
-
GoalId(required): integer(int64)
The unique identifier for a goal record.
-
PerformanceMeasureId(required): integer(int64)
The unique identifier for the performance measure.
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
-
DistributeEvenlyFlag: boolean
Indicates if the target amount evenly to the interval targets and period targets, the possible values are TRUE and FALSE.
-
GoalDistributionType: string
Title:
Distribute By
The goal target or alternate goal targets are distributed by amount or percent. Although only distribute by Amount is allowed for now, it has two possible values which are AMOUNT to distribute the goal in numbers for each interval and period, and PERCENT to distribute the goal as a percentage of the annual number for each interval and period. A list of acceptable values is defined in the lookup CN_GOAL_DISTRIBUTE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
GoalTarget: number
Title:
Target
The expected level of attainment assigned to a participant for each measure for the year, which may be divided into different intervals. -
performanceMeasureIntervalGoals: array
Interval Goals
Title:
Interval Goals
The Interval Goals resource is used to view and update the target or the goal values at each interval. It can also be used to display all details of the goals across intervals. This is created when creating a Performance Measure with a default value of 0. -
RecalculateFlag: boolean
Indicates if all period values to the respective interval and interval to date (ITD) are summed up and if all interval values to the respective total target goal values are summed up. This replaces any interval, ITD and total target goal values. Also this cannot be TRUE if the goal distribution type value is Percentage. This also applies to all alternate goals.
-
UnitOfMeasure: string
Title:
Unit of Measure
Maximum Length:30
Default Value:AMOUNT
The standardized quantity used as a factor to express occurring quantities of the goal property. Possible values include AMOUNT for Revenue-based goal and QUANTITY for Quantity-based goal. The default value is AMOUNT. A list of acceptable values is defined in the lookup CN_GOAL_UOM. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
Nested Schema : Interval Goals
Type:
array
Title:
Interval Goals
The Interval Goals resource is used to view and update the target or the goal values at each interval. It can also be used to display all details of the goals across intervals.
This is created when creating a Performance Measure with a default value of 0.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AlternateIntervalTarget1: number
Title:
Alternate Interval Target 1
Default Value:0
The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0. -
AlternateIntervalTarget1Percent: number
Title:
Alternate Interval Target 1
The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target. -
AlternateIntervalTarget2: number
Title:
Alternate Interval Target 2
Default Value:0
The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0. -
AlternateIntervalTarget2Percent: number
Title:
Alternate Interval Target 2
The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target. -
AlternateIntervalTarget3: number
Title:
Alternate Interval Target 3
Default Value:0
The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0. -
AlternateIntervalTarget3Percent: number
Title:
Alternate Interval Target 3
The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target. -
AlternateIntervalTarget4: number
Title:
Alternate Interval Target 4
Default Value:0
The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0. -
AlternateIntervalTarget4Percent: number
Title:
Alternate Interval Target 4
The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target. -
AlternateIntervalTarget5: number
Title:
Alternate Interval Target 5
Default Value:0
The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0. -
AlternateIntervalTarget5Percent: number
Title:
Alternate Interval Target 5
The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target. -
GoalId: integer
(int64)
The unique identifier for a goal record.
-
IntervalNumber: string
Title:
Period
Maximum Length:80
The display value of the interval. -
performanceMeasurePeriodGoals: array
Period Goals
Title:
Period Goals
The Period Goals resource is used to view and update the target or the goal values at each period. It can also be used to display all details of the goals across periods. This is created when creating a Performance Measure with a default value of 0. This needs to be updated later if needed.
Nested Schema : Period Goals
Type:
array
Title:
Period Goals
The Period Goals resource is used to view and update the target or the goal values at each period. It can also be used to display all details of the goals across periods.
This is created when creating a Performance Measure with a default value of 0. This needs to be updated later if needed.
Show Source
Nested Schema : incentiveCompensationPerformanceMeasures-performanceMeasureGoals-performanceMeasureIntervalGoals-performanceMeasurePeriodGoals-item-patch-request
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. The default value is 0. -
AlternatePeriodTarget1Percent: number
Title:
Alternate Period Target 1
The alternate period target percentage 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. The default value is 0. -
AlternatePeriodTarget2Percent: number
Title:
Alternate Period Target 2
The alternate period target percentage 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. The default value is 0. -
AlternatePeriodTarget3Percent: number
Title:
Alternate Period Target 3
The alternate period target percentage 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. The default value is 0. -
AlternatePeriodTarget4Percent: number
Title:
Alternate Period Target 4
The alternate period target percentage 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. The default value is 0. -
AlternatePeriodTarget5Percent: number
Title:
Alternate Period Target 5
The alternate period target percentage for a measure, for example, stretch goal for a period. -
GoalId: integer
(int64)
The unique identifier for a goal.
-
IntervalGoalId: integer
(int64)
The unique identifier for the interval goal details.
-
PeriodTarget: number
Title:
Period Target
Default Value:0
The period target number for a measure. -
PeriodTargetPercent: number
Title:
Period Target
The period target percentage 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 : incentiveCompensationPerformanceMeasures-performanceMeasureGoals-item-response
Type:
Show Source
object
-
AlternateGoalTarget1: number
Title:
Alternate Target 1
Read Only:true
The alternate target number for a measure, for example, stretch goal. -
AlternateGoalTarget2: number
Title:
Alternate Target 2
Read Only:true
The alternate target number for a measure, for example, stretch goal. -
AlternateGoalTarget3: number
Title:
Alternate Target 3
Read Only:true
The alternate target number for a measure, for example, stretch goal. -
AlternateGoalTarget4: number
Title:
Alternate Target 4
Read Only:true
The alternate target number for a measure, for example, stretch goal. -
AlternateGoalTarget5: number
Title:
Alternate Target 5
Read Only:true
The alternate target number for a measure, for example, stretch goal. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
DistributeEvenlyFlag: boolean
Indicates if the target amount evenly to the interval targets and period targets, the possible values are TRUE and FALSE.
-
GoalDistributionType: string
Title:
Distribute By
The goal target or alternate goal targets are distributed by amount or percent. Although only distribute by Amount is allowed for now, it has two possible values which are AMOUNT to distribute the goal in numbers for each interval and period, and PERCENT to distribute the goal as a percentage of the annual number for each interval and period. A list of acceptable values is defined in the lookup CN_GOAL_DISTRIBUTE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
GoalId: integer
(int64)
The unique identifier for a goal record.
-
GoalInterval: string
Title:
Goal Interval
Read Only:true
The span of time to specify the goal information. This interval is same as the corresponding performance (measure) interval. To get this value, describe the resource and use the finder listed to get all possible values. -
GoalTarget: number
Title:
Target
The expected level of attainment assigned to a participant for each measure for the year, which may be divided into different intervals. -
IntervalDistribution: string
Read Only:
true
The display value for the goal number distributed across the intervals. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PerformanceMeasureGoalDeleteFlag: boolean
Read Only:
true
Default Value:false
Indicates whether a goal can be deleted. -
performanceMeasureIntervalGoals: array
Interval Goals
Title:
Interval Goals
The Interval Goals resource is used to view and update the target or the goal values at each interval. It can also be used to display all details of the goals across intervals. This is created when creating a Performance Measure with a default value of 0. -
RecalculateFlag: boolean
Indicates if all period values to the respective interval and interval to date (ITD) are summed up and if all interval values to the respective total target goal values are summed up. This replaces any interval, ITD and total target goal values. Also this cannot be TRUE if the goal distribution type value is Percentage. This also applies to all alternate goals.
-
UnitOfMeasure: string
Title:
Unit of Measure
Maximum Length:30
Default Value:AMOUNT
The standardized quantity used as a factor to express occurring quantities of the goal property. Possible values include AMOUNT for Revenue-based goal and QUANTITY for Quantity-based goal. The default value is AMOUNT. A list of acceptable values is defined in the lookup CN_GOAL_UOM. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
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 Interval Goals resource is used to view and update the target or the goal values at each interval. It can also be used to display all details of the goals across intervals.
This is created when creating a Performance Measure with a default value of 0.
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 : incentiveCompensationPerformanceMeasures-performanceMeasureGoals-performanceMeasureIntervalGoals-item-response
Type:
Show Source
object
-
AlternateIntervalTarget1: number
Title:
Alternate Interval Target 1
Default Value:0
The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0. -
AlternateIntervalTarget1Percent: number
Title:
Alternate Interval Target 1
The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target. -
AlternateIntervalTarget2: number
Title:
Alternate Interval Target 2
Default Value:0
The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0. -
AlternateIntervalTarget2Percent: number
Title:
Alternate Interval Target 2
The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target. -
AlternateIntervalTarget3: number
Title:
Alternate Interval Target 3
Default Value:0
The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0. -
AlternateIntervalTarget3Percent: number
Title:
Alternate Interval Target 3
The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target. -
AlternateIntervalTarget4: number
Title:
Alternate Interval Target 4
Default Value:0
The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0. -
AlternateIntervalTarget4Percent: number
Title:
Alternate Interval Target 4
The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target. -
AlternateIntervalTarget5: number
Title:
Alternate Interval Target 5
Default Value:0
The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0. -
AlternateIntervalTarget5Percent: number
Title:
Alternate Interval Target 5
The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
GoalId: integer
(int64)
The unique identifier for a goal record.
-
IntervalGoalId: integer
(int64)
The unique identifier for the interval goal details.
-
IntervalNumber: string
Title:
Period
Maximum Length:80
The display value of the interval. -
IntervalTarget: number
Title:
Interval Target
Read Only:true
Default Value:0
The target number specified for the goal interval. The default value is 0. -
IntervalTargetPercent: number
Title:
Interval Target
Read Only:true
The target percentage specified for the goal interval. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PerformanceMeasureIntervalGoalDeleteFlag: boolean
Read Only:
true
Default Value:false
Indicates whether a performance measure interval goal can be deleted. -
performanceMeasurePeriodGoals: array
Period Goals
Title:
Period Goals
The Period Goals resource is used to view and update the target or the goal values at each period. It can also be used to display all details of the goals across periods. This is created when creating a Performance Measure with a default value of 0. This needs to be updated later if needed.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Period Goals
Type:
array
Title:
Period Goals
The Period Goals resource is used to view and update the target or the goal values at each period. It can also be used to display all details of the goals across periods.
This is created when creating a Performance Measure with a default value of 0. This needs to be updated later if needed.
Show Source
Nested Schema : incentiveCompensationPerformanceMeasures-performanceMeasureGoals-performanceMeasureIntervalGoals-performanceMeasurePeriodGoals-item-response
Type:
Show Source
object
-
AlternateITDTarget1: number
Title:
Alternate ITD Target 1
Read Only:true
The alternate interval-to-date target number for a measure. -
AlternateITDTarget2: number
Title:
Alternate ITD Target 2
Read Only:true
The alternate interval-to-date target number for a measure. -
AlternateITDTarget3: number
Title:
Alternate ITD Target 3
Read Only:true
The alternate interval-to-date target number for a measure. -
AlternateITDTarget4: number
Title:
Alternate ITD Target 4
Read Only:true
The alternate interval-to-date target number for a measure. -
AlternateITDTarget5: number
Title:
Alternate ITD Target 5
Read Only:true
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. The default value is 0. -
AlternatePeriodTarget1Percent: number
Title:
Alternate Period Target 1
The alternate period target percentage 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. The default value is 0. -
AlternatePeriodTarget2Percent: number
Title:
Alternate Period Target 2
The alternate period target percentage 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. The default value is 0. -
AlternatePeriodTarget3Percent: number
Title:
Alternate Period Target 3
The alternate period target percentage 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. The default value is 0. -
AlternatePeriodTarget4Percent: number
Title:
Alternate Period Target 4
The alternate period target percentage 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. The default value is 0. -
AlternatePeriodTarget5Percent: number
Title:
Alternate Period Target 5
The alternate period target percentage for a measure, for example, stretch goal for a period. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
GoalId: integer
(int64)
The unique identifier for a goal.
-
IntervalGoalId: integer
(int64)
The unique identifier for the interval goal details.
-
ITDTarget: number
Title:
ITD Target
Read Only:true
The Interval-to-date target number for a measure. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PerformanceMeasurePeriodGoalDeleteFlag: boolean
Read Only:
true
Default Value:false
Inidcates whether a performance measure period goal can be deleted. -
PeriodGoalId: integer
(int64)
The unique identifier for the period goal details.
-
PeriodName: string
Title:
Period
Read Only:true
Maximum Length:30
The name for an interval of time defined in the calendar. -
PeriodTarget: number
Title:
Period Target
Default Value:0
The period target number for a measure. -
PeriodTargetPercent: number
Title:
Period Target
The period target percentage for a measure.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- CnLookupGoalDistributeVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_GOAL_DISTRIBUTE
The list of values indicating the distribution of the goal target or alternate goal targets by amount or percent. Possible values include AMOUNT to distribute the goal in numbers for each interval and period, and PERCENT to distribute the goal as a percentage of the annual number for each interval and period.
The following properties are defined on the LOV link relation:- Source Attribute: GoalDistributionType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CnLookupUnitOfMeasure
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_GOAL_UOM
The list of values containing the standardized quantities used as a factor to express occurring quantities of the goal property. Possible values include AMOUNT for Revenue-based goals, and QUANTITY for Quantity-based goals. The default value is AMOUNT.
The following properties are defined on the LOV link relation:- Source Attribute: UnitOfMeasure; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- performanceMeasureIntervalGoals
-
Parameters:
- GoalId:
$request.path.GoalId
- PerformanceMeasureId:
$request.path.PerformanceMeasureId
The Interval Goals resource is used to view and update the target or the goal values at each interval. It can also be used to display all details of the goals across intervals. This is created when creating a Performance Measure with a default value of 0. - GoalId: