Update an eligibility object result
patch
/hcmRestApi/resources/11.13.18.05/eligibilityObjectResults/{eligibilityObjectResultsUniqID}
Request
Path Parameters
-
eligibilityObjectResultsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Eligibility Object Results resource and used to uniquely identify an instance of Eligibility Object Results. The client should not generate the hash key value. Instead, the client should query on the Eligibility Object Results collection resource in order to navigate to a specific instance of Eligibility Object Results to get the hash key.
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
-
AssignmentId: integer
(int64)
Unique assignment identifier of the eligibility object result.
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
Effective end date for the eligibility object result. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Effective start date for the eligibility object result. -
EligibilityObjectId: integer
(int64)
Unique identifier of the eligibility object.
-
EligibilityObjectType: string
Title:
Eligibility Object Type
Maximum Length:30
Type of the eligibility object results object. -
EligibleFlag: boolean
Title:
Eligible
Maximum Length:1
Indicates whether the results are based on the eligible flag. The valid values are Y and N. It doesn't have a default value. -
IneligibleReasonCode: string
Title:
Ineligible Reason
Maximum Length:30
Ineligible reason code of the eligibility object result. -
OverrideFlag: boolean
Title:
Overridden
Maximum Length:30
Indicates whether the results are based on the override flag. The valid values are Y and N. The default value is N. -
OverrideThruDate: string
(date)
Title:
Override Through Date
Override through date of the eligibility object result. -
PersonId: integer
(int64)
Unique person identifier of the eligibility object result.
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 : eligibilityObjectResults-item-response
Type:
Show Source
object
-
AssignmentId: integer
(int64)
Unique assignment identifier of the eligibility object result.
-
AssignmentNumber: string
Title:
Assignment Number
Read Only:true
Maximum Length:30
Assignment number of the eligibility object result. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
Effective end date for the eligibility object result. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Effective start date for the eligibility object result. -
EligibilityObjectId: integer
(int64)
Unique identifier of the eligibility object.
-
EligibilityObjectType: string
Title:
Eligibility Object Type
Maximum Length:30
Type of the eligibility object results object. -
EligibilityResultId: integer
(int64)
Unique identifier of the eligibility object result.
-
EligibleFlag: boolean
Title:
Eligible
Maximum Length:1
Indicates whether the results are based on the eligible flag. The valid values are Y and N. It doesn't have a default value. -
IneligibleReasonCode: string
Title:
Ineligible Reason
Maximum Length:30
Ineligible reason code of the eligibility object result. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OverrideFlag: boolean
Title:
Overridden
Maximum Length:30
Indicates whether the results are based on the override flag. The valid values are Y and N. The default value is N. -
OverrideThruDate: string
(date)
Title:
Override Through Date
Override through date of the eligibility object result. -
PersonId: integer
(int64)
Unique person identifier of the eligibility object result.
-
PersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
Person number of the eligibility object result.
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: