1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Workers
  4. Work Relationships
  5. Contracts

Create a worker contract

post

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

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
  • 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
  • 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.
  • 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
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-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 : 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-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 : schema
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-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 : 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
Nested Schema : workers-workRelationships-contracts-contractsDFF-item-response
Type: object
Show Source
Links
contractTypesLOV
Parameters:
  • finder: LegislationCodeFinder%3BLegislationCode%3D{LegislationCode}%2CLookupCode%3D{ContractType}%2CActiveDate%3D{EffectiveStartDate}%2CLookupType%3DCONTRACT_TYPE
The common lookups list of values resource is used to query the list of values of common lookups, which are legacy lookups or lookups that have attributes. Common lookups are defined in the common lookup view and support backward compatibility.
contractsDDF
Parameters:
  • PeriodOfServiceId: $request.path.PeriodOfServiceId
  • contractsUniqID: $request.path.contractsUniqID
  • workersUniqID: $request.path.workersUniqID
contractsDFF
Parameters:
  • PeriodOfServiceId: $request.path.PeriodOfServiceId
  • contractsUniqID: $request.path.contractsUniqID
  • workersUniqID: $request.path.workersUniqID
extensionPeriodUnitsLOV
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DQUALIFYING_UNITS%2CLookupCode%3D{ExtensionPeriodUnits}
The common lookups list of values resource is used to query the list of values of common lookups, which are legacy lookups or lookups that have attributes. Common lookups are defined in the common lookup view and support backward compatibility.
initialDurationUnitsLOV
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DQUALIFYING_UNITS%2CLookupCode%3D{InitialDurationUnits}
The common lookups list of values resource is used to query the list of values of common lookups, which are legacy lookups or lookups that have attributes. Common lookups are defined in the common lookup view and support backward compatibility.
Back to Top