Jump to

• Request
• Response
• Examples

Get a performance measure

get

/fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}

Request

Path Parameters

• ParticipantPerformanceMeasureId(required): integer(int64)
  The unique identifier of the performance measure associated with the participant plan component.
• ParticipantPlanComponentId(required): integer(int64)
  The unique identifier of the plan component associated with the participant compensation plan.
• participantCompensationPlansUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Participant Compensation Plans resource and used to uniquely identify an instance of Participant Compensation Plans. The client should not generate the hash key value. Instead, the client should query on the Participant Compensation Plans collection resource in order to navigate to a specific instance of Participant Compensation Plans to get the hash key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  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: string
  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 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 : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-item-response

Type: object

Show Source

• CalculationSequence: integer (int32)
  Read Only: true

  Indicates the order in which the calculation engine considers a performance measure within a plan component.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the participant performance measure.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the participant performance measure is created.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  The description of the performance measure entered while creating the performance measure.
• EarningBasis: string
  Title: Earning Basis

  Read Only: true

  Maximum Length: 1

  Indicates whether attainment and earnings calculations use the same credit categories and whether the incentive formula uses the measure attainment in calculations.
• EndDate: string (date)
  Title: End Date

  Read Only: true

  The date when the performance measure associated with the plan component becomes inactive.
• IncludeInParticipantReportsFlag: boolean
  Title: Include in participant reports

  Read Only: true

  Maximum Length: 1

  Indicates the intent to display or exclude the measure attainment in reports. Valid values are Y and N. If No, then the intent is to exclude the measure attainment in reports. It is useful if the measure results are intermediate calculations which need not be shown in reports.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the participant performance measure is last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the participant performance measure.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MeasureFormulaExpressionDescription: string
  Title: Expression Description

  Read Only: true

  Maximum Length: 1000

  The description of the measure formula expression entered while creating the expression.
• MeasureFormulaExpressionId: integer (int64)
  Read Only: true

  The unique identifier of 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

  Read Only: true

  Maximum Length: 160

  The name of the expression used in measure formula to calculate attainment of the performance measure.
• NumberOfDimensions: integer (int64)
  Title: Number of Dimensions

  Read Only: true

  The number of dimensions of the scorecard used in the performance measure.
• ParticipantPerformanceMeasureGoals: array Goals
  Title: Goals

  The performance measure goals resource is used to view and update the total target of a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component. The total target defines the performance target across a timeline.
• ParticipantPerformanceMeasureId: integer (int64)
  Read Only: true

  The unique identifier of the performance measure associated with the participant plan component.
• ParticipantPerformanceMeasureScorecards: array Scorecards
  Title: Scorecards

  The performance measure scorecards resource is used to view the scorecards of a participant performance measure. A scorecard is used to establish attainment rates or fixed amounts for different performance levels.
• ParticipantPlanComponentId: integer (int64)
  Read Only: true

  The unique identifier of the plan component associated with the participant compensation plan.
• PerformanceInterval: string
  Title: Performance Interval

  Read Only: true

  Maximum Length: 80

  This is the interval value for the performance measurement. Where a 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.
• PerformanceMeasureId: integer (int64)
  Title: Name

  Read Only: true

  The unique identifier of the performance measure associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
• PerformanceMeasureName: string
  Title: Name

  Read Only: true

  Maximum Length: 80

  The name of the performance measure, which is an indicator used to measure the progress toward a specified outcome or goal.
• PlanComponentId: integer (int64)
  Read Only: true

  The unique identifier of the plan component associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
• 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 grouping transactions for the specified interval, and INDIVIDUAL to evaluate each transaction independently. A list of acceptable values is defined in the lookup CN_PROCESS_TXN. Review 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

  Read Only: true

  Maximum Length: 1

  Indicates whether to accumulate a calculation input, such as credit amount or credit quantity, over a period.
• SplitOption: string
  Title: Split Option

  Read Only: true

  Maximum Length: 30

  Indicates 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. A list of acceptable values is defined in the lookup CN_SPLIT_TYPE_OPTION. Review 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 plan component becomes active.
• TotalTarget: number
  Title: Total Target

  Read Only: true

  Default Value: 0

  The total target for the performance measure.
• UnitOfMeasure: string
  Title: Unit of Measure

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 1

  Indicates whether the performance measure uses an external formula from an external package.
• Weight: integer (int64)
  Title: Weight

  Read Only: true

  The percentage of influence a performance measure has on the plan component.

{
    "type":"object",
    "properties":{
        "CalculationSequence":{
            "type":"integer",
            "description":"Indicates the order in which the calculation engine considers a performance measure within a plan component.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the participant performance measure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the participant performance measure is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the performance measure entered while creating the performance measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EarningBasis":{
            "title":"Earning Basis",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether attainment and earnings calculations use the same credit categories and whether the incentive formula uses the measure attainment in calculations.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the performance measure associated with the plan component becomes inactive.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IncludeInParticipantReportsFlag":{
            "title":"Include in participant reports",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the intent to display or exclude the measure attainment in reports. Valid values are Y and N.  If No, then the intent is to exclude the measure attainment in reports. It is useful if the measure results are intermediate calculations which need not be shown in reports.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the participant performance measure is last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the participant performance measure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MeasureFormulaExpressionDescription":{
            "title":"Expression Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the measure formula expression entered while creating the expression.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeasureFormulaExpressionId":{
            "type":"integer",
            "description":"The unique identifier of the measure formula expression for this performance measure. The measure formula expression is used to calculate attainment of the performance measure.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MeasureFormulaExpressionName":{
            "title":"Expression Name",
            "maxLength":160,
            "type":"string",
            "description":"The name of the expression used in measure formula to calculate attainment of the performance measure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberOfDimensions":{
            "title":"Number of Dimensions",
            "type":"integer",
            "description":"The number of dimensions of the scorecard used in the performance measure.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParticipantPerformanceMeasureGoals":{
            "title":"Goals",
            "type":"array",
            "description":"The performance measure goals resource is used to view and update the total target of a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component. The total target defines the performance target across a timeline.",
            "items":{
                "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-item-response"
            }
        },
        "ParticipantPerformanceMeasureId":{
            "type":"integer",
            "description":"The unique identifier of the performance measure associated with the participant plan component.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParticipantPerformanceMeasureScorecards":{
            "title":"Scorecards",
            "type":"array",
            "description":"The performance measure scorecards resource is used to view the scorecards of a participant performance measure. A scorecard is used to establish attainment rates or fixed amounts for different performance levels.",
            "items":{
                "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureScorecards-item-response"
            }
        },
        "ParticipantPlanComponentId":{
            "type":"integer",
            "description":"The unique identifier of the plan component associated with the participant compensation plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PerformanceInterval":{
            "title":"Performance Interval",
            "maxLength":80,
            "type":"string",
            "description":"This is the interval value for the performance measurement. Where a 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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PerformanceMeasureId":{
            "title":"Name",
            "type":"integer",
            "description":"The unique identifier of the performance measure associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PerformanceMeasureName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of the performance measure, which is an indicator used to measure the progress toward a specified outcome or goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentId":{
            "type":"integer",
            "description":"The unique identifier of the plan component associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "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 grouping transactions for the specified interval, and INDIVIDUAL to evaluate each transaction independently. A list of acceptable values is defined in the lookup CN_PROCESS_TXN. Review the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RenderedMeasureFormulaExpression":{
            "title":"Rendered Expression",
            "type":"string",
            "description":"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.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RunningTotalFlag":{
            "title":"Running total",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether to accumulate a calculation input, such as credit amount or credit quantity, over a period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SplitOption":{
            "title":"Split Option",
            "maxLength":30,
            "type":"string",
            "description":"Indicates 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. A list of acceptable values is defined in the lookup CN_SPLIT_TYPE_OPTION. Review the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the performance measure associated with the plan component becomes active.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalTarget":{
            "title":"Total Target",
            "type":"number",
            "description":"The total target for the performance measure.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "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. 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,
            "x-queryable":true
        },
        "UseExternalFormulaFlag":{
            "title":"Use external formula",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the performance measure uses an external formula from an external package.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Weight":{
            "title":"Weight",
            "type":"integer",
            "description":"The percentage of influence a performance measure has on the plan component.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : Goals

Type: array

Title: Goals

The performance measure goals resource is used to view and update the total target of a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component. The total target defines the performance target across a timeline.

Show Source

• Array of: object participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-item-response

{
    "title":"Goals",
    "type":"array",
    "description":"The performance measure goals resource is used to view and update the total target of a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component. The total target defines the performance target across a timeline.",
    "items":{
        "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-item-response"
    }
}

Nested Schema : Scorecards

Type: array

Title: Scorecards

The performance measure scorecards resource is used to view the scorecards of a participant performance measure. A scorecard is used to establish attainment rates or fixed amounts for different performance levels.

Show Source

• Array of: object participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureScorecards-item-response

{
    "title":"Scorecards",
    "type":"array",
    "description":"The performance measure scorecards resource is used to view the scorecards of a participant performance measure. A scorecard is used to establish attainment rates or fixed amounts for different performance levels.",
    "items":{
        "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureScorecards-item-response"
    }
}

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."
        }
    }
}

Nested Schema : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-item-response

Type: object

Show Source

• AlternateTarget1: number
  Title: Alternate Target 1

  Default Value: 0

  The alternate target number for a measure, for example, stretch goal.
• AlternateTarget2: number
  Title: Alternate Target 2

  Default Value: 0

  The alternate target number for a measure, for example, stretch goal.
• AlternateTarget3: number
  Title: Alternate Target 3

  Default Value: 0

  The alternate target number for a measure, for example, stretch goal.
• AlternateTarget4: number
  Title: Alternate Target 4

  Default Value: 0

  The alternate target number for a measure, for example, stretch goal.
• AlternateTarget5: number
  Title: Alternate Target 5

  Default Value: 0

  The alternate target number for a measure, for example, stretch goal.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the participant performance measure goal.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the participant performance measure goal is created.
• DistributeEvenlyFlag: boolean
  The instruction for the application to evenly distribute the total target and alternate targets to the respective interval and period amounts for this web service request. The possible values are TRUE and FALSE.
• GoalId: integer (int64)
  Read Only: true

  The unique identifier of the goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
• GoalInterval: string
  Title: Interval

  Read Only: true

  The performance interval that describes the span of time to be measured for the attainment of the goal amounts, such as period, quarter, or year. This interval is the same as the corresponding performance (measure) interval.
• GoalTarget: number
  Title: Total Target

  Default Value: 0

  The expected level of attainment assigned to the participant for the measure.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the participant performance measure goal is last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the participant performance measure goal.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParticipantGoalId: integer (int64)
  Read Only: true

  The unique identifier of the goal associated with the participant performance measure.
• ParticipantGoalIntervalGoals: array Interval Goals
  Title: Interval Goals

  The performance measure interval goals service is used to view the interval target amounts for a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component.
• ParticipantGoalPeriodGoals: array Period Goals
  Title: Period Goals

  The performance measure period goals service is used to view and update the period target amounts for a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component.
• ParticipantPerformanceMeasureId: integer (int64)
  Read Only: true

  The unique identifier of the participant performance measure.
• PerformanceMeasureId: integer (int64)
  Read Only: true

  The unique identifier of the performance measure associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
• PerformanceMeasureName: string
  Title: Name

  Read Only: true

  The name of the performance measure.

{
    "type":"object",
    "properties":{
        "AlternateTarget1":{
            "title":"Alternate Target 1",
            "type":"number",
            "description":"The alternate target number for a measure, for example, stretch goal.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "AlternateTarget2":{
            "title":"Alternate Target 2",
            "type":"number",
            "description":"The alternate target number for a measure, for example, stretch goal.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "AlternateTarget3":{
            "title":"Alternate Target 3",
            "type":"number",
            "description":"The alternate target number for a measure, for example, stretch goal.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "AlternateTarget4":{
            "title":"Alternate Target 4",
            "type":"number",
            "description":"The alternate target number for a measure, for example, stretch goal.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "AlternateTarget5":{
            "title":"Alternate Target 5",
            "type":"number",
            "description":"The alternate target number for a measure, for example, stretch goal.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the participant performance measure goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the participant performance measure goal is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DistributeEvenlyFlag":{
            "type":"boolean",
            "description":"The instruction for the application to evenly distribute the total target and alternate targets to the respective interval and period amounts for this web service request. The possible values are TRUE and FALSE.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "GoalId":{
            "type":"integer",
            "description":"The unique identifier of the goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "GoalInterval":{
            "title":"Interval",
            "type":"string",
            "description":"The performance interval that describes the span of time to be measured for the attainment of the goal amounts, such as period, quarter, or year. This interval is the same as the corresponding performance (measure) interval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalTarget":{
            "title":"Total Target",
            "type":"number",
            "description":"The expected level of attainment assigned to the participant for the measure.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the participant performance measure goal is last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the participant performance measure goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantGoalId":{
            "type":"integer",
            "description":"The unique identifier of the goal associated with the participant performance measure.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParticipantGoalIntervalGoals":{
            "title":"Interval Goals",
            "type":"array",
            "description":"The performance measure interval goals service is used to view the interval target amounts for a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component.",
            "items":{
                "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-ParticipantGoalIntervalGoals-item-response"
            }
        },
        "ParticipantGoalPeriodGoals":{
            "title":"Period Goals",
            "type":"array",
            "description":"The performance measure period goals service is used to view and update the period target amounts for a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component.",
            "items":{
                "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-ParticipantGoalPeriodGoals-item-response"
            }
        },
        "ParticipantPerformanceMeasureId":{
            "type":"integer",
            "description":"The unique identifier of the participant performance measure.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PerformanceMeasureId":{
            "type":"integer",
            "description":"The unique identifier of the performance measure associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PerformanceMeasureName":{
            "title":"Name",
            "type":"string",
            "description":"The name of the performance measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : Interval Goals

Type: array

Title: Interval Goals

The performance measure interval goals service is used to view the interval target amounts for a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component.

Show Source

• Array of: object participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-ParticipantGoalIntervalGoals-item-response

{
    "title":"Interval Goals",
    "type":"array",
    "description":"The performance measure interval goals service is used to view the interval target amounts for a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component.",
    "items":{
        "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-ParticipantGoalIntervalGoals-item-response"
    }
}

Nested Schema : Period Goals

Type: array

Title: Period Goals

The performance measure period goals service is used to view and update the period target amounts for a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component.

Show Source

• Array of: object participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-ParticipantGoalPeriodGoals-item-response

{
    "title":"Period Goals",
    "type":"array",
    "description":"The performance measure period goals service is used to view and update the period target amounts for a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component.",
    "items":{
        "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-ParticipantGoalPeriodGoals-item-response"
    }
}

Nested Schema : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-ParticipantGoalIntervalGoals-item-response

Type: object

Show Source

• AlternateIntervalTarget1: number
  Title: Alternate Interval Target 1

  Read Only: true

  Default Value: 0

  The alternate interval target for a measure, for example, stretch goal for an interval.
• AlternateIntervalTarget2: number
  Title: Alternate Interval Target 2

  Read Only: true

  Default Value: 0

  The alternate interval target for a measure, for example, stretch goal for an interval.
• AlternateIntervalTarget3: number
  Title: Alternate Interval Target 3

  Read Only: true

  Default Value: 0

  The alternate interval target for a measure, for example, stretch goal for an interval.
• AlternateIntervalTarget4: number
  Title: Alternate Interval Target 4

  Read Only: true

  Default Value: 0

  The alternate interval target for a measure, for example, stretch goal for an interval.
• AlternateIntervalTarget5: number
  Title: Alternate Interval Target 5

  Read Only: true

  Default Value: 0

  The alternate interval target for a measure, for example, stretch goal for an interval.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the interval goal.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the interval goal is created.
• GoalId: integer (int64)
  Read Only: true

  The unique identifier of the goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
• IntervalGoalId: integer (int64)
  Title: Period

  Read Only: true

  The unique identifier of the interval goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
• IntervalNumber: number
  Title: Period

  Read Only: true

  The display number for the interval.
• IntervalTarget: number
  Title: Interval Target

  Read Only: true

  Default Value: 0

  The target number specified for the goal interval.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the interval is last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the interval goal.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParticipantGoalId: integer (int64)
  Read Only: true

  The unique identifier of the goal.
• ParticipantIntervalGoalId: integer (int64)
  Read Only: true

  The unique identifier of the participant interval goal details.

{
    "type":"object",
    "properties":{
        "AlternateIntervalTarget1":{
            "title":"Alternate Interval Target 1",
            "type":"number",
            "description":"The alternate interval target for a measure, for example, stretch goal for an interval.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-queryable":true
        },
        "AlternateIntervalTarget2":{
            "title":"Alternate Interval Target 2",
            "type":"number",
            "description":"The alternate interval target for a measure, for example, stretch goal for an interval.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-queryable":true
        },
        "AlternateIntervalTarget3":{
            "title":"Alternate Interval Target 3",
            "type":"number",
            "description":"The alternate interval target for a measure, for example, stretch goal for an interval.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-queryable":true
        },
        "AlternateIntervalTarget4":{
            "title":"Alternate Interval Target 4",
            "type":"number",
            "description":"The alternate interval target for a measure, for example, stretch goal for an interval.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-queryable":true
        },
        "AlternateIntervalTarget5":{
            "title":"Alternate Interval Target 5",
            "type":"number",
            "description":"The alternate interval target for a measure, for example, stretch goal for an interval.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the interval goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the interval goal is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalId":{
            "type":"integer",
            "description":"The unique identifier of the goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IntervalGoalId":{
            "title":"Period",
            "type":"integer",
            "description":"The unique identifier of the interval goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IntervalNumber":{
            "title":"Period",
            "type":"number",
            "description":"The display number for the interval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntervalTarget":{
            "title":"Interval Target",
            "type":"number",
            "description":"The target number specified for the goal interval.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the interval is last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the interval goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantGoalId":{
            "type":"integer",
            "description":"The unique identifier of the goal.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParticipantIntervalGoalId":{
            "type":"integer",
            "description":"The unique identifier of the participant interval goal details.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-ParticipantGoalPeriodGoals-item-response

Type: object

Show Source

• AlternateITDTarget1: number
  Title: Alternate ITD Target 1

  Read Only: true

  Default Value: 0

  The alternate interval-to-date target number for a measure.
• AlternateITDTarget2: number
  Title: Alternate ITD Target 2

  Read Only: true

  Default Value: 0

  The alternate interval-to-date target number for a measure.
• AlternateITDTarget3: number
  Title: Alternate ITD Target 3

  Read Only: true

  Default Value: 0

  The alternate interval-to-date target number for a measure.
• AlternateITDTarget4: number
  Title: Alternate ITD Target 4

  Read Only: true

  Default Value: 0

  The alternate interval-to-date target number for a measure.
• AlternateITDTarget5: number
  Title: Alternate ITD Target 5

  Read Only: true

  Default Value: 0

  The alternate interval-to-date target number for a measure.
• AlternatePeriodTarget1: number
  Title: Alternate Period Target 1

  Default Value: 0

  The alternate period target number for a measure, for example, stretch goal for a period.
• AlternatePeriodTarget2: number
  Title: Alternate Period Target 2

  Default Value: 0

  The alternate period target number for a measure, for example, stretch goal for a period.
• AlternatePeriodTarget3: number
  Title: Alternate Period Target 3

  Default Value: 0

  The alternate period target number for a measure, for example, stretch goal for a period.
• AlternatePeriodTarget4: number
  Title: Alternate Period Target 4

  Default Value: 0

  The alternate period target number for a measure, for example, stretch goal for a period.
• AlternatePeriodTarget5: number
  Title: Alternate Period Target 5

  Default Value: 0

  The alternate period target number for a measure, for example, stretch goal for a period.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the period goal.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the period goal is created.
• GoalId: integer (int64)
  Read Only: true

  The unique identifier of the goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
• IntervalGoalId: integer (int64)
  Read Only: true

  The unique identifier of the interval goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
• ITDTarget: number
  Title: ITD Target

  Read Only: true

  Default Value: 0

  The interval-to-date target number for a measure.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the period goal is last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the period goal.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParticipantGoalId: integer (int64)
  Read Only: true

  The unique identifier of the goal.
• ParticipantIntervalGoalId: integer (int64)
  Read Only: true

  The unique identifier of the participant interval goal details.
• ParticipantPeriodGoalId: integer (int64)
  Read Only: true

  The unique identifier of the period goal.
• PeriodEndDate: string (date)
  Title: End Date

  Read Only: true

  The date when the period of time ends.
• PeriodGoalId: integer (int64)
  Read Only: true

  The unique identifier of the period goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
• PeriodId: integer (int64)
  Title: Period

  Read Only: true

  The unique identifier for the period of time defined in the calendar.
• PeriodName: string
  Title: Period

  Read Only: true

  Maximum Length: 30

  The name for a period of time defined in the calendar.
• PeriodStartDate: string (date)
  Title: Start Date

  Read Only: true

  The date when the period of time begins.
• PeriodTarget: number
  Title: Period Target

  Default Value: 0

  The period target number for a measure.

{
    "type":"object",
    "properties":{
        "AlternateITDTarget1":{
            "title":"Alternate ITD Target 1",
            "type":"number",
            "description":"The alternate interval-to-date target number for a measure.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "dependencies":[
                    "AlternatePeriodTarget1"
                ]
            },
            "x-queryable":true
        },
        "AlternateITDTarget2":{
            "title":"Alternate ITD Target 2",
            "type":"number",
            "description":"The alternate interval-to-date target number for a measure.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "dependencies":[
                    "AlternatePeriodTarget2"
                ]
            },
            "x-queryable":true
        },
        "AlternateITDTarget3":{
            "title":"Alternate ITD Target 3",
            "type":"number",
            "description":"The alternate interval-to-date target number for a measure.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "dependencies":[
                    "AlternatePeriodTarget3"
                ]
            },
            "x-queryable":true
        },
        "AlternateITDTarget4":{
            "title":"Alternate ITD Target 4",
            "type":"number",
            "description":"The alternate interval-to-date target number for a measure.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "dependencies":[
                    "AlternatePeriodTarget4"
                ]
            },
            "x-queryable":true
        },
        "AlternateITDTarget5":{
            "title":"Alternate ITD Target 5",
            "type":"number",
            "description":"The alternate interval-to-date target number for a measure.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "dependencies":[
                    "AlternatePeriodTarget5"
                ]
            },
            "x-queryable":true
        },
        "AlternatePeriodTarget1":{
            "title":"Alternate Period Target 1",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "AlternatePeriodTarget2":{
            "title":"Alternate Period Target 2",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "AlternatePeriodTarget3":{
            "title":"Alternate Period Target 3",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "AlternatePeriodTarget4":{
            "title":"Alternate Period Target 4",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "AlternatePeriodTarget5":{
            "title":"Alternate Period Target 5",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the period goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the period goal is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalId":{
            "type":"integer",
            "description":"The unique identifier of the goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ITDTarget":{
            "title":"ITD Target",
            "type":"number",
            "description":"The interval-to-date target number for a measure.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "dependencies":[
                    "PeriodTarget"
                ]
            },
            "x-queryable":true
        },
        "IntervalGoalId":{
            "type":"integer",
            "description":"The unique identifier of the interval goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the period goal is last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the period goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantGoalId":{
            "type":"integer",
            "description":"The unique identifier of the goal.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParticipantIntervalGoalId":{
            "type":"integer",
            "description":"The unique identifier of the participant interval goal details.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParticipantPeriodGoalId":{
            "type":"integer",
            "description":"The unique identifier of the period goal.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the period of time ends.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodGoalId":{
            "type":"integer",
            "description":"The unique identifier of the period goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodId":{
            "title":"Period",
            "type":"integer",
            "description":"The unique identifier for the period of time defined in the calendar.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodName":{
            "title":"Period",
            "maxLength":30,
            "type":"string",
            "description":"The name for a period of time defined in the calendar.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the period of time begins.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodTarget":{
            "title":"Period Target",
            "type":"number",
            "description":"The period target number for a measure.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureScorecards-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the participant scorecard rate table.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the participant scorecard rate table is created.
• EndDate: string (date)
  Read Only: true

  The date when the scorecard rate table associated with the performance measure becomes inactive.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the participant scorecard rate table is last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the participant scorecard rate table.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParticipantPerformanceMeasureId: integer (int64)
  Read Only: true

  The unique identifier of the performance measure associated with the participant plan component.
• ParticipantPerformanceMeasureScorecardId: integer (int64)
  Read Only: true

  The unique identifier of the scorecard rate table associated with the participant performance measure.
• ParticipantScorecardRates: array Scorecard Rates
  Title: Scorecard Rates

  The scorecard rates resource is used to create, view, and update the rates for a participant scorecard that can be individualized. You enable individualization for a scorecard by setting the Individualize option to Yes for the related participant plan component.
• PerformanceMeasureId: integer (int64)
  Read Only: true

  The unique identifier of the performance measure associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
• ScorecardDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  The description of the scorecard rate table entered by the user while creating the scorecard.
• ScorecardId: integer (int64)
  The unique identifier of the scorecard rate table associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
• ScorecardName: string
  Title: Name

  Read Only: true

  Maximum Length: 80

  The name of the scorecard rate table.
• StartDate: string (date)
  Read Only: true

  The date when the scorecard rate table associated with the performance measure becomes active.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the participant scorecard rate table.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the participant scorecard rate table is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The date when the scorecard rate table associated with the performance measure becomes inactive.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the participant scorecard rate table is last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the participant scorecard rate table.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantPerformanceMeasureId":{
            "type":"integer",
            "description":"The unique identifier of the performance measure associated with the participant plan component.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParticipantPerformanceMeasureScorecardId":{
            "type":"integer",
            "description":"The unique identifier of the scorecard rate table associated with the participant performance measure.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParticipantScorecardRates":{
            "title":"Scorecard Rates",
            "type":"array",
            "description":"The scorecard rates resource is used to create, view, and update the rates for a participant scorecard that can be individualized. You enable individualization for a scorecard by setting the Individualize option to Yes for the related participant plan component.",
            "items":{
                "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureScorecards-ParticipantScorecardRates-item-response"
            }
        },
        "PerformanceMeasureId":{
            "type":"integer",
            "description":"The unique identifier of the performance measure associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ScorecardDescription":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the scorecard rate table entered by the user while creating the scorecard.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScorecardId":{
            "type":"integer",
            "description":"The unique identifier of the scorecard rate table associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ScorecardName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of the scorecard rate table.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The date when the scorecard rate table associated with the performance measure becomes active.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : Scorecard Rates

Type: array

Title: Scorecard Rates

The scorecard rates resource is used to create, view, and update the rates for a participant scorecard that can be individualized. You enable individualization for a scorecard by setting the Individualize option to Yes for the related participant plan component.

Show Source

• Array of: object participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureScorecards-ParticipantScorecardRates-item-response

{
    "title":"Scorecard Rates",
    "type":"array",
    "description":"The scorecard rates resource is used to create, view, and update the rates for a participant scorecard that can be individualized. You enable individualization for a scorecard by setting the Individualize option to Yes for the related participant plan component.",
    "items":{
        "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureScorecards-ParticipantScorecardRates-item-response"
    }
}

Nested Schema : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureScorecards-ParticipantScorecardRates-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the participant rate.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the participant rate is created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the participant rate is last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the participant rate.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParticipantPerformanceMeasureScorecardId: integer (int64)
  Read Only: true

  The unique identifier of the scorecard rate table associated with the participant performance measure.
• ParticipantScorecardRateId: integer (int64)
  Read Only: true

  The unique identifier of the rate associated with the participant scorecard.
• Rate: number
  Title: Rate

  The output value of the scorecard rate table is used to establish attainment rates or fixed amounts for different performance levels. This value is a percent or an amount depending on the rate table type set for the rate table. If the rate table type is percent, then the value stored here needs to be divided by 100 to get the actual value. For example, if the rate table type is percent and the rate value is 10%, then 10 is the output value.
• RateDimension10Id: integer
  The unique identifier of the tenth dimension associated with the rate. Used only when the scorecard rate table has ten dimensions.
• RateDimension10Name: string
  Title: Name

  Read Only: true

  The name of the tenth dimension.
• RateDimension10TierId: integer
  The unique identifier of the tier for the tenth dimension associated with the rate.
• RateDimension10TierSequence: integer
  Title: Sequence

  Read Only: true

  The tier sequence number within the dimension.
• RateDimension1Id: integer
  The unique identifier of the first dimension associated with the rate.
• RateDimension1Name: string
  Title: Name

  Read Only: true

  The name of the first dimension.
• RateDimension1TierId: integer
  The unique identifier of the tier for the first dimension associated with the rate.
• RateDimension1TierSequence: integer
  Title: Sequence

  Read Only: true

  The tier sequence number within the dimension.
• RateDimension2Id: integer
  The unique identifier of the second dimension associated with the rate. Used only when the scorecard rate table has at least two dimensions.
• RateDimension2Name: string
  Title: Name

  Read Only: true

  The name of the second dimension.
• RateDimension2TierId: integer
  The unique identifier of the tier for the second dimension associated with the rate.
• RateDimension2TierSequence: integer
  Title: Sequence

  Read Only: true

  The tier sequence number within the dimension.
• RateDimension3Id: integer
  The unique identifier of the third dimension associated with the rate. Used only when the scorecard rate table has at least three dimensions.
• RateDimension3Name: string
  Title: Name

  Read Only: true

  The name of the third dimension.
• RateDimension3TierId: integer
  The unique identifier of the tier for the third dimension associated with the rate.
• RateDimension3TierSequence: integer
  Title: Sequence

  Read Only: true

  The tier sequence number within the dimension.
• RateDimension4Id: integer
  The unique identifier of the fourth dimension associated with the rate. Used only when the scorecard rate table has at least four dimensions.
• RateDimension4Name: string
  Title: Name

  Read Only: true

  The name of the fourth dimension.
• RateDimension4TierId: integer
  The unique identifier of the tier for the fourth dimension associated with the rate.
• RateDimension4TierSequence: integer
  Title: Sequence

  Read Only: true

  The tier sequence number within the dimension.
• RateDimension5Id: integer
  The unique identifier of the fifth dimension associated with the rate. Used only when the scorecard rate table has at least five dimensions.
• RateDimension5Name: string
  Title: Name

  Read Only: true

  The name of the fifth dimension.
• RateDimension5TierId: integer
  The unique identifier of the tier for the fifth dimension associated with the rate.
• RateDimension5TierSequence: integer
  Title: Sequence

  Read Only: true

  The tier sequence number within the dimension.
• RateDimension6Id: integer
  The unique identifier of the sixth dimension associated with the rate. Used only when the scorecard rate table has at least six dimensions.
• RateDimension6Name: string
  Title: Name

  Read Only: true

  The name of the sixth dimension.
• RateDimension6TierId: integer
  The unique identifier of the tier for the sixth dimension associated with the rate.
• RateDimension6TierSequence: integer
  Title: Sequence

  Read Only: true

  The tier sequence number within the dimension.
• RateDimension7Id: integer
  The unique identifier of the seventh dimension associated with the rate. Used only when the scorecard rate table has at least seven dimensions.
• RateDimension7Name: string
  Title: Name

  Read Only: true

  The name of the seventh dimension.
• RateDimension7TierId: integer
  The unique identifier of the tier for the seventh dimension associated with the rate.
• RateDimension7TierSequence: integer
  Title: Sequence

  Read Only: true

  The tier sequence number within the dimension.
• RateDimension8Id: integer
  The unique identifier of the eighth dimension associated with the rate. Used only when the scorecard rate table has at least eight dimensions.
• RateDimension8Name: string
  Title: Name

  Read Only: true

  The name of the eighth dimension.
• RateDimension8TierId: integer
  The unique identifier of the tier for the eighth dimension associated with the rate.
• RateDimension8TierSequence: integer
  Title: Sequence

  Read Only: true

  The tier sequence number within the dimension.
• RateDimension9Id: integer
  The unique identifier of the ninth dimension associated with the rate. Used only when the scorecard rate table has at least nine dimensions.
• RateDimension9Name: string
  Title: Name

  Read Only: true

  The name of the ninth dimension.
• RateDimension9TierId: integer
  The unique identifier of the tier for the ninth dimension associated with the rate.
• RateDimension9TierSequence: integer
  Title: Sequence

  Read Only: true

  The tier sequence number within the dimension.
• ScorecardId: integer (int64)
  Read Only: true

  The unique identifier of the scorecard rate table associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
• ScorecardRateId: integer (int64)
  The unique identifier of the rate associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the participant rate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the participant rate is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the participant rate is last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the participant rate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantPerformanceMeasureScorecardId":{
            "type":"integer",
            "description":"The unique identifier of the scorecard rate table associated with the participant performance measure.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParticipantScorecardRateId":{
            "type":"integer",
            "description":"The unique identifier of the rate associated with the participant scorecard.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Rate":{
            "title":"Rate",
            "type":"number",
            "description":"The output value of the scorecard rate table is used to establish attainment rates or fixed amounts for different performance levels. This value is a percent or an amount depending on the rate table type set for the rate table. If the rate table type is percent, then the value stored here needs to be divided by 100 to get the actual value. For example, if the rate table type is percent and the rate value is 10%, then 10 is the output value.",
            "nullable":true,
            "x-queryable":true
        },
        "RateDimension10Id":{
            "type":"integer",
            "description":"The unique identifier of the tenth dimension associated with the rate. Used only when the scorecard rate table has ten dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ScorecardId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension10Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the tenth dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension10TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the tenth dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension10TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension1Id":{
            "type":"integer",
            "description":"The unique identifier of the first dimension associated with the rate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ScorecardId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension1Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the first dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension1TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the first dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension1TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension2Id":{
            "type":"integer",
            "description":"The unique identifier of the second dimension associated with the rate. Used only when the scorecard rate table has at least two dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ScorecardId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension2Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the second dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension2TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the second dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension2TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension3Id":{
            "type":"integer",
            "description":"The unique identifier of the third dimension associated with the rate. Used only when the scorecard rate table has at least three dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ScorecardId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension3Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the third dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension3TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the third dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension3TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension4Id":{
            "type":"integer",
            "description":"The unique identifier of the fourth dimension associated with the rate. Used only when the scorecard rate table has at least four dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ScorecardId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension4Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the fourth dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension4TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the fourth dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension4TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension5Id":{
            "type":"integer",
            "description":"The unique identifier of the fifth dimension associated with the rate. Used only when the scorecard rate table has at least five dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ScorecardId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension5Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the fifth dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension5TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the fifth dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension5TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension6Id":{
            "type":"integer",
            "description":"The unique identifier of the sixth dimension associated with the rate. Used only when the scorecard rate table has at least six dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ScorecardId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension6Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the sixth dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension6TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the sixth dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension6TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension7Id":{
            "type":"integer",
            "description":"The unique identifier of the seventh dimension associated with the rate. Used only when the scorecard rate table has at least seven dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ScorecardId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension7Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the seventh dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension7TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the seventh dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension7TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension8Id":{
            "type":"integer",
            "description":"The unique identifier of the eighth dimension associated with the rate. Used only when the scorecard rate table has at least eight dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ScorecardId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension8Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the eighth dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension8TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the eighth dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension8TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension9Id":{
            "type":"integer",
            "description":"The unique identifier of the ninth dimension associated with the rate. Used only when the scorecard rate table has at least nine dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ScorecardId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension9Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the ninth dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension9TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the ninth dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension9TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScorecardId":{
            "type":"integer",
            "description":"The unique identifier of the scorecard rate table associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ScorecardRateId":{
            "type":"integer",
            "description":"The unique identifier of the rate associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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"
    }
}

Links

ParticipantPerformanceMeasureGoals

Operation: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureGoals

Parameters:

• ParticipantPerformanceMeasureId: $request.path.ParticipantPerformanceMeasureId
• ParticipantPlanComponentId: $request.path.ParticipantPlanComponentId
• participantCompensationPlansUniqID: $request.path.participantCompensationPlansUniqID

The performance measure goals resource is used to view and update the total target of a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component. The total target defines the performance target across a timeline.

ParticipantPerformanceMeasureScorecards

Operation: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureScorecards

Parameters:

• ParticipantPerformanceMeasureId: $request.path.ParticipantPerformanceMeasureId
• ParticipantPlanComponentId: $request.path.ParticipantPlanComponentId
• participantCompensationPlansUniqID: $request.path.participantCompensationPlansUniqID

The performance measure scorecards resource is used to view the scorecards of a participant performance measure. A scorecard is used to establish attainment rates or fixed amounts for different performance levels.

Back to Top

Examples

The following example shows how to get a performance measure 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/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "ParticipantPerformanceMeasureId": 8024,
    "ParticipantPlanComponentId": 8010,
    "PlanComponentId": 100000015515786,
    "PerformanceMeasureId": 100000015115128,
    "PerformanceMeasureName": "All Product Sales Revenue Measure",
    "Description": null,
    "Weight": 100,
    "PerformanceInterval": "Period",
    "UnitOfMeasure": "AMOUNT",
    "StartDate": "2009-01-01",
    "EndDate": "2009-12-31",
    "TotalTarget": 480000,
    "CalculationSequence": 1,
    "EarningBasis": "Y",
    "UseExternalFormulaFlag": false,
    "IncludeInParticipantReportsFlag": true,
    "ProcessTransactions": "INDIVIDUAL",
    "RunningTotalFlag": false,
    "MeasureFormulaExpressionId": 300100081649772,
    "MeasureFormulaExpressionName": "Credit Amount Exp",
    "MeasureFormulaExpressionDescription": null,
    "NumberOfDimensions": null,
    "SplitOption": "NONE",
    "CreatedBy": "1",
    "CreationDate": "2010-01-22T05:12:18+00:00",
    "LastUpdateDate": "2010-01-22T05:12:18+00:00",
    "LastUpdatedBy": "1",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/participantCompensationPlans/CDRM_9/child/ParticipantPlanComponents/8010/child/ParticipantPlanComponentPerformanceMeasures/8024",
            "name": "ParticipantPlanComponentPerformanceMeasures",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/participantCompensationPlans/CDRM_9/child/ParticipantPlanComponents/8010/child/ParticipantPlanComponentPerformanceMeasures/8024",
            "name": "ParticipantPlanComponentPerformanceMeasures",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/participantCompensationPlans/CDRM_9/child/ParticipantPlanComponents/8010",
            "name": "ParticipantPlanComponents",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/participantCompensationPlans/CDRM_9/child/ParticipantPlanComponents/8010/child/ParticipantPlanComponentPerformanceMeasures/8024/child/ParticipantPerformanceMeasureGoals",
            "name": "ParticipantPerformanceMeasureGoals",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/participantCompensationPlans/CDRM_9/child/ParticipantPlanComponents/8010/child/ParticipantPlanComponentPerformanceMeasures/8024/child/ParticipantPerformanceMeasureScorecards",
            "name": "ParticipantPerformanceMeasureScorecards",
            "kind": "collection"
        },
        {
            "rel": "enclosure",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/participantCompensationPlans/CDRM_9/child/ParticipantPlanComponents/8010/child/ParticipantPlanComponentPerformanceMeasures/8024/enclosure/RenderedMeasureFormulaExpression",
            "name": "RenderedMeasureFormulaExpression",
            "kind": "other"
        }
    ]
}

Back to Top