Create a worker work relationship

post

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

Request

Path Parameters
  • 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.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
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: Legal Employer
    Maximum Length: 240
    Name of the legal employer for the work relationship.
  • 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: Legal Entity ID
    Unique identifier for the legal entity of the work relationship.
  • Title: On Military Service
    Maximum Length: 30
    Default Value: false
    Indicates whether the person is on military service.
  • Title: Primary
    Maximum Length: 30
    Default Value: true
    Indicates whether the work relationship is the primary work relationship for the worker. Valid values are Yes and No.
  • 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: Start Date
    Start date of the period of employment.
  • Title: Worker Number
    Maximum Length: 30
    Unique identifier for the worker.
  • Title: Worker Type
    Maximum Length: 30
    Worker type for the period of service such as Employee (E), Contingent Worker (C), Pending Worker (P), or Non-worker (N). Valid values are defined in the commonLookupsLOV.
  • 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-post-request", "CA":"#/components/schemas/oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFCAVO-item-post-request", "FR":"#/components/schemas/oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFFRVO-item-post-request", "GB":"#/components/schemas/oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFGBVO-item-post-request", "MX":"#/components/schemas/oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFMXVO-item-post-request", "NL":"#/components/schemas/oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFNLVO-item-post-request", "SA":"#/components/schemas/oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFSAVO-item-post-request", "US":"#/components/schemas/oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFUSVO-item-post-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-post-request
Type: object
Show Source
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-post-request", "FR":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFFRVO-item-post-request", "GB":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFGBVO-item-post-request", "MX":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFMXVO-item-post-request", "ORA_HRX_ZA":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFORA__5FHRX__5FZAVO-item-post-request", "US":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFUSVO-item-post-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-post-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-post-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-post-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFFRVO-item-post-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFGBVO-item-post-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFMXVO-item-post-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFORA__5FHRX__5FZAVO-item-post-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFUSVO-item-post-request
Type: object
Show Source
Nested Schema : workers-workRelationships-assignments-assignmentsDFF-item-post-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-post-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-post-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
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-post-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : workers-workRelationships-contracts-item-post-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-post-request", "CH":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFCHVO-item-post-request", "CN":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFCNVO-item-post-request", "FR":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFFRVO-item-post-request", "GB":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFGBVO-item-post-request", "KW":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFKWVO-item-post-request", "ORA_HRX_BE":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFORA__5FHRX__5FBEVO-item-post-request", "ORA_HRX_IT":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFORA__5FHRX__5FITVO-item-post-request", "SA":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFSAVO-item-post-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-post-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFCHVO-item-post-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFCNVO-item-post-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFFRVO-item-post-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFGBVO-item-post-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFKWVO-item-post-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFORA__5FHRX__5FBEVO-item-post-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFORA__5FHRX__5FITVO-item-post-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFSAVO-item-post-request
Type: object
Show Source
Nested Schema : workers-workRelationships-contracts-contractsDFF-item-post-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_periodOfServiceDDF_view_WorkRelationshipLegDDFBRVO-item-post-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFCAVO-item-post-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFFRVO-item-post-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFGBVO-item-post-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFMXVO-item-post-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFNLVO-item-post-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFSAVO-item-post-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFUSVO-item-post-request
Type: object
Show Source
Nested Schema : workers-workRelationships-workRelationshipsDFF-item-post-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 create a work relationship for a worker by submitting a POST 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 "Effective-Of:RangeStartDate=2018-01-01" -X POST -d <payload> "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/workers/00020000000EACED00057708000110F086BB1B0D0000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800000160AF04900078/child/workRelationships"

Example of Payload

The following is an example of the payload.

{
   "LegalEntityId": 100000011593283,
   "assignments": [{
       "ActionCode":"HIRE_ADD_WORK_RELATION",
       "BusinessUnitId": 300100037658074
     }
  ]
}

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 201 Created
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": null,
    "WorkerType": "E",
    "PrimaryFlag": false,
    "StartDate": "2018-01-01",
    "LegalEmployerSeniorityDate": null,
    "EnterpriseSeniorityDate": null,
    "OnMilitaryServiceFlag": false,
    "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:32:35.474+00:00",
    "assignments": {
        "items": [
            {
                "AssignmentId": 300100215315762,
                "AssignmentNumber": "E960000000000899-2",
                "AssignmentName": "E960000000000899-2",
                "ActionCode": "HIRE_ADD_WORK_RELATION",
                "ReasonCode": null,
                "EffectiveStartDate": "2018-01-01",
                "EffectiveEndDate": "4712-12-31",
                "EffectiveSequence": 1,
                "EffectiveLatestChange": "Y",
                "BusinessUnitId": 300100037658074,
                "BusinessUnitName": "AUTO_GHR_BUSINESS UNIT01",
                "AssignmentType": "E",
                "AssignmentStatusTypeId": 100010026278977,
                "AssignmentStatusTypeCode": "ACTIVE_PROCESS",
                "AssignmentStatusType": "ACTIVE",
                "SystemPersonType": "EMP",
                "UserPersonTypeId": 100010025072012,
                "UserPersonType": "Employee",
                "ProposedUserPersonTypeId": null,
                "ProposedUserPersonType": null,
                "ProjectedStartDate": null,
                "ProjectedEndDate": null,
                "PrimaryFlag": false,
                "PrimaryAssignmentFlag": true,
                "PositionId": null,
                "PositionCode": null,
                "SynchronizeFromPositionFlag": false,
                "JobId": null,
                "JobCode": null,
                "GradeId": null,
                "GradeCode": null,
                "GradeLadderId": null,
                "GradeLadderName": null,
                "GradeStepEligibilityFlag": true,
                "GradeCeilingStepId": null,
                "GradeCeilingStep": null,
                "DepartmentId": null,
                "DepartmentName": null,
                "ReportingEstablishmentId": null,
                "ReportingEstablishmentName": null,
                "LocationId": null,
                "LocationCode": null,
                "WorkAtHomeFlag": false,
                "AssignmentCategory": null,
                "WorkerCategory": null,
                "PermanentTemporary": null,
                "FullPartTime": null,
                "ManagerFlag": false,
                "HourlySalariedCode": null,
                "NormalHours": null,
                "Frequency": null,
                "StartTime": null,
                "EndTime": null,
                "SeniorityBasis": "ORA_PER_SNDT_DAYS",
                "ProbationPeriod": null,
                "ProbationPeriodUnit": null,
                "ProbationEndDate": null,
                "NoticePeriod": null,
                "NoticePeriodUOM": null,
                "WorkTaxAddressId": null,
                "ExpenseCheckSendToAddress": null,
                "RetirementAge": null,
                "RetirementDate": null,
                "LabourUnionMemberFlag": null,
                "UnionId": null,
                "UnionName": null,
                "BargainingUnitCode": null,
                "CollectiveAgreementId": null,
                "CollectiveAgreementName": null,
                "InternalBuilding": null,
                "InternalFloor": null,
                "InternalOfficeNumber": null,
                "InternalMailstop": null,
                "DefaultExpenseAccount": null,
                "PeopleGroup": null,
                "CreatedBy": "VMOSS",
                "CreationDate": "2019-04-23T12:32:30.153+00:00",
                "LastUpdatedBy": "VMOSS",
                "LastUpdateDate": "2019-04-23T12:32:36.451+00:00",
                "links": [
                    {...
                       }
         }
    ]
}
Back to Top