Update a worker work relationship

patch

/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}

Request

Path Parameters
  • Surrogate identifier for the period of service.
  • This is the hash key of the attributes which make up the composite key for the Workers resource and used to uniquely identify an instance of Workers. The client should not generate the hash key value. Instead, the client should query on the Workers collection resource in order to navigate to a specific instance of Workers to get the hash key.
Header Parameters
  • 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
  • Assignments
    Title: Assignments
    The assignments resource is a child of the workRelationships resource. It provides all the worker assignments as of the specified date. By default, the current date is retained.
  • Contracts
    Title: Contracts
    The contracts resource is a child of the workRelationships resource. It provides all the contracts of a worker as of the specified date. By default, the current date is retained.
  • Title: Enterprise Seniority Date
    Adjusted service date. For example, for a rehire who was part of an acquisition, all plans might use the original hire date if rehired within 90 days of termination. However, a 401k plan might use the adjusted service date which was originally populated upon acquisition.
  • Title: Seniority Date
    Date on which a person's legal-employer service of a particular type, such as employee, contingent worker, or non-worker, is based.
  • Title: On Military Service
    Maximum Length: 30
    Default Value: false
    Indicates whether the person is on military service.
  • Title: Projected Termination Date
    Projected last date of employment for the period of service.
  • Title: Include for Automatic Conversion
    Maximum Length: 10
    Indicates whether the pending worker is ready to be converted to the proposed worker type.
  • Title: Worker Number
    Maximum Length: 30
    Unique identifier for the worker.
  • Work Relationship Developer Flexfields
    Title: Work Relationship Developer Flexfields
    The workRelationshipsDDF resource is a child of the workRelationships resource. It provides all the work relationship developer descriptive flexfields of a worker as of the specified date. By default, the current date is retained.
  • Work Relationship Descriptive Flexfields
    Title: Work Relationship Descriptive Flexfields
    The workRelationshipsDFF resource is a child of the workRelationships resource. It provides all the work relationship descriptive flexfields of a worker as of the specified date. By default, the current date is retained.
Nested Schema : Assignments
Type: array
Title: Assignments
The assignments resource is a child of the workRelationships resource. It provides all the worker assignments as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : Contracts
Type: array
Title: Contracts
The contracts resource is a child of the workRelationships resource. It provides all the contracts of a worker as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : Work Relationship Developer Flexfields
Type: array
Title: Work Relationship Developer Flexfields
The workRelationshipsDDF resource is a child of the workRelationships resource. It provides all the work relationship developer descriptive flexfields of a worker as of the specified date. By default, the current date is retained.
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "BR":"#/components/schemas/oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFBRVO-item-patch-request", "CA":"#/components/schemas/oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFCAVO-item-patch-request", "FR":"#/components/schemas/oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFFRVO-item-patch-request", "GB":"#/components/schemas/oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFGBVO-item-patch-request", "MX":"#/components/schemas/oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFMXVO-item-patch-request", "NL":"#/components/schemas/oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFNLVO-item-patch-request", "SA":"#/components/schemas/oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFSAVO-item-patch-request", "US":"#/components/schemas/oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFUSVO-item-patch-request" } }
Nested Schema : Work Relationship Descriptive Flexfields
Type: array
Title: Work Relationship Descriptive Flexfields
The workRelationshipsDFF resource is a child of the workRelationships resource. It provides all the work relationship descriptive flexfields of a worker as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : workers-workRelationships-assignments-item-patch-request
Type: object
Show Source
  • Title: Action Code
    Maximum Length: 30
    Action being performed for this assignment, such as, Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV.
  • Title: Adjusted FTE
    Adjusted Full Time Equivalent for the worker assignment.
  • All Reports
    Title: All Reports
    The allReports resource is a child of the assignments resource. It provides all the reports of a worker as of the specified date. By default, the current date is retained.
  • Title: Annual Working Duration
    Annual working duration for the worker assignment.
  • Title: Annual Working Duration Units
    Maximum Length: 20
    Description of the annual working duration units.
  • Title: Annual Working Ratio
    Annual working ratio for the worker assignment.
  • Title: Assignment Category
    Maximum Length: 30
    User-defined category for the assignment such as full-time, permanent, and so on. Valid values are defined in the commonLookupsLOV.
  • Title: Business Title
    Maximum Length: 80
    Business title of the worker assignment.
  • Title: Assignment Number
    Maximum Length: 30
    Unique identifier for the assignment.
  • Assignment Developer Flexfields
    Title: Assignment Developer Flexfields
    The assignmentsDDF resource is a child of the assignments resource. It provides all the assignment developer flexfields of a worker as of the specified date. By default, the current date is retained.
  • Assignment Descriptive Flexfields
    Title: Assignment Descriptive Flexfields
    The assignmentsDFF resource is a child of the assignments resource. It provides all the assignment descriptive flexfields of a worker as of the specified date. By default, the current date is retained.
  • Assignment Extensible FlexFields
    Title: Assignment Extensible FlexFields
    The assignmentsEFF resource is a child of the assignments resource. It provides all the assignment extensible flexfields of a worker as of the specified date. By default, the current date is retained.
  • Title: Assignment Standard Working Hours Units
    Maximum Length: 30
    Standard frequency for the worker assignment.
  • Title: Assignment Standard Working Hours
    Standard working hours for the worker assignment.
  • Maximum Length: 30
    Code for the assignment status type.
  • Title: Assignment Status Type ID
    Unique identifier for the assignment status type.
  • Title: Bargaining Unit
    Maximum Length: 30
    Code for the bargaining unit.
  • Title: Business Unit ID
    Unique identifier for the business unit of the assignment.
  • Title: Business Unit
    Maximum Length: 240
    Name of the business unit for the worker assignment. Valid values are defined in the hcmBusinesUnitsLOV.
  • Title: Collective Agreement ID
    Surrogate identifier for the collective agreement.
  • Title: Collective Agreement
    Maximum Length: 80
    Name for the collective agreement. Valid values are defined in the collectiveAgreementsLov.
  • Title: Contract ID
    Surrogate identifier for the contract.
  • Title: Contract Number
    Maximum Length: 30
    Number of the contract.
  • Default expense account of the assignment. If the expense account is configured with multiple segments, then provide the concatenated value. Separate the values using the separator configured for the expense account.
  • Title: Department ID
    Unique identifier for the worker's department.
  • Title: Department
    Maximum Length: 240
    Name of the department for the worker assignment. Valid values are defined in the departmentsLov.
  • Title: Effective End Date
    End date of the date-effective changes to the record.
  • Title: Effective Latest Change
    Maximum Length: 30
    Set to Y if this is the last change on the effective start date. Otherwise, set to N.
  • Title: Effective Sequence
    Sequence number of the change on the effective start date. For the first change on the effective start date, set this value to 1. For incremental changes, leave this value blank to generate the next number in the sequence.
  • Title: Effective Start Date
    Start date of the date-effective changes to the record.
  • Title: End Time
    Maximum Length: 5
    Normal end time for the working day.
  • Title: Expense Check Send-to Address
    Maximum Length: 30
    Determines whether expense checks are sent to the home or office address.
  • Title: Frequency
    Maximum Length: 30
    Frequency of normal working hours such as week or month. Specify with the NormalHours attribute. Valid values are defined in the commonLookupsLOV.
  • Title: Full Time or Part Time
    Maximum Length: 30
    Indicates whether the worker works full-time or part-time. Valid values are defined in the commonLookupsLOV.
  • Title: Grade Code
    Maximum Length: 30
    Code of the assignment grade. Valid values are defined in the gradesLov.
  • Title: Grade ID
    Unique identifier for the worker's grade.
  • Title: Grade Ladder ID
    Unique identifier for the grade ladder used for benefits.
  • Title: Grade Ladder
    Maximum Length: 240
    Name of the grade ladder used for benefits. Valid values are defined in the gradeLaddersLov.
  • Title: Include in Grade Step Progression
    Maximum Length: 30
    Default Value: true
    Indicates whether the assignment is eligible for grade-step progression. Valid values are true or false.
  • Grade Steps
    Title: Grade Steps
    The gradeSteps resource is a child of the assignments resource. It provides all the assignment grade steps of a worker as of the specified date. By default, the current date is retained.
  • Title: Hourly Paid or Salaried
    Maximum Length: 30
    Identifies whether the assignment is paid by the hour or by a salary. Either maintained at the assignment level or employment or placement terms but not both. Valid values are defined in the commonLookupsLOV.
  • Title: Building
    Maximum Length: 45
    Building information associated with the work location.
  • Title: Floor
    Maximum Length: 45
    Floor information associated with the work location.
  • Title: Mail Stop
    Maximum Length: 45
    Internal mail location.
  • Title: Office Number
    Maximum Length: 45
    Office number associated with the work location.
  • Title: Job Code
    Maximum Length: 30
    Code for the worker's job. Valid values are defined in the jobsLov.
  • Title: Job ID
    Unique identifier for the worker's job.
  • Title: Union Member
    Maximum Length: 30
    Indicates whether the worker is a labor union member.
  • Title: Location Code
    Maximum Length: 150
    Code for the worker's location.
  • Title: Location ID
    Unique identifier for the worker's location.
  • Title: Working as a Manager
    Maximum Length: 30
    Indicates whether the worker is a manager.
  • Managers
    Title: Managers
    The managers resource is a child of the assignments resource. It provides all the assignment managers of a worker as of the specified date. By default, the current date is retained.
  • Title: Working Hours
    Normal working hours such as 37.5. Specify with the Frequency attribute.
  • Title: Notice Period
    Notice period for the assignment. Specify with the NoticePeriodUOM attribute.
  • Title: Notice Period Units
    Maximum Length: 30
    Unit of measure for the notice period. Specify with the NoticePeriod attribute. Valid values are defined in the commonLookupsLOV.
  • People Group Key flexfield for the assignment. If people group is configured with multiple segments, provide the concatenated value, separating the values with the separator configured for the People Group Key flexfield.
  • Title: Regular or Temporary
    Maximum Length: 30
    Indicates whether the worker is regular or temporary. Valid values are defined in the commonLookupsLOV.
  • Title: Position Code
    Maximum Length: 30
    Code for the worker's position.
  • Title: Position ID
    Unique identifier for the worker's position.
  • Title: Primary Assignment
    Maximum Length: 30
    Default Value: false
    Indicates whether the current assignment is primary for the work relationship. Valid values are true or false.
  • Title: Probation End Date
    End date of the probation period.
  • Title: Probation Period
    Duration of the probation period. Specify with the ProbationPeriodUnit attribute.
  • Title: Probation Unit
    Maximum Length: 30
    Unit of measure for the probation period. Specify with the ProbationPeriod attribute. Valid values are defined in the commonLookupsLOV.
  • Title: Projected End Date
    Date when the assignment is expected to end.
  • Title: Projected Start Date
    Expected start date for applicants. This value is required for pending workers.
  • Title: Reason Code
    Maximum Length: 30
    Reason for the action being performed on the record. Valid values are defined in the actionReasonsLOV.
  • Title: Reporting Establishment ID
    Unique identifier for the reporting establishment.
  • Title: Reporting Establishment
    Maximum Length: 240
    Name of the reporting establishment. Valid values are defined in the reportingEstablishmentsLOV.
  • Representatives
    Title: Representatives
    The representatives resource is a child of the assignments resource. It provides all the representatives of a worker as of the specified date. By default, the current date is retained.
  • Title: Retirement Age
    Age at which the worker is retiring.
  • Title: Retirement Date
    Planned retirement date of the worker.
  • Title: Basis for Seniority Calculation
    Maximum Length: 30
    Default Value: ORA_PER_SNDT_DAYS
    Basis for calculating seniority for the person. Valid values are defined in the commonLookupsLOV.
  • Title: Standard Annual Working Duration
    Standard annual working duration for the worker assignment.
  • Frequency of standard working hours such as week or month.
  • Standard working hours such as 40.
  • Title: Start Time
    Maximum Length: 5
    Normal start time for the working day.
  • Title: Synchronize from Position
    Maximum Length: 30
    Default Value: false
    Indicates whether attributes from the position can be overridden on the assignment when using position synchronization. Valid values are true or false.
  • Title: Union ID
    Unique identifier of the worker union for the assignment.
  • Title: Union
    Maximum Length: 240
    Name of the worker union for the assignment. Valid values are defined in the unionsLov.
  • Title: User Person Type
    Maximum Length: 80
    User-defined value that identifies the person type such as employee or contingent worker. Valid values are defined in the personTypesLOV.
  • Title: User Person Type ID
    Unique identifier for the user person type.
  • Title: Working at Home
    Maximum Length: 30
    Indicates whether the worker works at home for the assignment.
  • Title: Worker Category
    Maximum Length: 30
    Category of the worker such as blue collar, civil servant, and so on. Valid values are defined in the commonLookupsLOV.
  • Work Measures
    Title: Work Measures
    The workMeasures resource is a child of the assignments resource. It provides all the assignment work measures of a worker as of the specified date. By default, the current date is retained.
  • Title: Work Tax Address ID
    Unique identifier for the address used for taxation purposes. This can be different from the mailing address.
Nested Schema : All Reports
Type: array
Title: All Reports
The allReports resource is a child of the assignments resource. It provides all the reports of a worker as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : Assignment Developer Flexfields
Type: array
Title: Assignment Developer Flexfields
The assignmentsDDF resource is a child of the assignments resource. It provides all the assignment developer flexfields of a worker as of the specified date. By default, the current date is retained.
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "DE":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFDEVO-item-patch-request", "FR":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFFRVO-item-patch-request", "GB":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFGBVO-item-patch-request", "MX":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFMXVO-item-patch-request", "ORA_HRX_ZA":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFORA__5FHRX__5FZAVO-item-patch-request", "US":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFUSVO-item-patch-request" } }
Nested Schema : Assignment Descriptive Flexfields
Type: array
Title: Assignment Descriptive Flexfields
The assignmentsDFF resource is a child of the assignments resource. It provides all the assignment descriptive flexfields of a worker as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : Assignment Extensible FlexFields
Type: array
Title: Assignment Extensible FlexFields
The assignmentsEFF resource is a child of the assignments resource. It provides all the assignment extensible flexfields of a worker as of the specified date. By default, the current date is retained.
Show Source
  • Discriminator: CategoryCode
    Discriminator: { "propertyName":"CategoryCode", "mapping":{ "PER_ASG_EIT":"#/components/schemas/oracle_apps_hcm_employment_core_flex_assignmentExtraInfoEFF_Category_view_j__CategoryPerAsgEitprivateVO-item-patch-request" } }
