Get
get
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/contracts/{contractsUniqID}/child/contractsDDF/{contractsDDFUniqID}
Request
Path Parameters
-
PeriodOfServiceId(required): integer(int64)
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=
-
contractsDDFUniqID(required): string
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=
-
contractsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- ContractId, EffectiveStartDate and EffectiveEndDate ---for the Contracts resource and used to uniquely identify an instance of Contracts. The client should not generate the hash key value. Instead, the client should query on the Contracts collection resource with a filter on the primary key values in order to navigate to a specific instance of Contracts.
For example: contracts?q=ContractId=<value1>;EffectiveStartDate=<value2>;EffectiveEndDate=<value3> -
workersUniqID(required): string
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.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : Discriminator: __FLEX_Context
Type:
object
Discriminator: __FLEX_Context
Discriminator Values
Match One Schema
Show Source
-
AE -
object
oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFAEVO-item-response
-
CH -
object
oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFCHVO-item-response
-
CN -
object
oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFCNVO-item-response
-
FR -
object
oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFFRVO-item-response
-
GB -
object
oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFGBVO-item-response
-
KW -
object
oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFKWVO-item-response
-
ORA_HRX_BE -
object
oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFORA__5FHRX__5FBEVO-item-response
-
ORA_HRX_IT -
object
oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFORA__5FHRX__5FITVO-item-response
-
SA -
object
oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFSAVO-item-response
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFAEVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Default Value:AE
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
_EMPLOYMENT_STATUS: string
Title:
Employment Status
Maximum Length:150
-
_EMPLOYMENT_STATUS_Display: string
Title:
Employment Status
-
ContractId: integer
(int64)
Title:
Contract ID
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFCHVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Default Value:CH
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
_MAIN_CONTRACT: string
Title:
Main Contract
Maximum Length:150
-
_MAIN_CONTRACT_Display: string
Title:
Main Contract
-
ContractId: integer
(int64)
Title:
Contract ID
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFCNVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Default Value:CN
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
_CANCELLATION_FILE_NUM: string
Title:
Cancellation File Number
Maximum Length:150
-
_COMPETITION_CLAUSE: string
Title:
Competition Clause
Maximum Length:150
-
_COMPETITION_CLAUSE_Display: string
Title:
Competition Clause
-
_CONST_PROB_DATE: string
(date)
Title:
Proposed Probation End Date
-
_NDA: string
Title:
Nondisclosure Agreement
Maximum Length:150
-
_NDA_Display: string
Title:
Nondisclosure Agreement
-
_NOTICE_DURATION_UNIT: string
Title:
Notice Period Duration Unit
Maximum Length:150
-
_NOTICE_DURATION_UNIT_Display: string
Title:
Notice Period Duration Unit
-
_NOTICE_PERIOD_DISMISS: number
Title:
Notice Period for Dismissal After Probation
-
_NOTICE_PRD_DISMISS_PROB: number
Title:
Notice Period for Dismissal During Probation
-
_NOTICE_PRD_RESIGN: number
Title:
Notice Period for Resignation After Probation
-
_NOTICE_PRD_RESIGN_PROB: number
Title:
Notice Period for Resignation During Probation
-
ContractId: integer
(int64)
Title:
Contract ID
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFFRVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Default Value:FR
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
_CONTRACT_SUB_TYPE_START_DATE: string
(date)
Title:
Subtype Start Date
-
_CTR_CATEG_AGIRC_ARRCO: string
Title:
Employee Category
Maximum Length:150
-
_CTR_CATEG_AGIRC_ARRCO_Display: string
Title:
Employee Category
-
_CTR_DURATION_TYPE: string
Title:
Contract Duration Type
Maximum Length:150
-
_CTR_DURATION_TYPE_Display: string
Title:
Contract Duration Type
-
_CTR_PENSION_CATEGORY: string
Title:
Pension CPN Category
Maximum Length:150
-
_CTR_PENSION_CATEGORY_Display: string
Title:
Pension CPN Category
-
_CTR_PERSON_REPLACED: string
Title:
Person Replaced
Maximum Length:150
-
_CTR_SUB_TYPE: string
Title:
Contract Subtype
Maximum Length:150
-
_CTR_SUB_TYPE_Display: string
Title:
Contract Subtype
-
_CTR_SUB_TYPE_END_DATE: string
(date)
Title:
Subtype End Date
-
_HRX_COMPETITIVE_CLAUSE: string
Title:
Noncompetitive Clause
Maximum Length:150
-
_HRX_COMPETITIVE_CLAUSE_Display: string
Title:
Noncompetitive Clause
-
_HRX_EXCLUSIVITY_CLAUSE: string
Title:
Exclusivity Clause
Maximum Length:150
-
_HRX_EXCLUSIVITY_CLAUSE_Display: string
Title:
Exclusivity Clause
-
_HRX_MOBILITY_CLAUSE: string
Title:
Mobility Clause
Maximum Length:150
-
_HRX_MOBILITY_CLAUSE_Display: string
Title:
Mobility Clause
-
_HRX_OTHER_CLAUSE: string
Title:
Other Clause
Maximum Length:150
-
_ORA_HRX_FR_DSN_APPR_DIPLOMA_LE: string
Title:
Diploma Level Pursued
Maximum Length:150
-
_ORA_HRX_FR_DSN_APPR_DIPLOMA_LE_Display: string
Title:
Diploma Level Pursued
-
ContractId: integer
(int64)
Title:
Contract ID
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFGBVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Default Value:GB
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
ContractId: integer
(int64)
Title:
Contract ID
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OraHrxGbPsSwcDailyRate: string
Title:
Daily Rate
Maximum Length:150
-
OraHrxGbPsSwcDailyRate_Display: string
Title:
Daily Rate
-
OraHrxGbPsSwcDestination: string
Title:
Destination
Maximum Length:150
-
OraHrxGbPsSwcDestination_Display: string
Title:
Destination
-
OraHrxGbPsSwcLeavingReason: string
Title:
Reason for Leaving
Maximum Length:150
-
OraHrxGbPsSwcLeavingReason_Display: string
Title:
Reason for Leaving
-
OraHrxGbPsSwcOrigin: string
Title:
Origin
Maximum Length:150
-
OraHrxGbPsSwcOrigin_Display: string
Title:
Origin
-
OraHrxGbPsSwcPayRevDate: string
(date)
Title:
Pay Review Date
-
OraHrxGbPsSwcPost: string
Title:
Post
Maximum Length:150
-
OraHrxGbPsSwcPost_Display: string
Title:
Post
-
OraHrxGbPsSwcSchArrival: string
(date)
Title:
School Arrival Date
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFKWVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Default Value:KW
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
_EMPLOYMENT_STATUS: string
Title:
Employment Status
Maximum Length:150
-
_EMPLOYMENT_STATUS_Display: string
Title:
Employment Status
-
ContractId: integer
(int64)
Title:
Contract ID
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFORA__5FHRX__5FBEVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Default Value:ORA_HRX_BE
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
_END_CONTRACT_REASON: string
Title:
End Contract Reason
Maximum Length:150
-
_END_CONTRACT_REASON_Display: string
Title:
End Contract Reason
-
_END_CONTRACT_TYPE: string
Title:
End Contract Type
Maximum Length:150
-
_END_CONTRACT_TYPE_Display: string
Title:
End Contract Type
-
_END_MANDATORY_DATE: string
(date)
Title:
Mandatory Replacement End Date
-
_MANDATORY_REPLACEMENT: string
Title:
Mandatory Replacement
Maximum Length:150
-
_REPLACING_CONTRACT_NO: string
Title:
Replacement Contract Number
Maximum Length:150
-
_REPLACING_PERSON_NO: string
Title:
Replacement Person Number
Maximum Length:150
-
_WORKING_SCHEDULE_PATTERN: string
Title:
Working Schedule Pattern
Maximum Length:150
-
_WORKING_SCHEDULE_PATTERN_Display: string
Title:
Working Schedule Pattern
-
ContractId: integer
(int64)
Title:
Contract ID
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFORA__5FHRX__5FITVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Default Value:ORA_HRX_IT
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
ContractId: integer
(int64)
Title:
Contract ID
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
oraHrxItSublevel: string
Title:
Sublevel
Maximum Length:150
-
oraHrxItSublevel_Display: string
Title:
Sublevel
-
PerLabourAgreement: number
Title:
Labor Agreement
-
PerLabourAgreement_Display: string
Title:
Labor Agreement
-
PerQualification: string
Title:
Qualification
Maximum Length:150
-
PerQualification_Display: string
Title:
Qualification
-
PerQualificationLevel: string
Title:
Level
Maximum Length:150
-
PerQualificationLevel_Display: string
Title:
Level
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFSAVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Default Value:SA
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
_EMPLOYMENT_STATUS: string
Title:
Employment Status
Maximum Length:150
-
_EMPLOYMENT_STATUS_Display: string
Title:
Employment Status
-
_PROFESSION: string
Title:
Profession
Maximum Length:150
-
ContractId: integer
(int64)
Title:
Contract ID
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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 : 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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- LVVO_V___FLEX_Context
-
Parameters:
- finder:
ValidValuesFinder%3BBind_ApplicationId%3D800%2CBind_DescriptiveFlexfieldCode%3DPER_CONTRACT_LEG_DDF
- finder:
- LVVO___FLEX_Context
-
Parameters:
- finder:
ValidValuesFinder%3BBind_ApplicationId%3D800%2CBind_DescriptiveFlexfieldCode%3DPER_CONTRACT_LEG_DDF
- finder: