Get an interval goal
get
/fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureGoals/{GoalId}/child/performanceMeasureIntervalGoals/{IntervalGoalId}
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.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
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 TopResponse
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.
Root Schema : incentiveCompensationPerformanceMeasures-performanceMeasureGoals-performanceMeasureIntervalGoals-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : incentiveCompensationPerformanceMeasures-performanceMeasureGoals-performanceMeasureIntervalGoals-performanceMeasurePeriodGoals-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- performanceMeasurePeriodGoals
-
Parameters:
- GoalId:
$request.path.GoalId
- IntervalGoalId:
$request.path.IntervalGoalId
- PerformanceMeasureId:
$request.path.PerformanceMeasureId
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. - GoalId:
Examples
The following example shows how to get an interval goal 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/300100090511019/child/performanceMeasureIntervalGoals/300100090511020
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "IntervalGoalId": 300100090511020, "GoalId": 300100090511019, "IntervalNumber": "2016001", "AlternateIntervalTarget1": 0, "AlternateIntervalTarget2": 0, "AlternateIntervalTarget3": 0, "AlternateIntervalTarget4": 0, "AlternateIntervalTarget5": 20, "IntervalTarget": 0, "IntervalTargetPercent": null, "AlternateIntervalTarget1Percent": null, "AlternateIntervalTarget2Percent": null, "AlternateIntervalTarget3Percent": null, "AlternateIntervalTarget4Percent": null, "AlternateIntervalTarget5Percent": null, "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "CreationDate": "2017-06-08T11:28:10.392-07:00", "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "LastUpdateDate": "2017-06-08T12:06:28-07:00", "LastUpdateLogin": "516E508C5BC4377FE0532DD6F00A0214", "PerformanceMeasureIntervalGoalDeleteFlag": false, "links": [ ... ] }