Jump to

• Request
• Response

Update a period goal

patch

/fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureGoals/{GoalId}/child/performanceMeasureIntervalGoals/{IntervalGoalId}/child/performanceMeasurePeriodGoals/{PeriodGoalId}

Request

Path Parameters

• GoalId(required): integer(int64)
  The unique identifier for a goal record.
• IntervalGoalId(required): integer(int64)
  The unique identifier for the interval goal details.
• PerformanceMeasureId(required): integer(int64)
  The unique identifier for the performance measure.
• PeriodGoalId(required): integer(int64)
  The unique identifier for the period goal details.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root 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. The default value is 0.
• AlternatePeriodTarget1Percent: number
  Title: Alternate Period Target 1

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

  Default Value: 0

  The alternate period target number for a measure, for example, stretch goal for a period. The default value is 0.
• AlternatePeriodTarget2Percent: number
  Title: Alternate Period Target 2

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

  Default Value: 0

  The alternate period target number for a measure, for example, stretch goal for a period. The default value is 0.
• AlternatePeriodTarget3Percent: number
  Title: Alternate Period Target 3

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

  Default Value: 0

  The alternate period target number for a measure, for example, stretch goal for a period. The default value is 0.
• AlternatePeriodTarget4Percent: number
  Title: Alternate Period Target 4

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

  Default Value: 0

  The alternate period target number for a measure, for example, stretch goal for a period. The default value is 0.
• AlternatePeriodTarget5Percent: number
  Title: Alternate Period Target 5

  The alternate period target percentage for a measure, for example, stretch goal for a period.
• GoalId: integer (int64)
  The unique identifier for a goal.
• IntervalGoalId: integer (int64)
  The unique identifier for the interval goal details.
• PeriodTarget: number
  Title: Period Target

  Default Value: 0

  The period target number for a measure.
• PeriodTargetPercent: number
  Title: Period Target

  The period target percentage for a measure.