Nested Schema : Grade Steps
Type: array
Title: Grade Steps
The gradeSteps resource is a child of the assignments resource. It provides all the assignment grade steps of a worker as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : Managers
Type: array
Title: Managers
The managers resource is a child of the assignments resource. It provides all the assignment managers of a worker as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : Representatives
Type: array
Title: Representatives
The representatives resource is a child of the assignments resource. It provides all the representatives of a worker as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : Work Measures
Type: array
Title: Work Measures
The workMeasures resource is a child of the assignments resource. It provides all the assignment work measures of a worker as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : workers-workRelationships-assignments-allReports-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_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFDEVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFFRVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFGBVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFMXVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFORA__5FHRX__5FZAVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFUSVO-item-patch-request
Type: object
Show Source
Nested Schema : workers-workRelationships-assignments-assignmentsDFF-item-patch-request
Type: object
Show Source
Nested Schema : Discriminator: CategoryCode
Type: object
Discriminator: CategoryCode

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_assignmentExtraInfoEFF_Category_view_j__CategoryPerAsgEitprivateVO-item-patch-request
Type: object
Show Source
Nested Schema : InformationORA_5FPER_5FRET_5FGRADEprivateVO
Type: array
Show Source
Nested Schema : workers-workRelationships-assignments-assignmentsEFF-InformationORA_5FPER_5FRET_5FGRADEprivateVO-item-patch-request
Type: object
Show Source
Nested Schema : workers-workRelationships-assignments-gradeSteps-item-patch-request
Type: object
Show Source
Nested Schema : workers-workRelationships-assignments-managers-item-patch-request
Type: object
Show Source
  • Title: Action Code
    Maximum Length: 80
    Action being performed on the assignment such as Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV.
  • Title: Effective End Date
    End date of the date-effective changes to the record.
  • Title: Effective Start Date
    Start date of the date-effective changes to the record.
  • Title: Assignment ID
    Surrogate identifier for the assignment supervisor.
  • Title: Assignment Number
    Maximum Length: 30
    Assignment number of the supervisor.
  • Title: Type
    Maximum Length: 30
    Role the supervisor has with regards to the overall organization structure such as functional, project leader, and so on. Valid values are defined in the commonLookupsLOV.
  • Title: Reason Code
    Maximum Length: 80
    Reason for the change. Valid values are defined in the actionReasonsLOV.
Nested Schema : workers-workRelationships-assignments-representatives-item-patch-request
Type: object
Show Source
Nested Schema : workers-workRelationships-assignments-workMeasures-item-patch-request
Type: object
Show Source
Nested Schema : workers-workRelationships-contracts-item-patch-request
Type: object
Show Source
Nested Schema : Contracts Developer Flexfields
Type: array
Title: Contracts Developer Flexfields
The contractsDDF resource is a child of the contracts resource. It provides all the contracts developer flexfields of a worker as of the specified date. By default, the current date is retained.
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "AE":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFAEVO-item-patch-request", "CH":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFCHVO-item-patch-request", "CN":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFCNVO-item-patch-request", "FR":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFFRVO-item-patch-request", "GB":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFGBVO-item-patch-request", "KW":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFKWVO-item-patch-request", "ORA_HRX_BE":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFORA__5FHRX__5FBEVO-item-patch-request", "ORA_HRX_IT":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFORA__5FHRX__5FITVO-item-patch-request", "SA":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFSAVO-item-patch-request" } }
Nested Schema : Contracts Descriptive Flexfields
Type: array
Title: Contracts Descriptive Flexfields
The contractsDFF resource is a child of the contracts resource. It provides all the contracts descriptive flexfields of a worker as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFAEVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFCHVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFCNVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFFRVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFGBVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFKWVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFORA__5FHRX__5FBEVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFORA__5FHRX__5FITVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFSAVO-item-patch-request
Type: object
Show Source
Nested Schema : schema
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_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFBRVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFCAVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFFRVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFGBVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFMXVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFNLVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFSAVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFUSVO-item-patch-request
Type: object
Show Source
Nested Schema : workers-workRelationships-workRelationshipsDFF-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 : workers-workRelationships-item-response
Type: object
Show Source
Nested Schema : assignments
Type: array
Show Source
Nested Schema : contracts
Type: array
Show Source
Nested Schema : workRelationshipsDDF
Type: array
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "BR":"#/components/schemas/oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFBRVO-item-response", "CA":"#/components/schemas/oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFCAVO-item-response", "FR":"#/components/schemas/oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFFRVO-item-response", "GB":"#/components/schemas/oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFGBVO-item-response", "MX":"#/components/schemas/oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFMXVO-item-response", "NL":"#/components/schemas/oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFNLVO-item-response", "SA":"#/components/schemas/oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFSAVO-item-response", "US":"#/components/schemas/oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFUSVO-item-response" } }
Nested Schema : workRelationshipsDFF
Type: array
Show Source
Nested Schema : workers-workRelationships-assignments-item-response
Type: object
Show Source
Nested Schema : allReports
Type: array
Show Source
Nested Schema : assignmentsDDF
Type: array
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "DE":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFDEVO-item-response", "FR":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFFRVO-item-response", "GB":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFGBVO-item-response", "MX":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFMXVO-item-response", "ORA_HRX_ZA":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFORA__5FHRX__5FZAVO-item-response", "US":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFUSVO-item-response" } }
Nested Schema : assignmentsDFF
Type: array
Show Source
Nested Schema : assignmentsEFF
Type: array
Show Source
  • Discriminator: CategoryCode
    Discriminator: { "propertyName":"CategoryCode", "mapping":{ "PER_ASG_EIT":"#/components/schemas/oracle_apps_hcm_employment_core_flex_assignmentExtraInfoEFF_Category_view_j__CategoryPerAsgEitprivateVO-item-response" } }
Nested Schema : gradeSteps
Type: array
Show Source
Nested Schema : managers
Type: array
Show Source
Nested Schema : representatives
Type: array
Show Source
Nested Schema : workMeasures
Type: array
Show Source
Nested Schema : workers-workRelationships-assignments-allReports-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_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFDEVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFFRVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFGBVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFMXVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFORA__5FHRX__5FZAVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFUSVO-item-response
Type: object
Show Source
Nested Schema : workers-workRelationships-assignments-assignmentsDFF-item-response
Type: object
Show Source
Nested Schema : Discriminator: CategoryCode
Type: object
Discriminator: CategoryCode

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_assignmentExtraInfoEFF_Category_view_j__CategoryPerAsgEitprivateVO-item-response
Type: object
Show Source
Nested Schema : InformationORA_5FPER_5FRET_5FGRADEprivateVO
Type: array
Show Source
Nested Schema : workers-workRelationships-assignments-assignmentsEFF-InformationORA_5FPER_5FRET_5FGRADEprivateVO-item-response
Type: object
Show Source
Nested Schema : workers-workRelationships-assignments-gradeSteps-item-response
Type: object
Show Source
Nested Schema : workers-workRelationships-assignments-managers-item-response
Type: object
Show Source
Nested Schema : workers-workRelationships-assignments-representatives-item-response
Type: object
Show Source
Nested Schema : workers-workRelationships-assignments-workMeasures-item-response
Type: object
Show Source
Nested Schema : workers-workRelationships-contracts-item-response
Type: object
Show Source
Nested Schema : contractsDDF
Type: array
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "AE":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFAEVO-item-response", "CH":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFCHVO-item-response", "CN":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFCNVO-item-response", "FR":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFFRVO-item-response", "GB":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFGBVO-item-response", "KW":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFKWVO-item-response", "ORA_HRX_BE":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFORA__5FHRX__5FBEVO-item-response", "ORA_HRX_IT":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFORA__5FHRX__5FITVO-item-response", "SA":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFSAVO-item-response" } }
Nested Schema : contractsDFF
Type: array
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFAEVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFCHVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFCNVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFFRVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFGBVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFKWVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFORA__5FHRX__5FBEVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFORA__5FHRX__5FITVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFSAVO-item-response
Type: object
Show Source
Nested Schema : workers-workRelationships-contracts-contractsDFF-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_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFBRVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFCAVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFFRVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFGBVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFMXVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFNLVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFSAVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFUSVO-item-response
Type: object
Show Source
Nested Schema : workers-workRelationships-workRelationshipsDFF-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to update the work relationship of a worker 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 "REST-Framework-Version: 4" -H "RangeMode=UPDATE;RangeStartDate=2018-02-05" -X PATCH -d <payload> "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/workers/00020000000EACED00057708000110F086BB1B0D0000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800000160AF04900078/child/workRelationships/300100215315755"

Example of Payload

The following is an example of the payload.

{
  "OnMilitaryServiceFlag":true
}

Example of Response Header

The following is an example of the response header.

Status: 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.

{
    "PeriodOfServiceId": 300100215315755,
    "LegislationCode": "US",
    "LegalEntityId": 100000011593283,
    "LegalEmployerName": "GBI HCM Widgets USA",
    "WorkerType": "E",
    "PrimaryFlag": false,
    "StartDate": "2018-01-01",
    "LegalEmployerSeniorityDate": null,
    "EnterpriseSeniorityDate": null,
    "OnMilitaryServiceFlag": true,
    "WorkerNumber": null,
    "ReadyToConvertFlag": null,
    "TerminationDate": null,
    "NotificationDate": null,
    "LastWorkingDate": null,
    "RevokeUserAccess": null,
    "RecommendedForRehire": "ORA_NS",
    "RecommendationReason": null,
    "RecommendationAuthorizedByPersonId": null,
    "CreatedBy": "VMOSS",
    "CreationDate": "2019-04-23T12:32:30+00:00",
    "LastUpdatedBy": "VMOSS",
    "LastUpdateDate": "2019-04-23T12:41:46.055+00:00",
    "links": [
        {...
           }
   ]
}
Back to Top