1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Value Defined by Criteria Definition Root

Update a specific Value Criteria Definition

patch

/hcmRestApi/resources/11.13.18.05/payLocalizationCriteriaDefinitions/{payLocalizationCriteriaDefinitionsUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key--- ValueDefnId, EffectiveStartDate and EffectiveEndDate ---for the Value Defined by Criteria Definition Root resource and used to uniquely identify an instance of Value Defined by Criteria Definition Root. The client should not generate the hash key value. Instead, the client should query on the Value Defined by Criteria Definition Root collection resource with a filter on the primary key values in order to navigate to a specific instance of Value Defined by Criteria Definition Root.

    For example: payLocalizationCriteriaDefinitions?q=ValueDefnId=<value1>;EffectiveStartDate=<value2>;EffectiveEndDate=<value3>
Header Parameters
  • This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Values Defined by Criteria Conditions
Type: array
Title: Values Defined by Criteria Conditions
The Value Criteria Conditions resource represents flattened criteria combinations for a given definition.
Show Source
Nested Schema : payLocalizationCriteriaDefinitions-ValueCriteriaConditions-item-patch-request
Type: object
Show Source
Nested Schema : Value Defined by Criteria Range Values
Type: array
Title: Value Defined by Criteria Range Values
The value by criteria ranges resource represents the range values associated with each criteria combination.
Show Source
Nested Schema : payLocalizationCriteriaDefinitions-ValueCriteriaConditions-ValueCriteriaRanges-item-patch-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : payLocalizationCriteriaDefinitions-item-response
Type: object
Show Source
Nested Schema : Values Defined by Criteria Conditions
Type: array
Title: Values Defined by Criteria Conditions
The Value Criteria Conditions resource represents flattened criteria combinations for a given definition.
Show Source
Nested Schema : payLocalizationCriteriaDefinitions-ValueCriteriaConditions-item-response
Type: object
Show Source
Nested Schema : Value Defined by Criteria Range Values
Type: array
Title: Value Defined by Criteria Range Values
The value by criteria ranges resource represents the range values associated with each criteria combination.
Show Source
Nested Schema : payLocalizationCriteriaDefinitions-ValueCriteriaConditions-ValueCriteriaRanges-item-response
Type: object
Show Source
Links
ValueCriteriaConditions
Parameters:
  • payLocalizationCriteriaDefinitionsUniqID: $request.path.payLocalizationCriteriaDefinitionsUniqID
The Value Criteria Conditions resource represents flattened criteria combinations for a given definition.
Back to Top