{
    "type":"object",
    "properties":{
        "AlternatePeriodTarget1":{
            "title":"Alternate Period Target 1",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period. The default value is 0.",
            "nullable":true,
            "default":0
        },
        "AlternatePeriodTarget1Percent":{
            "title":"Alternate Period Target 1",
            "type":"number",
            "description":"The alternate period target percentage for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "x-queryable":false
        },
        "AlternatePeriodTarget2":{
            "title":"Alternate Period Target 2",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period. The default value is 0.",
            "nullable":true,
            "default":0
        },
        "AlternatePeriodTarget2Percent":{
            "title":"Alternate Period Target 2",
            "type":"number",
            "description":"The alternate period target percentage for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "x-queryable":false
        },
        "AlternatePeriodTarget3":{
            "title":"Alternate Period Target 3",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period. The default value is 0.",
            "nullable":true,
            "default":0
        },
        "AlternatePeriodTarget3Percent":{
            "title":"Alternate Period Target 3",
            "type":"number",
            "description":"The alternate period target percentage for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "x-queryable":false
        },
        "AlternatePeriodTarget4":{
            "title":"Alternate Period Target 4",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period. The default value is 0.",
            "nullable":true,
            "default":0
        },
        "AlternatePeriodTarget4Percent":{
            "title":"Alternate Period Target 4",
            "type":"number",
            "description":"The alternate period target percentage for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "x-queryable":false
        },
        "AlternatePeriodTarget5":{
            "title":"Alternate Period Target 5",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period. The default value is 0.",
            "nullable":true,
            "default":0
        },
        "AlternatePeriodTarget5Percent":{
            "title":"Alternate Period Target 5",
            "type":"number",
            "description":"The alternate period target percentage for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "x-queryable":false
        },
        "GoalId":{
            "type":"integer",
            "description":"The unique identifier for a goal.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "IntervalGoalId":{
            "type":"integer",
            "description":"The unique identifier for the interval goal details.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PeriodTarget":{
            "title":"Period Target",
            "type":"number",
            "description":"The period target number for a measure.",
            "nullable":true,
            "default":0
        },
        "PeriodTargetPercent":{
            "title":"Period Target",
            "type":"number",
            "description":"The period target percentage for a measure.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 : incentiveCompensationPerformanceMeasures-performanceMeasureGoals-performanceMeasureIntervalGoals-performanceMeasurePeriodGoals-item-response

Type: object

Show Source

• AlternateITDTarget1: number
  Title: Alternate ITD Target 1

  Read Only: true

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

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

  Default Value: 0

  The alternate period target number for a measure, for example, stretch goal for a period. The default value is 0.
• AlternatePeriodTarget1Percent: number
  Title: Alternate Period Target 1

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

  Default Value: 0

  The alternate period target number for a measure, for example, stretch goal for a period. The default value is 0.
• AlternatePeriodTarget2Percent: number
  Title: Alternate Period Target 2

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

  Default Value: 0

  The alternate period target number for a measure, for example, stretch goal for a period. The default value is 0.
• AlternatePeriodTarget3Percent: number
  Title: Alternate Period Target 3

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

  Default Value: 0

  The alternate period target number for a measure, for example, stretch goal for a period. The default value is 0.
• AlternatePeriodTarget4Percent: number
  Title: Alternate Period Target 4

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

  Default Value: 0

  The alternate period target number for a measure, for example, stretch goal for a period. The default value is 0.
• AlternatePeriodTarget5Percent: number
  Title: Alternate Period Target 5

  The alternate period target percentage for a measure, for example, stretch goal for a period.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• GoalId: integer (int64)
  The unique identifier for a goal.
• IntervalGoalId: integer (int64)
  The unique identifier for the interval goal details.
• ITDTarget: number
  Title: ITD Target

  Read Only: true

  The Interval-to-date target number for a measure.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The session login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PerformanceMeasurePeriodGoalDeleteFlag: boolean
  Read Only: true

  Default Value: false

  Inidcates whether a performance measure period goal can be deleted.
• PeriodGoalId: integer (int64)
  The unique identifier for the period goal details.
• PeriodName: string
  Title: Period

  Read Only: true

  Maximum Length: 30

  The name for an interval of time defined in the calendar.
• PeriodTarget: number
  Title: Period Target

  Default Value: 0

  The period target number for a measure.
• PeriodTargetPercent: number
  Title: Period Target

  The period target percentage for a measure.

{
    "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,
            "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,
            "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,
            "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,
            "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,
            "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. The default value is 0.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "AlternatePeriodTarget1Percent":{
            "title":"Alternate Period Target 1",
            "type":"number",
            "description":"The alternate period target percentage for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "x-queryable":false
        },
        "AlternatePeriodTarget2":{
            "title":"Alternate Period Target 2",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period. The default value is 0.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "AlternatePeriodTarget2Percent":{
            "title":"Alternate Period Target 2",
            "type":"number",
            "description":"The alternate period target percentage for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "x-queryable":false
        },
        "AlternatePeriodTarget3":{
            "title":"Alternate Period Target 3",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period. The default value is 0.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "AlternatePeriodTarget3Percent":{
            "title":"Alternate Period Target 3",
            "type":"number",
            "description":"The alternate period target percentage for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "x-queryable":false
        },
        "AlternatePeriodTarget4":{
            "title":"Alternate Period Target 4",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period. The default value is 0.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "AlternatePeriodTarget4Percent":{
            "title":"Alternate Period Target 4",
            "type":"number",
            "description":"The alternate period target percentage for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "x-queryable":false
        },
        "AlternatePeriodTarget5":{
            "title":"Alternate Period Target 5",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period. The default value is 0.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "AlternatePeriodTarget5Percent":{
            "title":"Alternate Period Target 5",
            "type":"number",
            "description":"The alternate period target percentage for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalId":{
            "type":"integer",
            "description":"The unique identifier for a goal.",
            "format":"int64",
            "nullable":false,
            "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,
            "x-queryable":true
        },
        "IntervalGoalId":{
            "type":"integer",
            "description":"The unique identifier for the interval goal details.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PerformanceMeasurePeriodGoalDeleteFlag":{
            "type":"boolean",
            "description":"Inidcates whether a performance measure period goal can be deleted.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "PeriodGoalId":{
            "type":"integer",
            "description":"The unique identifier for the period goal details.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodName":{
            "title":"Period",
            "maxLength":30,
            "type":"string",
            "description":"The name for an interval of time defined in the calendar.",
            "nullable":false,
            "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
        },
        "PeriodTargetPercent":{
            "title":"Period Target",
            "type":"number",
            "description":"The period target percentage for a measure.",
            "nullable":true,
            "x-queryable":false
        },
        "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 : 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."
        }
    }
}

Back to Top