REST API for Oracle Fusion Cloud HCM

Create a value criteria range

post

/hcmRestApi/resources/11.13.18.05/payLocalizationCriteriaDefinitions/{payLocalizationCriteriaDefinitionsUniqID}/child/ValueCriteriaConditions/{ValueCriteriaConditionsUniqID}/child/ValueCriteriaRanges

Request

Path Parameters

ValueCriteriaConditionsUniqID(required): string

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

For example: ValueCriteriaConditions?q=LeafValueDefnId=<value1>;EffectiveStartDate=<value2>;EffectiveEndDate=<value3>
payLocalizationCriteriaDefinitionsUniqID(required): string

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

Effective-Of: string

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.
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.
Upsert-Mode: string

Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

EffectiveEndDate: string (date)

Effective end date of the value criteria range.
EffectiveStartDate: string (date)

Effective start date of the value criteria range.
HighValue: number

Upper bound of the range value.
LegislationCode: string

Maximum Length: 30

Legislation code associated with the range.
LegislativeDataGroupName: string

Maximum Length: 240

Legislative data group name associated with the range.
LowValue: number

Lower bound of the range value.
Name: string

Maximum Length: 120

Name of the value criteria range.
ParentValueDefnId: integer (int64)

Parent value definition identifier for the range.
RangeDefId: integer (int64)

Identifier of the range definition.
RangeEndDate: string (date)

End date applicable for the range.
RangeMode: string

Mode indicating how the range is interpreted.
RangeStartDate: string (date)

Start date applicable for the range.
ValueDefnId: integer (int64)

Value definition identifier associated with the range.
ValueGroupName: string

Maximum Length: 120

Value group name associated with the range.
ValueOne: string

Maximum Length: 60

Primary value associated with the range.
ValueThree: string

Maximum Length: 60

Tertiary value associated with the range.
ValueTwo: string

Maximum Length: 60

Secondary value associated with the range.
VBCEffectiveDate: string (date)

Value by criteria effective date for the range.

