Get a performance measure
get
/fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}
Request
Path Parameters
-
PerformanceMeasureId(required): integer(int64)
The unique identifier for the performance measure.
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 : incentiveCompensationPerformanceMeasures-item-response
Type:
Show Source
object
-
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. -
Description: string
Title:
Description
Maximum Length:1000
The description of the performance measure entered while creating the performance measure. -
DisplayName: string
Title:
Display Name
Maximum Length:80
The name of the performance measure displayed on the user interface to represent the performance measure. -
EndDate: string
(date)
Title:
End Date
The date when the performance measure becomes inactive. The format is yyyy-mm-dd. -
ExternalFormulaName: string
Title:
Formula Name
Maximum Length:30
The name of the external formula. This should be passed only if the UseExternalFormulaFlag is true. -
IncludeInParticipantReportsFlag: boolean
Title:
Include in participant reports
Maximum Length:1
Default Value:true
Indicates whether to display the measure attainment in all views and reports. It is useful if the measure results are intermediate calculations which need not be shown in reports. Possible values include FALSE and TRUE. -
InvalidReason: string
Title:
Reason
Read Only:true
The reason explaining why the performance measure is invalid. -
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. -
MeasureFormulaExpressionDescription: string
Title:
Output Expression Description
Read Only:true
Maximum Length:1000
The description of the measure formula expression entered while creating the expression. -
MeasureFormulaExpressionId: integer
(int64)
Title:
Output Expression ID
The unique identifier for 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
Maximum Length:160
The name of the expression used in measure formula to calculate attainment of the performance measure. -
Name: string
Title:
Performance Measure Name
Maximum Length:80
The name of the performance measure. -
NumberOfDimensions: integer
(int64)
Title:
Number of Dimensions
The number of dimensions of the scorecard used in the performance measure. -
OrgId: integer
(int64)
Title:
Business Unit
The unique identifier of the business unit. -
PerformanceInterval: string
Title:
Performance Interval
Default Value:-1000
The interval value that the performance is measured for. Also for running total, the accumulated value is reset based on this interval value. Interval would represent a unit of time like month, quarter, year. The default value is '-1000'. To get this value, describe the resource and use the finder listed to get all possible values. -
performanceMeasureCreditCategories: array
Credit Categories
Title:
Credit Categories
The credit categories resource is used to view, create, and delete the association of a credit category with a performance measure. It can also be used to display all the details of the credit categories under a performance measure. A credit category is used to define which transaction is eligible for crediting by the Incentive Compensation system. A performance measure credit category record links the credit category to a performance measure and provides additional details at this level. A credit category needs to exist before creating this record. -
performanceMeasureDFF: array
Descriptive Flex fields
Title:
Descriptive Flex fields
The Descriptive Flex Field resource is used to create, view, and update user defined values for the performance measure. A new API Name can be defined by going to Setup and Maintenance and opening the Manage Descriptive Flex Fields task. -
performanceMeasureGoals: array
Goals
Title:
Goals
The goals resource is used to view and update a goal. It can also be used to display all the details of a goal. A goal under a performance measure defines the target applicable to a participant and could be assigned across a timeline. This is created when creating a Performance Measure with a default value of 0. This needs to be updated later if needed. -
PerformanceMeasureId: integer
(int64)
The unique identifier for the performance measure.
-
performanceMeasureRateDimensionalInputs: array
Rate Dimensional Input Expressions
Title:
Rate Dimensional Input Expressions
The Rate Dimensional Input Expressions resource is used to view and update the association of an input expression with a performance measure. It can also be used to display all the details of the input expressions under a performance measure. This record specifies the inputs of a rate dimension of a scorecard and provides additional details at this level. A valid expression which also has a valid usage needs to exist before creating this record. This should be assigned only after the scorecard has been assigned. -
performanceMeasureScorecards: array
Scorecards
Title:
Scorecards
The scorecards resource is used to view, create, update, and delete the association of a scorecard with a performance measure. It can also be used to display all the details of a scorecard associated with a performance measure. This resource links the scorecard to a performance measure and provides additional details at this level. A scorecard needs to exist before creating this record. -
ProcessTransactions: string
Title:
Process Transactions
Maximum Length:30
Indicates how the application processes transactions in a measure. The possible values include GROUP for group transactions for the specified interval, for attainment calculation (when selecting GROUP, pass Accumulation Flag as Y), and INDIVIDUAL to evaluate each transaction independently, for attainment calculation. So each transaction is considered independently. This cannot be updated once performance measure has been created. A list of acceptable values is defined in the lookup CN_PROCESS_TXN. Review and update 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
Maximum Length:1
Default Value:false
Indicates whether to accumulate a calculation input, such as credit amount or credit quantity, over a period. The default value is N so you need to explicitly pass Y if processing transaction is set as GROUP. Possible values include FALSE and TRUE. The default value is FALSE. This attribute is not applicable if ProcessTransactions is GROUP. -
SplitOption: string
Title:
Split Option
Maximum Length:30
Default Value:NONE
Specifies 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. The default value is NONE. A list of acceptable values is defined in the lookup CN_SPLIT_TYPE_OPTION. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
StartDate: string
(date)
Title:
Start Date
The date when the performance measure becomes active. The format is yyyy-mm-dd. -
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 performance measure property. Possible values include AMOUNT to measure attainment based on an amount, PERCENT to measure attainment is based on a percent, QUANTITY to measure attainment is based on a quantity, and SCORE to measure attainment is based on a score. The default value is AMOUNT. 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
Maximum Length:1
Default Value:false
IIndicates whether the performance measure uses an external formula from an external package. Possible values include FALSE and TRUE. The default value is FALSE. A list of acceptable values is defined in the lookup CN_YES_NO. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
ValidForCalculation: string
Title:
Valid for Calculation
Read Only:true
Maximum Length:30
Default Value:INCOMPLETE
Indicates whether a performance measure is ready for calculation. Possible values include COMPLETE for valid and ready for calculation, INCOMPLETE for invalid and not ready for calculation. The default value is INCOMPLETE. A list of acceptable values is defined in the lookup CN_FORMULA_STATUS. 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 : Credit Categories
Type:
array
Title:
Credit Categories
The credit categories resource is used to view, create, and delete the association of a credit category with a performance measure. It can also be used to display all the details of the credit categories under a performance measure. A credit category is used to define which transaction is eligible for crediting by the Incentive Compensation system. A performance measure credit category record links the credit category to a performance measure and provides additional details at this level.
A credit category needs to exist before creating this record.
Show Source
Nested Schema : Descriptive Flex fields
Type:
array
Title:
Descriptive Flex fields
The Descriptive Flex Field resource is used to create, view, and update user defined values for the performance measure.
A new API Name can be defined by going to Setup and Maintenance and opening the Manage Descriptive Flex Fields task.
Show Source
Nested Schema : Goals
Type:
array
Title:
Goals
The goals resource is used to view and update a goal. It can also be used to display all the details of a goal. A goal under a performance measure defines the target applicable to a participant and could be assigned across a timeline.
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 : Rate Dimensional Input Expressions
Type:
array
Title:
Rate Dimensional Input Expressions
The Rate Dimensional Input Expressions resource is used to view and update the association of an input expression with a performance measure. It can also be used to display all the details of the input expressions under a performance measure. This record specifies the inputs of a rate dimension of a scorecard and provides additional details at this level.
A valid expression which also has a valid usage needs to exist before creating this record. This should be assigned only after the scorecard has been assigned.
Show Source
Nested Schema : Scorecards
Type:
array
Title:
Scorecards
The scorecards resource is used to view, create, update, and delete the association of a scorecard with a performance measure. It can also be used to display all the details of a scorecard associated with a performance measure. This resource links the scorecard to a performance measure and provides additional details at this level.
A scorecard needs to exist before creating this record.
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-performanceMeasureCreditCategories-item-response
Type:
Show Source
object
-
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. -
CreditCategoryId: integer
(int64)
Title:
Credit Category ID
The unique identifier of the credit category. -
CreditCategoryName: string
Title:
Credit Category Name
Maximum Length:160
The name of the credit category. -
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. -
PerformanceMeasureCreditCategoriesUpdateFlag: boolean
Read Only:
true
Default Value:false
Indicates whether a credit category can be updated. -
PerformanceMeasureCreditCategoryId: integer
(int64)
The unique identifier representing the credit category for the performance measure.
-
performanceMeasureCreditFactors: array
Credit Factors
Title:
Credit Factors
The credit factors resource is used to view, create, update, and delete the credit factor or earning factor within a credit category associated to a performance measure. The credit factor is used to apply an uplift to the sales credits at the credit category level for a period of time. The earning factor is used to apply an uplift to the sales earning at the credit category level for a period of time. -
PerformanceMeasureId: integer
(int64)
Title:
Performance Measure ID
The unique identifier of a performance measure. -
PerformanceMeasureName: string
Title:
Performance Measure 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. -
performanceMeasureTransactionFactors: array
Transaction Factors
Title:
Transaction Factors
The transaction factors resource is used to view, create, update, and delete the transaction factor associated with a performance measure credit category. A transaction factor is used to decide the influence of the sales stage (Invoicing, PO stage, etc.) on the sales credit.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Credit Factors
Type:
array
Title:
Credit Factors
The credit factors resource is used to view, create, update, and delete the credit factor or earning factor within a credit category associated to a performance measure.
The credit factor is used to apply an uplift to the sales credits at the credit category level for a period of time.
The earning factor is used to apply an uplift to the sales earning at the credit category level for a period of time.
Show Source
Nested Schema : Transaction Factors
Type:
array
Title:
Transaction Factors
The transaction factors resource is used to view, create, update, and delete the transaction factor associated with a performance measure credit category. A transaction factor is used to decide the influence of the sales stage (Invoicing, PO stage, etc.) on the sales credit.
Show Source
Nested Schema : incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories-performanceMeasureCreditFactors-item-response
Type:
Show Source
object
-
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. -
CreditFactor: number
Title:
Credit Factor
Default Value:100
The percentage of uplift applied to transaction credits that is specified at the credit category level, for a period of time. Helps to boost the attainment for a period of time, for certain credit categories. The default value is 100. -
EarningFactor: number
Title:
Earning Factor
Default Value:100
The percentage of uplift applied to earnings that is specified at the credit category level, for a period of time. Helps to boost the earnings for a period of time, for certain credit categories. Default value is 100. -
EndDate: string
(date)
Title:
End Date
The date when the credit factor and earning factor provided for a credit category within a performance measure become inactive. The format is yyyy-mm-dd. -
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. -
PerformanceMeasureCreditCategoryId: integer
(int64)
The unique identifier of the credit category for the performance measure.
-
PerformanceMeasureCreditFactorId: integer
(int64)
The unique identifier of the credit factors for the performance measure.
-
StartDate: string
(date)
Title:
Start Date
The date when the credit factor and earning factor provided for a credit category within a performance measure become active. The format is yyyy-mm-dd.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories-performanceMeasureTransactionFactors-item-response
Type:
Show Source
object
-
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. -
CreditCategoryId: integer
(int64)
The unique identifier for the credit category record.
-
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. -
PerformanceMeasureCreditCategoryId: integer
(int64)
The unique identifier of the credit category for the performance measure.
-
PerformanceMeasureId: integer
(int64)
The unique identifier for the performance measure record.
-
PerformanceMeasureTransactionFactorId: integer
(int64)
The unique identifier for the transaction factor records for the performance measure.
-
TransactionFactor: number
Title:
Factor
Default Value:100
A percentage of transaction amount considered for calculation. It helps to stage sales credit over the life of a sale, assigning percentages to important events in the sales process such as order, invoice, and payment. The default value is 100. -
TransactionType: string
Title:
Transaction Type
Maximum Length:30
The type of transaction. Possible values include CLAWBACK for claw back transaction type, CUSTOMER_SATISFACTION for customer satisfaction transaction type, GRP where the application creates a group by record during the calculation process, INVOICE for invoice transaction type, MANUAL for manual transaction type, ORDER for order transaction type, PAYMENT for payment transaction type, RAM_ADJUSTMENT for accounts receivable revenue adjustment transaction type, and ITD, where the application creates an Interval-to-date record during the calculation process. A list of acceptable values is defined in the lookup CN_TP_TRANSACTION_TYPE. 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 : incentiveCompensationPerformanceMeasures-performanceMeasureDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
The flex context segment code for the performance measure. It determines which context-sensitive segments are displayed. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
The flex context segment display name for the performance measure. It determines which context-sensitive segments are displayed. -
FormulaId: integer
(int64)
The unique identifier for a performance measure record.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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 : 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
Nested Schema : incentiveCompensationPerformanceMeasures-performanceMeasureRateDimensionalInputs-item-response
Type:
Show Source
object
-
AccumulateFlag: boolean
Title:
Accumulate
Maximum Length:1
Default Value:false
Indicates which rate dimension input expression (rate dimension) does running total apply to, when using running total for a scorecard with multiple dimensions. Possible values include FALSE and TRUE. The default value is FALSE. -
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. -
InputExpressionDescription: string
Title:
Description
Read Only:true
Maximum Length:1000
The rate dimensional input expression description entered while creating the expression. -
InputExpressionId: integer
(int64)
Title:
Input Expression ID
The unique identifier for the input expression record for a business unit. This represents the input expression to the rate dimension of the scorecard used in the performance measure. -
InputExpressionName: string
Title:
Input Expression Name
Maximum Length:160
The name for the input expression to the rate dimension of the scorecard used in the performance measure. -
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 this 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. -
PerformanceMeasureId: integer
(int64)
Title:
Performance Measure ID
The unique identifier for a performance measure record. -
PerformanceMeasureInputExpressionId: integer
(int64)
Title:
Performance Measure Input Expression Id
The unique identifier for the input expression to the rate dimension of the scorecard used in the performance measure. -
PerformanceMeasureRateDimensionalInputsDeleteFlag: boolean
Read Only:
true
Default Value:false
Inidcates whether a rate dimensional input can be deleted. -
RateDimName: integer
Title:
Dimension Name
Read Only:true
The name of the rate dimension. A scorecard can have one or more rate dimensions. -
RateDimSequence: integer
(int64)
Title:
Rate Dimension Sequence
The order of a rate dimension within a scorecard. -
SplitFlag: boolean
Title:
Apply split
Maximum Length:1
Default Value:false
Indicates whether the split option can apply to only one rate dimension input expression when splitting the rate across tiers. This informs which rate dimension input expression (rate dimension) to use. Possible values include FALSE and TRUE. The default value is FALSE.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : incentiveCompensationPerformanceMeasures-performanceMeasureScorecards-item-response
Type:
Show Source
object
-
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. -
EndDate: string
(date)
Title:
End Date
The date when the scorecard becomes inactive for the performance measure. The format is yyyy-mm-dd. -
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. -
PerformanceMeasureId: integer
(int64)
Title:
Performance Measure ID
The name of the performance measure. -
PerformanceMeasureName: string
Title:
Performance Measure Name
Read Only:true
Maximum Length:80
The name of a performance measure. -
PerformanceMeasureScorecardId: integer
(int64)
The unique identifier of a scorecard within a performance measure.
-
ScorecardDescription: string
Title:
Description
Read Only:true
Maximum Length:1000
The description of the scorecard entered by the user while creating the scorecard. -
ScorecardId: integer
(int64)
Title:
Scorecard ID
The name of a scorecard. -
ScorecardName: string
Title:
Scorecard Name
Maximum Length:80
The name of the scorecard. A scorecard is used to establish attainment rates or fixed amounts for different performance levels. -
StartDate: string
(date)
Title:
Start Date
The date when the scorecard becomes active for the performance measure. The format is yyyy-mm-dd.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ApplySplitLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_SPLIT_TYPE_OPTION
The list of values indicating 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. The default value is NONE.
The following properties are defined on the LOV link relation:- Source Attribute: SplitOption; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- BusinessUnit
-
The unique identifier of the business unit.
The following properties are defined on the LOV link relation:- Source Attribute: OrgId; Target Attribute: OrganizationId
- Display Attribute: Name
- MesureFormulaExpressionVO
-
Parameters:
- finder:
UsageCodeFinder%3BBindExpressionType%3DCALCULATION%2CBindOrgId%3D{OrgId}
The list of values containing the names for the expressions used in the measure formula to calculate the attainment of the performance measure.
The following properties are defined on the LOV link relation:- Source Attribute: MeasureFormulaExpressionName; Target Attribute: ExpressionName
- Display Attribute: ExpressionName
- finder:
- PerformanceIntervalVO
-
Parameters:
- finder:
BusinessUnitFinder%3BPorgId%3D{OrgId}
The list of internal values that the performance is measured for. When running total is considered, the accumulated value is reset based on this interval value. The interval represents a unit of time like month, quarter, year. The default value is '-1000'.
The following properties are defined on the LOV link relation:- Source Attribute: PerformanceInterval; Target Attribute: IntervalTypeId
- Display Attribute: IntervalName
- finder:
- ProcessTxnLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_PROCESS_TXN
The list of values indicating how the application processes transactions in a measure. The possible values include GROUP for Group transactions for the specified interval for attainment calculation, and INDIVIDUAL to evaluate each transaction independently for attainment calculation. You must also set the Accumulation flag as Y if you select Group.
The following properties are defined on the LOV link relation:- Source Attribute: ProcessTransactions; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- UnitOfMeasureLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_MEASURE_UOM
The list of values containing the standardized quantities used as a factor to express occurring quantities of the performance measure property. Possible values include AMOUNT to measure attainment based on an amount, PERCENT to measure attainment based on a percent, QUANTITY to measure attainment based on a quantity, and SCORE to measure attainment based on a score. 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:
- UseExternalFormulaLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_YES_NO
The list of values indicating whether the performance measure uses an external formula from an external package. Possible values include FALSE and TRUE. The default value is FALSE.
The following properties are defined on the LOV link relation:- Source Attribute: UseExternalFormulaFlag; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ValidForCalculationVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_COMP_PLAN_STATUS
The list of values indicating whether a performance measure is ready for calculation. Possible values include COMPLETE for valid and ready for calculation, and INCOMPLETE for invalid and not ready for calculation. The default value is INCOMPLETE.
The following properties are defined on the LOV link relation:- Source Attribute: ValidForCalculation; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- performanceMeasureCreditCategories
-
Parameters:
- PerformanceMeasureId:
$request.path.PerformanceMeasureId
The credit categories resource is used to view, create, and delete the association of a credit category with a performance measure. It can also be used to display all the details of the credit categories under a performance measure. A credit category is used to define which transaction is eligible for crediting by the Incentive Compensation system. A performance measure credit category record links the credit category to a performance measure and provides additional details at this level. A credit category needs to exist before creating this record. - PerformanceMeasureId:
- performanceMeasureDFF
-
Parameters:
- PerformanceMeasureId:
$request.path.PerformanceMeasureId
The Descriptive Flex Field resource is used to create, view, and update user defined values for the performance measure. A new API Name can be defined by going to Setup and Maintenance and opening the Manage Descriptive Flex Fields task. - PerformanceMeasureId:
- performanceMeasureGoals
-
Parameters:
- PerformanceMeasureId:
$request.path.PerformanceMeasureId
The goals resource is used to view and update a goal. It can also be used to display all the details of a goal. A goal under a performance measure defines the target applicable to a participant and could be assigned across a timeline. This is created when creating a Performance Measure with a default value of 0. This needs to be updated later if needed. - PerformanceMeasureId:
- performanceMeasureRateDimensionalInputs
-
Parameters:
- PerformanceMeasureId:
$request.path.PerformanceMeasureId
The Rate Dimensional Input Expressions resource is used to view and update the association of an input expression with a performance measure. It can also be used to display all the details of the input expressions under a performance measure. This record specifies the inputs of a rate dimension of a scorecard and provides additional details at this level. A valid expression which also has a valid usage needs to exist before creating this record. This should be assigned only after the scorecard has been assigned. - PerformanceMeasureId:
- performanceMeasureScorecards
-
Parameters:
- PerformanceMeasureId:
$request.path.PerformanceMeasureId
The scorecards resource is used to view, create, update, and delete the association of a scorecard with a performance measure. It can also be used to display all the details of a scorecard associated with a performance measure. This resource links the scorecard to a performance measure and provides additional details at this level. A scorecard needs to exist before creating this record. - PerformanceMeasureId:
Examples
The following example shows how to get a performance measure record by submitting a GET request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/300100090511017
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "PerformanceMeasureId": 300100090511017, "Name": "Sales Attainment 2016", "Description": "Sales Attainment for 2016", "UnitOfMeasure": "AMOUNT", "ValidForCalculation": "COMPLETE", "OrgId": 204, "StartDate": "2016-01-01", "EndDate": "2016-12-31", "NumberOfDimensions": 2, "UseExternalFormulaFlag": false, "ExternalFormulaName": null, "IncludeInParticipantReportsFlag": true, "MeasureFormulaExpressionId": 100000015115055, "RunningTotalFlag": false, "SplitOption": "PROPORTIONAL", "MeasureFormulaExpressionName": null, "ProcessTransactions": "INDIVIDUAL", "PerformanceInterval": "-1000", "DisplayName": "Sales Attainment", "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "CreationDate": "2017-06-08T11:28:10-07:00", "LastUpdateDate": "2017-06-08T23:13:51-07:00", "LastUpdateLogin": "517891504F9C08F9E0532DD6F00A1DF5", "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "MeasureFormulaExpressionDescription": null, "InvalidReason": null, "links": [ ... ] }