Update a payroll relationship flexfields
patch
/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/PayRelationshipsDDF/{PayRelationshipsDDFUniqID}
Request
Path Parameters
-
PayRelationshipsDDFUniqID(required): string
This is the hash key of the attributes which make up the composite key--- PayrollRelationshipId, EffectiveStartDate and EffectiveEndDate ---for the Payroll Relationships Developer Descriptive Flexfields resource and used to uniquely identify an instance of Payroll Relationships Developer Descriptive Flexfields. The client should not generate the hash key value. Instead, the client should query on the Payroll Relationships Developer Descriptive Flexfields collection resource with a filter on the primary key values in order to navigate to a specific instance of Payroll Relationships Developer Descriptive Flexfields.
For example: PayRelationshipsDDF?q=PayrollRelationshipId=<value1>;EffectiveStartDate=<value2>;EffectiveEndDate=<value3> -
payrollRelationshipsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Payroll Relationships resource and used to uniquely identify an instance of Payroll Relationships. The client should not generate the hash key value. Instead, the client should query on the Payroll Relationships collection resource in order to navigate to a specific instance of Payroll Relationships to get the hash key.
Header Parameters
-
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 : Discriminator: __FLEX_Context
Type:
object
Discriminator: __FLEX_Context
Discriminator Values
Match One Schema
Show Source
-
AE -
object
oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFAEVO-item-patch-request
-
SA -
object
oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFSAVO-item-patch-request
-
US -
object
oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFUSVO-item-patch-request
Nested Schema : oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFAEVO-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
Default Value:AE
Context of the payroll relationship's descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
_ACCOMMODATION_PROVIDED: string
Title:
Accommodation Provided
Maximum Length:150
-
_ACCOMMODATION_PROVIDED_Display: string
Title:
Accommodation Provided
-
_ORA_HRX_AE_MOL_EMPLOYEE_ID: string
Title:
MOHRE Employee ID
Maximum Length:150
-
_ORA_HRX_AE_WPS_ACCOUNT_NUMBER: string
Title:
WPS Account Number
Maximum Length:150
-
_TRANSPORTATION_PROVIDED: string
Title:
Transportation Provided
Maximum Length:150
-
_TRANSPORTATION_PROVIDED_Display: string
Title:
Transportation Provided
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
Date at the end of the date range within which the payroll relationship is effective. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Date at the beginning of the date range within which the payroll relationship is effective. -
wpsAgentEmployeeId: string
Title:
WPS Agent Employee ID
Maximum Length:150
Nested Schema : oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFSAVO-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
Default Value:SA
Context of the payroll relationship's descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
_ACCOMMODATION_PROVIDED: string
Title:
Accommodation Provided
Maximum Length:150
-
_ACCOMMODATION_PROVIDED_Display: string
Title:
Accommodation Provided
-
_TRANSPORTATION_PROVIDED: string
Title:
Transportation Provided
Maximum Length:150
-
_TRANSPORTATION_PROVIDED_Display: string
Title:
Transportation Provided
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
Date at the end of the date range within which the payroll relationship is effective. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Date at the beginning of the date range within which the payroll relationship is effective.
Nested Schema : oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFUSVO-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
Default Value:US
Context of the payroll relationship's descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
Date at the end of the date range within which the payroll relationship is effective. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Date at the beginning of the date range within which the payroll relationship is effective. -
overtimeStatus: string
Title:
Overtime Status
Maximum Length:150
-
overtimeStatus_Display: string
Title:
Overtime Status
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : Discriminator: __FLEX_Context
Type:
object
Discriminator: __FLEX_Context
Discriminator Values
Match One Schema
Show Source
-
AE -
object
oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFAEVO-item-response
-
SA -
object
oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFSAVO-item-response
-
US -
object
oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFUSVO-item-response
Nested Schema : oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFAEVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
Default Value:AE
Context of the payroll relationship's descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
_ACCOMMODATION_PROVIDED: string
Title:
Accommodation Provided
Maximum Length:150
-
_ACCOMMODATION_PROVIDED_Display: string
Title:
Accommodation Provided
-
_ORA_HRX_AE_MOL_EMPLOYEE_ID: string
Title:
MOHRE Employee ID
Maximum Length:150
-
_ORA_HRX_AE_WPS_ACCOUNT_NUMBER: string
Title:
WPS Account Number
Maximum Length:150
-
_TRANSPORTATION_PROVIDED: string
Title:
Transportation Provided
Maximum Length:150
-
_TRANSPORTATION_PROVIDED_Display: string
Title:
Transportation Provided
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
Date at the end of the date range within which the payroll relationship is effective. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Date at the beginning of the date range within which the payroll relationship is effective. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PayrollRelationshipId: integer
(int64)
Unique identifier used to retrieve the payroll relationship.
-
wpsAgentEmployeeId: string
Title:
WPS Agent Employee ID
Maximum Length:150
Nested Schema : oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFSAVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
Default Value:SA
Context of the payroll relationship's descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
_ACCOMMODATION_PROVIDED: string
Title:
Accommodation Provided
Maximum Length:150
-
_ACCOMMODATION_PROVIDED_Display: string
Title:
Accommodation Provided
-
_TRANSPORTATION_PROVIDED: string
Title:
Transportation Provided
Maximum Length:150
-
_TRANSPORTATION_PROVIDED_Display: string
Title:
Transportation Provided
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
Date at the end of the date range within which the payroll relationship is effective. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Date at the beginning of the date range within which the payroll relationship is effective. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PayrollRelationshipId: integer
(int64)
Unique identifier used to retrieve the payroll relationship.
Nested Schema : oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFUSVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
Default Value:US
Context of the payroll relationship's descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
Date at the end of the date range within which the payroll relationship is effective. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Date at the beginning of the date range within which the payroll relationship is effective. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
overtimeStatus: string
Title:
Overtime Status
Maximum Length:150
-
overtimeStatus_Display: string
Title:
Overtime Status
-
PayrollRelationshipId: integer
(int64)
Unique identifier used to retrieve the payroll relationship.
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- LVVO_V___FLEX_Context
-
Parameters:
- finder:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.hcm.payrolls.registrations.flex.payrollRelationshipInformation.view.PayRelationshipsDDFPER_5FTERRITORY_5FCODEVSO
The following properties are defined on the LOV link relation:- Source Attribute: __FLEX_Context_DisplayValue; Target Attribute: Value
- Display Attribute: Value, Description
- finder:
- LVVO___FLEX_Context
-
Parameters:
- finder:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.hcm.payrolls.registrations.flex.payrollRelationshipInformation.view.PayRelationshipsDDFPER_5FTERRITORY_5FCODEVSO
The following properties are defined on the LOV link relation:- Source Attribute: __FLEX_Context; Target Attribute: Id
- Display Attribute: Value
- finder: