Update an eligibility object
patch
/hcmRestApi/resources/11.13.18.05/eligibilityObjects/{eligibilityObjectsUniqID}
Request
Path Parameters
-
eligibilityObjectsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- EligibilityObjectId, EffectiveStartDate and EffectiveEndDate ---for the Eligibility Objects resource and used to uniquely identify an instance of Eligibility Objects. The client should not generate the hash key value. Instead, the client should query on the Eligibility Objects collection resource with a filter on the primary key values in order to navigate to a specific instance of Eligibility Objects.
For example: eligibilityObjects?q=EligibilityObjectId=<value1>;EffectiveStartDate=<value2>;EffectiveEndDate=<value3>
Header Parameters
-
Effective-Of:
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:
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
eligibilityObjectProfiles: array
Eligibility Object Profiles
Title:
Eligibility Object Profiles
The eligibilityObjectProfiles resource provides the list of eligibility profiles for a worker. -
EligibilityObjectType: string
Title:
Eligibility Object Type
Maximum Length:30
Name of the eligibility object type. -
SourceObjectKey: string
Title:
Source Object Key
Maximum Length:30
Key for the source object. -
SourceObjectName: string
Title:
Source Object Name
Maximum Length:30
Name of the source object. -
SourceObjectValue: string
Title:
Source Object Value
Maximum Length:30
Value of the source object.
Nested Schema : Eligibility Object Profiles
Type:
array
Title:
Eligibility Object Profiles
The eligibilityObjectProfiles resource provides the list of eligibility profiles for a worker.
Show Source
Nested Schema : eligibilityObjects-eligibilityObjectProfiles-item-patch-request
Type:
Show Source
object
-
EffectiveEndDate: string
(date)
Effective end date for the eligibility object profile.
-
EffectiveStartDate: string
(date)
Effective start date for the eligibility object profile.
-
EligibilityObjectId: integer
(int64)
Unique identifier of the eligibility object.
-
EligibilityProfileId: integer
(int64)
Unique identifier of the eligibility profile.
-
MandatoryFlag: boolean
Maximum Length:
1
Indicates whether the task is mandatory or optional. The valid values are Y and N. The default value is N.
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 : eligibilityObjects-item-response
Type:
Show Source
object
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
Effective end date for the eligibility object. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Effective start date for the eligibility object. -
EligibilityObjectId: integer
(int64)
Unique identifier of the eligibility object.
-
eligibilityObjectProfiles: array
Eligibility Object Profiles
Title:
Eligibility Object Profiles
The eligibilityObjectProfiles resource provides the list of eligibility profiles for a worker. -
EligibilityObjectType: string
Title:
Eligibility Object Type
Maximum Length:30
Name of the eligibility object type. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SourceObjectKey: string
Title:
Source Object Key
Maximum Length:30
Key for the source object. -
SourceObjectName: string
Title:
Source Object Name
Maximum Length:30
Name of the source object. -
SourceObjectValue: string
Title:
Source Object Value
Maximum Length:30
Value of the source object.
Nested Schema : Eligibility Object Profiles
Type:
array
Title:
Eligibility Object Profiles
The eligibilityObjectProfiles resource provides the list of eligibility profiles for a worker.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : eligibilityObjects-eligibilityObjectProfiles-item-response
Type:
Show Source
object
-
EffectiveEndDate: string
(date)
Effective end date for the eligibility object profile.
-
EffectiveStartDate: string
(date)
Effective start date for the eligibility object profile.
-
EligibilityObjectId: integer
(int64)
Unique identifier of the eligibility object.
-
EligibilityObjectProfileId: integer
(int64)
Unique identifier of the eligibility object profile.
-
EligibilityProfileId: integer
(int64)
Unique identifier of the eligibility profile.
-
EligibilityProfileName: string
Title:
Name
Read Only:true
Maximum Length:240
Name of the eligibility object profile. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MandatoryFlag: boolean
Maximum Length:
1
Indicates whether the task is mandatory or optional. The valid values are Y and N. The default value is N.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.
Links
- BenEligObjectVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DBEN_ELIG_OBJ_TYPE%2CLookupCode%3D{EligibilityObjectType}
The following properties are defined on the LOV link relation:- Source Attribute: EligibilityObjectType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- eligibilityObjectProfiles
-
Parameters:
- eligibilityObjectsUniqID:
$request.path.eligibilityObjectsUniqID
The eligibilityObjectProfiles resource provides the list of eligibility profiles for a worker. - eligibilityObjectsUniqID: