Jump to

• Request
• Response

Update a performance measure

patch

/fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentPerformanceMeasures/{PlanComponentPerformanceMeasureId}

Request

Path Parameters

• PlanComponentPerformanceMeasureId(required): integer(int64)
  The unique identifier for the performance measure record associated with the plan component.
• planComponentsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- PlanComponentId and OrgId ---for the Plan Components resource and used to uniquely identify an instance of Plan Components. The client should not generate the hash key value. Instead, the client should query on the Plan Components collection resource with a filter on the primary key values in order to navigate to a specific instance of Plan Components.
  
  For example: planComponents?q=PlanComponentId=<value1>;OrgId=<value2>

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CalculationSequence: integer (int32)
  Title: Calculation Sequence

  Default Value: 1

  The order in which the calculation engine considers a performance measure within a plan component. This is set when dependent measures refer to the calculated results of other base measures. Dependent measures must have a higher calculation sequence than base measures.
• EarningBasis: string
  Title: Earning Basis

  Maximum Length: 1

  Default Value: Y

  Specifies whether attainment and earnings calculations use the same credit categories and whether the incentive formula uses the measure attainment in calculations. Possible values include Y, N. Keep it Y, references the performance measure attainment in the incentive formula expression of the plan component. Earning basis must be Y when a performance measure that processes transactions individually is associated with plan components that calculate incentive per event. 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.
• PerformanceMeasureId: integer (int64)
  Title: Performance Measure ID

  The unique identifier of a performance measure record.
• PerformanceMeasureWeight: integer (int64)
  Title: Weight

  Default Value: 100

  The percentage of influence a performance measure has on the plan component.
• PlanComponentId: integer (int64)
  Title: Plan Component ID

  The unique identifier of the plan component record within a business unit.

