Jump to

• Request
• Response

Update a performance measure goal

patch

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

Request

Path Parameters

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

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

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.
• 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.
• GoalTarget: number
  Title: Total Target

  Default Value: 0

  The expected level of attainment assigned to the participant for the 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.

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "GoalTarget":{
            "title":"Total Target",
            "type":"number",
            "description":"The expected level of attainment assigned to the participant for the measure.",
            "nullable":true,
            "default":"0"
        },
        "AlternateTarget1":{
            "title":"Alternate Target 1",
            "type":"number",
            "description":"The alternate target number for a measure, for example, stretch goal.",
            "nullable":true,
            "default":"0"
        },
        "AlternateTarget2":{
            "title":"Alternate Target 2",
            "type":"number",
            "description":"The alternate target number for a measure, for example, stretch goal.",
            "nullable":true,
            "default":"0"
        },
        "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-patch-request"
            }
        },
        "AlternateTarget3":{
            "title":"Alternate Target 3",
            "type":"number",
            "description":"The alternate target number for a measure, for example, stretch goal.",
            "nullable":true,
            "default":"0"
        },
        "AlternateTarget4":{
            "title":"Alternate Target 4",
            "type":"number",
            "description":"The alternate target number for a measure, for example, stretch goal.",
            "nullable":true,
            "default":"0"
        },
        "AlternateTarget5":{
            "title":"Alternate Target 5",
            "type":"number",
            "description":"The alternate target number for a measure, for example, stretch goal.",
            "nullable":true,
            "default":"0"
        },
        "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-patch-request"
            }
        }
    }
}

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-patch-request

{
    "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-patch-request"
    }
}

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 schema

{
    "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-patch-request"
    }
}

Nested Schema : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-ParticipantGoalIntervalGoals-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : schema

Type: object

Show Source

• AlternatePeriodTarget1: number
  Title: Alternate Period Target 1

  Default Value: 0

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

  Default Value: 0

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

  Default Value: 0

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

  Default Value: 0

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

  Default Value: 0

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

  Default Value: 0

  The period target number for a measure.

{
    "type":"object",
    "properties":{
        "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"
        },
        "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"
        },
        "PeriodTarget":{
            "title":"Period Target",
            "type":"number",
            "description":"The period target number for a measure.",
            "nullable":true,
            "default":"0"
        },
        "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"
        },
        "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"
        },
        "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"
        }
    }
}

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-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":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated 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
        },
        "PerformanceMeasureName":{
            "title":"Name",
            "type":"string",
            "description":"The name of the performance measure.",
            "nullable":true,
            "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
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the participant performance measure goal.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "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
        },
        "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"
            }
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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"
            }
        },
        "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
        },
        "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
        }
    }
}

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 : 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-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":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated 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
        },
        "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
        },
        "ParticipantGoalId":{
            "type":"integer",
            "description":"The unique identifier of the goal.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the interval goal.",
            "nullable":false,
            "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "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
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the interval is last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : 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":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the period goal is created.",
            "format":"date-time",
            "nullable":false,
            "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
        },
        "PeriodEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the period of time ends.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "ParticipantPeriodGoalId":{
            "type":"integer",
            "description":"The unique identifier of the period goal.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "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
        },
        "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
        },
        "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
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the period goal.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created 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
        },
        "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
        },
        "PeriodTarget":{
            "title":"Period Target",
            "type":"number",
            "description":"The period target number for a measure.",
            "nullable":true,
            "default":"0",
            "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
        },
        "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
        },
        "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
        },
        "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
        }
    }
}

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

ParticipantGoalIntervalGoals

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

Parameters:

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

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

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

Parameters:

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

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.

Back to Top