1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Payroll Relationships

Update a payroll relationship

patch

/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}

Request

Path Parameters
  • 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
  • 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 : PayRelationshipsDDF
Type: array
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "AE":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFAEVO-item-patch-request", "SA":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFSAVO-item-patch-request", "US":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFUSVO-item-patch-request" } }
Nested Schema : Payroll Assignments
Type: array
Title: Payroll Assignments
The payrollAssignments resource is a child of the payrollRelationships resource.It includes a list of all payroll assignments for a given payroll relationship.
Show Source
Nested Schema : Payroll Relationship Dates
Type: array
Title: Payroll Relationship Dates
The payrollRelationshipDates resource is a child of the payrollRelationships resource. It includes a list of all element duration dates for the given payroll relationship.
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFAEVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFSAVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFUSVO-item-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Assigned Payrolls
Type: array
Title: Assigned Payrolls
The assignedPayrolls resource is a child of the payrollAssignments resource.It includes a list of all payrolls assigned for a given assignment.
Show Source
Nested Schema : Payroll Assignment Dates
Type: array
Title: Payroll Assignment Dates
The payrollAssignmentDates resource is a child of the payrollAssignments resource. It includes a list of all element duration dates for a given payroll assignment.
Show Source
Nested Schema : PayrollRelationshipGroupsDDF
Type: array
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "CA":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipGroupInformation_view_PayrollRelationshipGroupsDDFCAVO-item-patch-request", "US":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipGroupInformation_view_PayrollRelationshipGroupsDDFUSVO-item-patch-request" } }
Nested Schema : payrollRelationships-payrollAssignments-assignedPayrolls-item-patch-request
Type: object
Show Source
Nested Schema : Assigned Payroll Dates
Type: array
Title: Assigned Payroll Dates
The assignedPayrollDates resource is a child of the assignedPayrollDetails resource.It includes a list of all element duration dates for the given assigned payroll.
Show Source
Nested Schema : payrollRelationships-payrollAssignments-assignedPayrolls-assignedPayrollDates-item-patch-request
Type: object
Show Source
Nested Schema : payrollRelationships-payrollAssignments-payrollAssignmentDates-item-patch-request
Type: object
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipGroupInformation_view_PayrollRelationshipGroupsDDFCAVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipGroupInformation_view_PayrollRelationshipGroupsDDFUSVO-item-patch-request
Type: object
Show Source
Nested Schema : payrollRelationships-payrollRelationshipDates-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 : payrollRelationships-item-response
Type: object
Show Source
Nested Schema : PayRelationshipsDDF
Type: array
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "AE":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFAEVO-item-response", "SA":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFSAVO-item-response", "US":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFUSVO-item-response" } }
Nested Schema : Payroll Assignments
Type: array
Title: Payroll Assignments
The payrollAssignments resource is a child of the payrollRelationships resource.It includes a list of all payroll assignments for a given payroll relationship.
Show Source
Nested Schema : Payroll Relationship Dates
Type: array
Title: Payroll Relationship Dates
The payrollRelationshipDates resource is a child of the payrollRelationships resource. It includes a list of all element duration dates for the given payroll relationship.
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFAEVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFSAVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFUSVO-item-response
Type: object
Show Source
Nested Schema : payrollRelationships-payrollAssignments-item-response
Type: object
Show Source
Nested Schema : Assigned Payrolls
Type: array
Title: Assigned Payrolls
The assignedPayrolls resource is a child of the payrollAssignments resource.It includes a list of all payrolls assigned for a given assignment.
Show Source
Nested Schema : Payroll Assignment Dates
Type: array
Title: Payroll Assignment Dates
The payrollAssignmentDates resource is a child of the payrollAssignments resource. It includes a list of all element duration dates for a given payroll assignment.
Show Source
Nested Schema : PayrollRelationshipGroupsDDF
Type: array
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "CA":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipGroupInformation_view_PayrollRelationshipGroupsDDFCAVO-item-response", "US":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipGroupInformation_view_PayrollRelationshipGroupsDDFUSVO-item-response" } }
Nested Schema : payrollRelationships-payrollAssignments-assignedPayrolls-item-response
Type: object
Show Source
Nested Schema : Assigned Payroll Dates
Type: array
Title: Assigned Payroll Dates
The assignedPayrollDates resource is a child of the assignedPayrollDetails resource.It includes a list of all element duration dates for the given assigned payroll.
Show Source
Nested Schema : payrollRelationships-payrollAssignments-assignedPayrolls-assignedPayrollDates-item-response
Type: object
Show Source
Nested Schema : payrollRelationships-payrollAssignments-payrollAssignmentDates-item-response
Type: object
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipGroupInformation_view_PayrollRelationshipGroupsDDFCAVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipGroupInformation_view_PayrollRelationshipGroupsDDFUSVO-item-response
Type: object
Show Source
Nested Schema : payrollRelationships-payrollRelationshipDates-item-response
Type: object
Show Source
Links
PayRelationshipsDDF
Parameters:
  • payrollRelationshipsUniqID: $request.path.payrollRelationshipsUniqID
payrollAssignments
Parameters:
  • payrollRelationshipsUniqID: $request.path.payrollRelationshipsUniqID
The payrollAssignments resource is a child of the payrollRelationships resource.It includes a list of all payroll assignments for a given payroll relationship.
payrollRelationshipDates
Parameters:
  • payrollRelationshipsUniqID: $request.path.payrollRelationshipsUniqID
The payrollRelationshipDates resource is a child of the payrollRelationships resource. It includes a list of all element duration dates for the given payroll relationship.
Back to Top

Examples

The following example shows how to update a payroll relationship by submitting a PATCH request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -H "Effective-Of: RangeMode=UPDATE;RangeStartDate=2015-10-02" -X PATCH -d <payload> http://<host>:<port>/hcmRestApi/resources/11.13.18.05/payrollRelationships/00020000000EACED00057708000110F07B480F1B0000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787077080000016A2DBE300078

Example of Payload

The following is an example of the payload.

{
	"OverridingPeriodId": 300100118612058
}

Example of Response Header

The following is an example of the response header.

HTTP/1.1 200 OK
Content-Type : application/vnd.oracle.adf.resourceitem+json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "PayrollRelationshipId" : 300100023226139,
    "PayrollRelationshipNumber" : "955160008174698",
    "StartDate" : "2012-01-01",
    "EndDate" : "4712-12-31",
    "PersonNumber" : "955160008174698",
    "Country" : null,
    "PartyId" : 300100023226777,
    "PartyNumber" : "CDRM_66822",
    "EffectiveEndDate" : "4712-12-31",
    "EffectiveStartDate" : "2015-10-02",
    "OverridingPeriodId" : 300100118612058,
    "links": [
        {
          ...}
   ]
}
Back to Top