{
    "type":"object",
    "properties":{
        "PerformanceMeasureWeight":{
            "title":"Weight",
            "type":"integer",
            "description":"The percentage of influence a performance measure has on the plan component.",
            "format":"int64",
            "nullable":true,
            "default":"100",
            "x-hints":{
                "precision":"18"
            }
        },
        "PerformanceMeasureId":{
            "title":"Performance Measure ID",
            "type":"integer",
            "description":"The unique identifier of a performance measure record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "EarningBasis":{
            "title":"Earning Basis",
            "maxLength":"1",
            "type":"string",
            "description":"Specifies whether attainment and earnings calculations use the same credit categories and whether the incentive formula uses the measure attainment in calculations. Possible values include Y, N. \nKeep it Y, references the performance measure attainment in the incentive formula expression of the plan component. \nEarning basis must be Y when a performance measure that processes transactions individually is associated with plan components that calculate incentive per event. 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.",
            "nullable":true,
            "default":"Y",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PlanComponentId":{
            "title":"Plan Component ID",
            "type":"integer",
            "description":"The unique identifier of the plan component record within a business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CalculationSequence":{
            "title":"Calculation Sequence",
            "type":"integer",
            "description":"The order in which the calculation engine considers a performance measure within a plan component. This is set when dependent measures refer to the calculated results of other base measures. Dependent measures must have a higher calculation sequence than base measures.",
            "format":"int32",
            "nullable":true,
            "default":"1",
            "x-hints":{
                "precision":"9"
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : planComponents-planComponentPerformanceMeasures-item-response

Type: object

Show Source

• CalculationSequence: integer (int32)
  Title: Calculation Sequence

  Default Value: 1

  The order in which the calculation engine considers a performance measure within a plan component. This is set when dependent measures refer to the calculated results of other base measures. Dependent measures must have a higher calculation sequence than base measures.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  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.
• EarningBasis: string
  Title: Earning Basis

  Maximum Length: 1

  Default Value: Y

  Specifies whether attainment and earnings calculations use the same credit categories and whether the incentive formula uses the measure attainment in calculations. Possible values include Y, N. Keep it Y, references the performance measure attainment in the incentive formula expression of the plan component. Earning basis must be Y when a performance measure that processes transactions individually is associated with plan components that calculate incentive per event. 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.
• EndDate: string (date)
  Title: End Date

  Read Only: true

  The date when the performance measure associated with the performance measure becomes inactive. This is a read only field. The performance measure takes the date of the plan component. 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: 64

  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.
• PerformanceInterval: string
  Title: Performance Interval

  Read Only: true

  Default Value: -1000

  This is the interval value for the performance measurement. Where running total is considered, the accumulated value is reset based on this interval value. Interval would represent a unit of time like month, quarter, year. The default value is '-1000'.
• PerformanceMeasureId: integer (int64)
  Title: Performance Measure ID

  The unique identifier of a performance measure record.
• PerformanceMeasureName: string
  Title: Performance Measure Name

  Read Only: true

  Maximum Length: 80

  The name of a performance measure, which is an indicator used to measure the progress toward a specified outcome or goal.
• PerformanceMeasureWeight: integer (int64)
  Title: Weight

  Default Value: 100

  The percentage of influence a performance measure has on the plan component.
• PlanComponentId: integer (int64)
  Title: Plan Component ID

  The unique identifier of the plan component record within a business unit.
• PlanComponentName: string
  Title: Plan Component Name

  Read Only: true

  Maximum Length: 80

  The name of a plan component, which defines the earnings of a participant based on their performance.
• PlanComponentPerformanceMeasureId: integer (int64)
  The unique identifier for the performance measure record associated with the plan component.
• ProcessTransactions: string
  Title: Process Transactions

  Read Only: true

  Maximum Length: 30

  Indicates how the application processes transactions in a measure. The possible values include GROUP for Group transactions for the specified interval, for attainment calculation and INDIVIDUAL for evaluating each transaction independently, for attainment calculation. 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.
• StartDate: string (date)
  Title: Start Date

  Read Only: true

  The date when the performance measure associated with the performance measure becomes active. This is a read only field. The performance measure takes the date of the plan component. The format is yyyy-mm-dd.
• UnitOfMeasure: string
  Title: Unit of Measure

  Read Only: true

  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 for measure attainment is based on an amount, PERCENT for measure attainment is based on a percent, QUANTITY for measure attainment is based on a quantity, and SCORE for measure attainment is based on a score. 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.
• ValidForCalculation: string
  Title: Valid for Calculation

  Read Only: true

  Maximum Length: 30

  Default Value: INCOMPLETE

  Indicates whether the 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. A list of acceptable values is defined in the lookup CN_COMP_PLAN_STATUS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PerformanceInterval":{
            "title":"Performance Interval",
            "type":"string",
            "description":"This is the interval value  for the performance measurement. Where running total is considered, the accumulated value is reset based on this interval value. \nInterval would represent a unit of time like month, quarter, year. The default value is '-1000'.",
            "nullable":true,
            "readOnly":true,
            "default":"-1000",
            "x-queryable":true
        },
        "PerformanceMeasureName":{
            "title":"Performance Measure Name",
            "maxLength":"80",
            "type":"string",
            "description":"The name of a performance measure, which is an indicator used to measure the progress toward a specified outcome or goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":"30",
            "type":"string",
            "description":"The standardized quantity used as a factor to express occurring quantities of the performance measure property. Possible values include AMOUNT for measure attainment is based on an amount, PERCENT for measure attainment is based on a percent, QUANTITY for measure attainment is based on a quantity, and SCORE for measure attainment is based on a score. 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.",
            "nullable":true,
            "readOnly":true,
            "default":"AMOUNT",
            "x-queryable":true
        },
        "ValidForCalculation":{
            "title":"Valid for Calculation",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the 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. A list of acceptable values is defined in the lookup CN_COMP_PLAN_STATUS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "readOnly":true,
            "default":"INCOMPLETE",
            "x-queryable":true
        },
        "PerformanceMeasureId":{
            "title":"Performance Measure ID",
            "type":"integer",
            "description":"The unique identifier of a performance measure record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the performance measure associated with the performance measure becomes inactive. This is a read only field. The performance measure takes the date of the plan component. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentId":{
            "title":"Plan Component ID",
            "type":"integer",
            "description":"The unique identifier of the plan component record within a business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CalculationSequence":{
            "title":"Calculation Sequence",
            "type":"integer",
            "description":"The order in which the calculation engine considers a performance measure within a plan component. This is set when dependent measures refer to the calculated results of other base measures. Dependent measures must have a higher calculation sequence than base measures.",
            "format":"int32",
            "nullable":true,
            "default":"1",
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the performance measure associated with the performance measure becomes active. This is a read only field. The performance measure takes the date of the plan component. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PerformanceMeasureWeight":{
            "title":"Weight",
            "type":"integer",
            "description":"The percentage of influence a performance measure has on the plan component.",
            "format":"int64",
            "nullable":true,
            "default":"100",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EarningBasis":{
            "title":"Earning Basis",
            "maxLength":"1",
            "type":"string",
            "description":"Specifies whether attainment and earnings calculations use the same credit categories and whether the incentive formula uses the measure attainment in calculations. Possible values include Y, N. \nKeep it Y, references the performance measure attainment in the incentive formula expression of the plan component. \nEarning basis must be Y when a performance measure that processes transactions individually is associated with plan components that calculate incentive per event. 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.",
            "nullable":true,
            "default":"Y",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PlanComponentPerformanceMeasureId":{
            "type":"integer",
            "description":"The unique identifier for the performance measure record associated with the plan component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProcessTransactions":{
            "title":"Process Transactions",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates 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 for evaluating each transaction independently, for attainment calculation. 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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentName":{
            "title":"Plan Component Name",
            "maxLength":"80",
            "type":"string",
            "description":"The name of a plan component, which defines the earnings of a participant based on their performance.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

CnLookupYesNoVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCN_YES_NO

The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing.

PerformanceMeasureFormulaVO

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures

The performance measures resource is used to view, create, update, and delete a performance measure. It can also be used to display all the details of a performance measure. A performance measure is a determination of the accomplishment of a participant. It could include a goal/target, an eligibility criteria, a measure formula, and a score card. A new performance measure can be created in five different ways, with an incentive formula (output expression), with a credit category (with or without credit factors and transaction factors), with a scorecard (without an rate dimensional input expression - this input expression should be assigned only after the scorecard has been assigned), with any combination of the above, or individually where only the performance measure is created (association with other components needs to be done separately.) When a performance measure is created, Goals, Interval Goals, and Period Goals are created with a default value of 0. The user can then update the total goal or the period goals.

Back to Top