Update a credit factor
/fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories/{PerformanceMeasureCreditCategoryId}/child/performanceMeasureCreditFactors/{PerformanceMeasureCreditFactorId}
Request
-
PerformanceMeasureCreditCategoryId(required): integer(int64)
The unique identifier representing the credit category for the performance measure.
-
PerformanceMeasureCreditFactorId(required): integer(int64)
The unique identifier of the credit factors for the performance measure.
-
PerformanceMeasureId(required): integer(int64)
The unique identifier for the performance measure.
-
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.
- application/json
object
-
CreditFactor: number
Title:
Credit Factor
Default Value:100
The percentage of uplift applied to transaction credits that is specified at the credit category level, for a period of time. Helps to boost the attainment for a period of time, for certain credit categories. The default value is 100. -
EarningFactor: number
Title:
Earning Factor
Default Value:100
The percentage of uplift applied to earnings that is specified at the credit category level, for a period of time. Helps to boost the earnings for a period of time, for certain credit categories. Default value is 100. -
EndDate: string
(date)
Title:
End Date
The date when the credit factor and earning factor provided for a credit category within a performance measure become inactive. The format is yyyy-mm-dd. -
PerformanceMeasureCreditCategoryId: integer
(int64)
The unique identifier of the credit category for the performance measure.
-
StartDate: string
(date)
Title:
Start Date
The date when the credit factor and earning factor provided for a credit category within a performance measure become active. The format is yyyy-mm-dd.
Response
- application/json
Default Response
-
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.
object
-
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. -
CreditFactor: number
Title:
Credit Factor
Default Value:100
The percentage of uplift applied to transaction credits that is specified at the credit category level, for a period of time. Helps to boost the attainment for a period of time, for certain credit categories. The default value is 100. -
EarningFactor: number
Title:
Earning Factor
Default Value:100
The percentage of uplift applied to earnings that is specified at the credit category level, for a period of time. Helps to boost the earnings for a period of time, for certain credit categories. Default value is 100. -
EndDate: string
(date)
Title:
End Date
The date when the credit factor and earning factor provided for a credit category within a performance measure become inactive. The format is yyyy-mm-dd. -
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. -
PerformanceMeasureCreditCategoryId: integer
(int64)
The unique identifier of the credit category for the performance measure.
-
PerformanceMeasureCreditFactorId: integer
(int64)
The unique identifier of the credit factors for the performance measure.
-
StartDate: string
(date)
Title:
Start Date
The date when the credit factor and earning factor provided for a credit category within a performance measure become active. The format is yyyy-mm-dd.
array
Links
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
The following example shows how to update a credit factor by submitting a PATCH request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X PATCH -d
@example_request_payload.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/300100090511017/child/performanceMeasureCreditCategories/300100090511047/child/performanceMeasureCreditFactors/300100090511048
Example of Request Body
The following example shows the contents of the request body in JSON format.
{ "StartDate": "2016-05-01", "EndDate": "2016-10-30" }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "PerformanceMeasureCreditFactorId": 300100090511048, "PerformanceMeasureCreditCategoryId": 300100090511047, "CreditFactor": 100, "EarningFactor": 100, "StartDate": "2016-05-01", "EndDate": "2016-10-30", "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "CreationDate": "2017-06-08T11:45:55-07:00", "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "LastUpdateDate": "2017-06-08T11:47:57-07:00", "LastUpdateLogin": "516E508C5BC4377FE0532DD6F00A0214", "links": [ ... ] }