Jump to

• Request
• Response
• Examples

Get all goals

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureGoals

Request

Path Parameters

• PerformanceMeasureId(required): integer(int64)
  The unique identifier for the performance measure.

Query Parameters

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

  • PrimaryKey: Finds a resource with the specified primary key.
    Finder Variables:
    • GoalId; integer; The unique identifier for a goal record.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AlternateGoalTarget1; number; The alternate target number for a measure, for example, stretch goal.
  • AlternateGoalTarget2; number; The alternate target number for a measure, for example, stretch goal.
  • AlternateGoalTarget3; number; The alternate target number for a measure, for example, stretch goal.
  • AlternateGoalTarget4; number; The alternate target number for a measure, for example, stretch goal.
  • AlternateGoalTarget5; number; The alternate target number for a measure, for example, stretch goal.
  • CreatedBy; string; The user who created the record.
  • CreationDate; string; The date and time when the record was created.
  • GoalId; integer; The unique identifier for a goal record.
  • GoalInterval; string; The span of time to specify the goal information. This interval is same as the corresponding performance (measure) interval. To get this value, describe the resource and use the finder listed to get all possible values.
  • GoalTarget; number; The expected level of attainment assigned to a participant for each measure for the year, which may be divided into different intervals.
  • IntervalDistribution; string; The display value for the goal number distributed across the intervals.
  • LastUpdateDate; string; The date and time when the record was last updated.
  • LastUpdateLogin; string; The session login of the user who last updated the record.
  • LastUpdatedBy; string; The user who last updated the record.
  • UnitOfMeasure; string; The standardized quantity used as a factor to express occurring quantities of the goal property. Possible values include AMOUNT for Revenue-based goal and QUANTITY for Quantity-based goal. The default value is AMOUNT. A list of acceptable values is defined in the lookup CN_GOAL_UOM. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

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

There's no request body for this operation.

Back to 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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationPerformanceMeasures-performanceMeasureGoals-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object incentiveCompensationPerformanceMeasures-performanceMeasureGoals-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationPerformanceMeasures-performanceMeasureGoals-item-response"
    }
}

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

Type: object

Show Source

• AlternateGoalTarget1: number
  Title: Alternate Target 1

  Read Only: true

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

  The date and time when the record was created.
• DistributeEvenlyFlag: boolean
  Indicates if the target amount evenly to the interval targets and period targets, the possible values are TRUE and FALSE.
• GoalDistributionType: string
  Title: Distribute By

  The goal target or alternate goal targets are distributed by amount or percent. Although only distribute by Amount is allowed for now, it has two possible values which are AMOUNT to distribute the goal in numbers for each interval and period, and PERCENT to distribute the goal as a percentage of the annual number for each interval and period. A list of acceptable values is defined in the lookup CN_GOAL_DISTRIBUTE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• GoalId: integer (int64)
  The unique identifier for a goal record.
• GoalInterval: string
  Title: Goal Interval

  Read Only: true

  The span of time to specify the goal information. This interval is same as the corresponding performance (measure) interval. To get this value, describe the resource and use the finder listed to get all possible values.
• GoalTarget: number
  Title: Target

  The expected level of attainment assigned to a participant for each measure for the year, which may be divided into different intervals.
• IntervalDistribution: string
  Read Only: true

  The display value for the goal number distributed across the intervals.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

  Maximum Length: 32

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

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

  Default Value: false

  Indicates whether a goal can be deleted.
• performanceMeasureIntervalGoals: array Interval Goals
  Title: Interval Goals

  The Interval Goals resource is used to view and update the target or the goal values at each interval. It can also be used to display all details of the goals across intervals. This is created when creating a Performance Measure with a default value of 0.
• RecalculateFlag: boolean
  Indicates if all period values to the respective interval and interval to date (ITD) are summed up and if all interval values to the respective total target goal values are summed up. This replaces any interval, ITD and total target goal values. Also this cannot be TRUE if the goal distribution type value is Percentage. This also applies to all alternate goals.