{
    "type":"object",
    "properties":{
        "EffectiveEndDate":{
            "type":"string",
            "description":"Effective end date of the value criteria range.",
            "format":"date",
            "nullable":false
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Effective start date of the value criteria range.",
            "format":"date",
            "nullable":false
        },
        "HighValue":{
            "type":"number",
            "description":"Upper bound of the range value.",
            "nullable":true,
            "x-hints":{
                "precision":32,
                "scale":15
            }
        },
        "LegislationCode":{
            "maxLength":30,
            "type":"string",
            "description":"Legislation code associated with the range.",
            "nullable":true
        },
        "LegislativeDataGroupName":{
            "maxLength":240,
            "type":"string",
            "description":"Legislative data group name associated with the range.",
            "nullable":true
        },
        "LowValue":{
            "type":"number",
            "description":"Lower bound of the range value.",
            "nullable":true,
            "x-hints":{
                "precision":32,
                "scale":15
            }
        },
        "Name":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the value criteria range.",
            "nullable":true
        },
        "ParentValueDefnId":{
            "type":"integer",
            "description":"Parent value definition identifier for the range.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RangeDefId":{
            "type":"integer",
            "description":"Identifier of the range definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "RangeEndDate":{
            "type":"string",
            "description":"End date applicable for the range.",
            "format":"date",
            "nullable":true
        },
        "RangeMode":{
            "type":"string",
            "description":"Mode indicating how the range is interpreted.",
            "nullable":true
        },
        "RangeStartDate":{
            "type":"string",
            "description":"Start date applicable for the range.",
            "format":"date",
            "nullable":true
        },
        "VBCEffectiveDate":{
            "type":"string",
            "description":"Value by criteria effective date for the range.",
            "format":"date",
            "nullable":true
        },
        "ValueDefnId":{
            "type":"integer",
            "description":"Value definition identifier associated with the range.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ValueGroupName":{
            "maxLength":120,
            "type":"string",
            "description":"Value group name associated with the range.",
            "nullable":true
        },
        "ValueOne":{
            "maxLength":60,
            "type":"string",
            "description":"Primary value associated with the range.",
            "nullable":true
        },
        "ValueThree":{
            "maxLength":60,
            "type":"string",
            "description":"Tertiary value associated with the range.",
            "nullable":true
        },
        "ValueTwo":{
            "maxLength":60,
            "type":"string",
            "description":"Secondary value associated with the range.",
            "nullable":true
        }
    }
}

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.

Root Schema : payLocalizationCriteriaDefinitions-ValueCriteriaConditions-ValueCriteriaRanges-item-response

Type: object

Show Source

EffectiveEndDate: string (date)

Effective end date of the value criteria range.
EffectiveStartDate: string (date)

Effective start date of the value criteria range.
HighValue: number

Upper bound of the range value.
LegislationCode: string

Maximum Length: 30

Legislation code associated with the range.
LegislativeDataGroupName: string

Maximum Length: 240

Legislative data group name associated with the range.
links: array Links

Title: Links

The link relations associated with the resource instance.
LowValue: number

Lower bound of the range value.
Name: string

Maximum Length: 120

Name of the value criteria range.
ParentValueDefnId: integer (int64)

Parent value definition identifier for the range.
RangeDefId: integer (int64)

Identifier of the range definition.
RangeEndDate: string (date)

End date applicable for the range.
RangeMode: string

Mode indicating how the range is interpreted.
RangeStartDate: string (date)

Start date applicable for the range.
ValueDefnId: integer (int64)

Value definition identifier associated with the range.
ValueGroupName: string

Maximum Length: 120

Value group name associated with the range.
ValueOne: string

Maximum Length: 60

Primary value associated with the range.
ValueThree: string

Maximum Length: 60

Tertiary value associated with the range.
ValueTwo: string

Maximum Length: 60

Secondary value associated with the range.
VBCEffectiveDate: string (date)

Value by criteria effective date for the range.

{
    "type":"object",
    "properties":{
        "EffectiveEndDate":{
            "type":"string",
            "description":"Effective end date of the value criteria range.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Effective start date of the value criteria range.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "HighValue":{
            "type":"number",
            "description":"Upper bound of the range value.",
            "nullable":true,
            "x-hints":{
                "precision":32,
                "scale":15
            },
            "x-queryable":true
        },
        "LegislationCode":{
            "maxLength":30,
            "type":"string",
            "description":"Legislation code associated with the range.",
            "nullable":true,
            "x-queryable":true
        },
        "LegislativeDataGroupName":{
            "maxLength":240,
            "type":"string",
            "description":"Legislative data group name associated with the range.",
            "nullable":true,
            "x-queryable":true
        },
        "LowValue":{
            "type":"number",
            "description":"Lower bound of the range value.",
            "nullable":true,
            "x-hints":{
                "precision":32,
                "scale":15
            },
            "x-queryable":true
        },
        "Name":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the value criteria range.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentValueDefnId":{
            "type":"integer",
            "description":"Parent value definition identifier for the range.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RangeDefId":{
            "type":"integer",
            "description":"Identifier of the range definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RangeEndDate":{
            "type":"string",
            "description":"End date applicable for the range.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RangeMode":{
            "type":"string",
            "description":"Mode indicating how the range is interpreted.",
            "nullable":true,
            "x-queryable":true
        },
        "RangeStartDate":{
            "type":"string",
            "description":"Start date applicable for the range.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "VBCEffectiveDate":{
            "type":"string",
            "description":"Value by criteria effective date for the range.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ValueDefnId":{
            "type":"integer",
            "description":"Value definition identifier associated with the range.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ValueGroupName":{
            "maxLength":120,
            "type":"string",
            "description":"Value group name associated with the range.",
            "nullable":true,
            "x-queryable":true
        },
        "ValueOne":{
            "maxLength":60,
            "type":"string",
            "description":"Primary value associated with the range.",
            "nullable":true,
            "x-queryable":true
        },
        "ValueThree":{
            "maxLength":60,
            "type":"string",
            "description":"Tertiary value associated with the range.",
            "nullable":true,
            "x-queryable":true
        },
        "ValueTwo":{
            "maxLength":60,
            "type":"string",
            "description":"Secondary value associated with the range.",
            "nullable":true,
            "x-queryable":true
        },
        "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."
        }
    }
}