• UnitOfMeasure: string
  Title: Unit of Measure

  Maximum Length: 30

  Default Value: AMOUNT

  The standardized quantity used as a factor to express occurring quantities of the goal property. Possible values include AMOUNT for Revenue-based goal and QUANTITY for Quantity-based goal. The default value is AMOUNT. A list of acceptable values is defined in the lookup CN_GOAL_UOM. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated 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
        },
        "GoalInterval":{
            "title":"Goal Interval",
            "type":"string",
            "description":"The span of time to specify the goal information. This interval is same as the corresponding performance (measure) interval. To get this value, describe the resource and use the finder listed to get all possible values.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":"30",
            "type":"string",
            "description":"The standardized quantity used as a factor to express occurring quantities of the goal property. Possible values include AMOUNT for Revenue-based goal and QUANTITY for Quantity-based goal. The default value is AMOUNT. A list of acceptable values is defined in the lookup CN_GOAL_UOM. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "default":"AMOUNT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "GoalTarget":{
            "title":"Target",
            "type":"number",
            "description":"The expected level of attainment assigned to a participant for each measure for the year, which may be divided into different intervals.",
            "nullable":true,
            "x-queryable":true
        },
        "GoalDistributionType":{
            "title":"Distribute By",
            "type":"string",
            "description":"The goal target or alternate goal targets are distributed by amount or percent. Although only distribute by Amount is allowed for now, it has two possible values which are AMOUNT to distribute the goal in numbers for each interval and period, and PERCENT to distribute the goal as a percentage of the annual number for each interval and period. A list of acceptable values is defined in the lookup CN_GOAL_DISTRIBUTE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DistributeEvenlyFlag":{
            "type":"boolean",
            "description":"Indicates if the target amount evenly to the interval targets and period targets, the possible values are TRUE and FALSE.",
            "nullable":true,
            "x-queryable":false
        },
        "performanceMeasureIntervalGoals":{
            "title":"Interval Goals",
            "type":"array",
            "description":"The Interval Goals resource is used to view and update the target or the goal values at each interval. It can also be used to display all details of the goals across intervals. \nThis is created when creating a Performance Measure with a default value of 0.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationPerformanceMeasures-performanceMeasureGoals-performanceMeasureIntervalGoals-item-response"
            }
        },
        "RecalculateFlag":{
            "type":"boolean",
            "description":"Indicates if all period values to the respective interval and interval to date (ITD) are summed up and if all interval values to the respective total target goal values are summed up. This replaces any interval, ITD and total target goal values. Also this cannot be TRUE if the goal distribution type value is Percentage. This also applies to all alternate goals.",
            "nullable":true,
            "x-queryable":false
        },
        "AlternateGoalTarget3":{
            "title":"Alternate Target 3",
            "type":"number",
            "description":"The alternate target number for a measure, for example, stretch goal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateGoalTarget2":{
            "title":"Alternate Target 2",
            "type":"number",
            "description":"The alternate target number for a measure, for example, stretch goal.",
            "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"
            }
        },
        "AlternateGoalTarget5":{
            "title":"Alternate Target 5",
            "type":"number",
            "description":"The alternate target number for a measure, for example, stretch goal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateGoalTarget4":{
            "title":"Alternate Target 4",
            "type":"number",
            "description":"The alternate target number for a measure, for example, stretch goal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PerformanceMeasureGoalDeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether a goal can be deleted.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "AlternateGoalTarget1":{
            "title":"Alternate Target 1",
            "type":"number",
            "description":"The alternate target number for a measure, for example, stretch goal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntervalDistribution":{
            "type":"string",
            "description":"The display value for the goal number distributed across the intervals.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalId":{
            "type":"integer",
            "description":"The unique identifier for a goal record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "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 Interval Goals resource is used to view and update the target or the goal values at each interval. It can also be used to display all details of the goals across intervals. This is created when creating a Performance Measure with a default value of 0.

Show Source

• Array of: object incentiveCompensationPerformanceMeasures-performanceMeasureGoals-performanceMeasureIntervalGoals-item-response

{
    "title":"Interval Goals",
    "type":"array",
    "description":"The Interval Goals resource is used to view and update the target or the goal values at each interval. It can also be used to display all details of the goals across intervals. \nThis is created when creating a Performance Measure with a default value of 0.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationPerformanceMeasures-performanceMeasureGoals-performanceMeasureIntervalGoals-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 : incentiveCompensationPerformanceMeasures-performanceMeasureGoals-performanceMeasureIntervalGoals-item-response

Type: object

Show Source

• AlternateIntervalTarget1: number
  Title: Alternate Interval Target 1

  Default Value: 0

  The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0.
• AlternateIntervalTarget1Percent: number
  Title: Alternate Interval Target 1

  The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target.
• AlternateIntervalTarget2: number
  Title: Alternate Interval Target 2

  Default Value: 0

  The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0.
• AlternateIntervalTarget2Percent: number
  Title: Alternate Interval Target 2

  The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target.
• AlternateIntervalTarget3: number
  Title: Alternate Interval Target 3

  Default Value: 0

  The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0.
• AlternateIntervalTarget3Percent: number
  Title: Alternate Interval Target 3

  The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target.
• AlternateIntervalTarget4: number
  Title: Alternate Interval Target 4

  Default Value: 0

  The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0.
• AlternateIntervalTarget4Percent: number
  Title: Alternate Interval Target 4

  The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target.
• AlternateIntervalTarget5: number
  Title: Alternate Interval Target 5

  Default Value: 0

  The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0.
• AlternateIntervalTarget5Percent: number
  Title: Alternate Interval Target 5

  The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

  The date and time when the record was created.
• GoalId: integer (int64)
  The unique identifier for a goal record.
• IntervalGoalId: integer (int64)
  The unique identifier for the interval goal details.
• IntervalNumber: string
  Title: Period

  Maximum Length: 80

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

  Read Only: true

  Default Value: 0

  The target number specified for the goal interval. The default value is 0.
• IntervalTargetPercent: number
  Title: Interval Target

  Read Only: true

  The target percentage specified for the goal interval.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

  Maximum Length: 32

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

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

  Default Value: false

  Indicates whether a performance measure interval goal can be deleted.
• performanceMeasurePeriodGoals: array Period Goals
  Title: Period Goals

  The Period Goals resource is used to view and update the target or the goal values at each period. It can also be used to display all details of the goals across periods. This is created when creating a Performance Measure with a default value of 0. This needs to be updated later if needed.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated 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
        },
        "PerformanceMeasureIntervalGoalDeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether a performance measure interval goal can be deleted.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "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
        },
        "performanceMeasurePeriodGoals":{
            "title":"Period Goals",
            "type":"array",
            "description":"The Period Goals resource is used to view and update the target or the goal values at each period. It can also be used to display all details of the goals across periods. \nThis is created when creating a Performance Measure with a default value of 0. This needs to be updated later if needed.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationPerformanceMeasures-performanceMeasureGoals-performanceMeasureIntervalGoals-performanceMeasurePeriodGoals-item-response"
            }
        },
        "IntervalTarget":{
            "title":"Interval Target",
            "type":"number",
            "description":"The target number specified for the goal interval. The default value is 0.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":true
        },
        "AlternateIntervalTarget1":{
            "title":"Alternate Interval Target 1",
            "type":"number",
            "description":"The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "AlternateIntervalTarget2Percent":{
            "title":"Alternate Interval Target 2",
            "type":"number",
            "description":"The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target.",
            "nullable":true,
            "x-queryable":false
        },
        "AlternateIntervalTarget3Percent":{
            "title":"Alternate Interval Target 3",
            "type":"number",
            "description":"The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target.",
            "nullable":true,
            "x-queryable":false
        },
        "AlternateIntervalTarget2":{
            "title":"Alternate Interval Target 2",
            "type":"number",
            "description":"The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "AlternateIntervalTarget3":{
            "title":"Alternate Interval Target 3",
            "type":"number",
            "description":"The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "IntervalTargetPercent":{
            "title":"Interval Target",
            "type":"number",
            "description":"The target percentage specified for the goal interval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AlternateIntervalTarget4":{
            "title":"Alternate Interval Target 4",
            "type":"number",
            "description":"The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "AlternateIntervalTarget5":{
            "title":"Alternate Interval Target 5",
            "type":"number",
            "description":"The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "AlternateIntervalTarget1Percent":{
            "title":"Alternate Interval Target 1",
            "type":"number",
            "description":"The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target.",
            "nullable":true,
            "x-queryable":false
        },
        "AlternateIntervalTarget4Percent":{
            "title":"Alternate Interval Target 4",
            "type":"number",
            "description":"The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target.",
            "nullable":true,
            "x-queryable":false
        },
        "AlternateIntervalTarget5Percent":{
            "title":"Alternate Interval Target 5",
            "type":"number",
            "description":"The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IntervalGoalId":{
            "type":"integer",
            "description":"The unique identifier for the interval goal details.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "IntervalNumber":{
            "title":"Period",
            "maxLength":"80",
            "type":"string",
            "description":"The display value of the interval.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalId":{
            "type":"integer",
            "description":"The unique identifier for a goal record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "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 : Period Goals

Type: array

Title: Period Goals

The Period Goals resource is used to view and update the target or the goal values at each period. It can also be used to display all details of the goals across periods. This is created when creating a Performance Measure with a default value of 0. This needs to be updated later if needed.

Show Source

• Array of: object incentiveCompensationPerformanceMeasures-performanceMeasureGoals-performanceMeasureIntervalGoals-performanceMeasurePeriodGoals-item-response

{
    "title":"Period Goals",
    "type":"array",
    "description":"The Period Goals resource is used to view and update the target or the goal values at each period. It can also be used to display all details of the goals across periods. \nThis is created when creating a Performance Measure with a default value of 0. This needs to be updated later if needed.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationPerformanceMeasures-performanceMeasureGoals-performanceMeasureIntervalGoals-performanceMeasurePeriodGoals-item-response"
    }
}

Nested 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":{
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "PeriodTargetPercent":{
            "title":"Period Target",
            "type":"number",
            "description":"The period target percentage for a measure.",
            "nullable":true,
            "x-queryable":false
        },
        "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
        },
        "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
        },
        "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,
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "GoalId":{
            "type":"integer",
            "description":"The unique identifier for a goal.",
            "format":"int64",
            "nullable":false,
            "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. The default value is 0.",
            "nullable":true,
            "default":"0",
            "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
        },
        "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "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
        },
        "IntervalGoalId":{
            "type":"integer",
            "description":"The unique identifier for the interval 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
        },
        "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
        }
    }
}

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

Back to Top

Examples

The following example shows how to get all goals by submitting a GET request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/300100090511017/child/performanceMeasureGoals

Example of Response Body

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

{
  "items": [
    {
      "GoalId": 300100090511019,
      "UnitOfMeasure": "AMOUNT",
      "GoalDistributionType": null,
      "AlternateGoalTarget1": null,
      "AlternateGoalTarget2": null,
      "AlternateGoalTarget3": null,
      "AlternateGoalTarget4": null,
      "AlternateGoalTarget5": null,
      "DistributeEvenlyFlag": null,
      "GoalTarget": 200000,
      "GoalInterval": "Period",
      "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
      "CreationDate": "2017-06-08T11:28:10.377-07:00",
      "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
      "LastUpdateDate": "2017-06-15T02:41:38-07:00",
      "LastUpdateLogin": "51D1768B21CC7C69E0532DD6F00A1A9F",
      "RecalculateFlag": null,
      "PerformanceMeasureGoalDeleteFlag": false,
      "IntervalDistribution": "Period",
      "links": [
       ...
      ]
    }
  ,...
  ]
}

Back to Top