Get an employment contract legislative information
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: string
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: string
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:
objectDiscriminator: __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 ValueMaximum Length:30Default Value:AEContext Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
_EMPLOYMENT_STATUS: string
Title:
Employment StatusMaximum Length:150Employment Status -
_EMPLOYMENT_STATUS_Display: string
Title:
Employment StatusEmployment 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:
LinksThe 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 ValueMaximum Length:30Default Value:CHContext Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
_MAIN_CONTRACT: string
Title:
Main ContractMaximum Length:150Main Contract -
_MAIN_CONTRACT_Display: string
Title:
Main ContractMain 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:
LinksThe 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 ValueMaximum Length:30Default Value:CNContext Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
_CANCELLATION_FILE_NUM: string
Title:
Cancellation File NumberMaximum Length:150Cancellation File Number -
_COMPETITION_CLAUSE: string
Title:
Competition ClauseMaximum Length:150Competition Clause -
_COMPETITION_CLAUSE_Display: string
Title:
Competition ClauseCompetition Clause -
_CONST_PROB_DATE: string
(date)
Title:
Proposed Probation End DateProposed Probation End Date -
_NDA: string
Title:
Nondisclosure AgreementMaximum Length:150Nondisclosure Agreement -
_NDA_Display: string
Title:
Nondisclosure AgreementNondisclosure Agreement -
_NOTICE_DURATION_UNIT: string
Title:
Notice Period Duration UnitMaximum Length:150Notice Period Duration Unit -
_NOTICE_DURATION_UNIT_Display: string
Title:
Notice Period Duration UnitNotice Period Duration Unit -
_NOTICE_PERIOD_DISMISS: number
Title:
Notice Period for Dismissal After ProbationNotice Period for Dismissal After Probation -
_NOTICE_PRD_DISMISS_PROB: number
Title:
Notice Period for Dismissal During ProbationNotice Period for Dismissal During Probation -
_NOTICE_PRD_RESIGN: number
Title:
Notice Period for Resignation After ProbationNotice Period for Resignation After Probation -
_NOTICE_PRD_RESIGN_PROB: number
Title:
Notice Period for Resignation During ProbationNotice 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:
LinksThe 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 ValueMaximum Length:30Default Value:FRContext Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
_CONTRACT_SUB_TYPE_START_DATE: string
(date)
Title:
Subtype Start DateSubtype Start Date -
_CTR_CATEG_AGIRC_ARRCO: string
Title:
Employee CategoryMaximum Length:150Employee Category -
_CTR_CATEG_AGIRC_ARRCO_Display: string
Title:
Employee CategoryEmployee Category -
_CTR_DURATION_TYPE: string
Title:
Contract Duration TypeMaximum Length:150Contract Duration Type -
_CTR_DURATION_TYPE_Display: string
Title:
Contract Duration TypeContract Duration Type -
_CTR_PENSION_CATEGORY: string
Title:
Pension CPN CategoryMaximum Length:150Pension CPN Category -
_CTR_PENSION_CATEGORY_Display: string
Title:
Pension CPN CategoryPension CPN Category -
_CTR_PERSON_REPLACED: string
Title:
Person ReplacedMaximum Length:150Person Replaced -
_CTR_SUB_TYPE: string
Title:
Contract SubtypeMaximum Length:150Contract Subtype -
_CTR_SUB_TYPE_Display: string
Title:
Contract SubtypeContract Subtype -
_CTR_SUB_TYPE_END_DATE: string
(date)
Title:
Subtype End DateSubtype End Date -
_HRX_COMPETITIVE_CLAUSE: string
Title:
Noncompetitive ClauseMaximum Length:150Noncompetitive Clause -
_HRX_COMPETITIVE_CLAUSE_Display: string
Title:
Noncompetitive ClauseNoncompetitive Clause -
_HRX_EXCLUSIVITY_CLAUSE: string
Title:
Exclusivity ClauseMaximum Length:150Exclusivity Clause -
_HRX_EXCLUSIVITY_CLAUSE_Display: string
Title:
Exclusivity ClauseExclusivity Clause -
_HRX_MOBILITY_CLAUSE: string
Title:
Mobility ClauseMaximum Length:150Mobility Clause -
_HRX_MOBILITY_CLAUSE_Display: string
Title:
Mobility ClauseMobility Clause -
_HRX_OTHER_CLAUSE: string
Title:
Other ClauseMaximum Length:150Other Clause -
_ORA_HRX_FR_DSN_APPR_DIPLOMA_LE: string
Title:
Diploma Level PursuedMaximum Length:150Diploma Level Pursued -
_ORA_HRX_FR_DSN_APPR_DIPLOMA_LE_Display: string
Title:
Diploma Level PursuedDiploma Level Pursued -
ContractId: integer
(int64)
Title:
Contract ID -
dateOfInitiationOfTheDismissal: string
(date)
Title:
Date of Initiation of the Dismissal ProcedureDate of Initiation of the Dismissal Procedure -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
oraHrxFRCddRefusal: string
Title:
Refusal of a Permanent Contract after a Fixed-termMaximum Length:150Refusal of a Permanent Contract after a Fixed-term -
oraHrxFrEmpAffiliation: string
Title:
Employee's Affiliation - Collective Contract MaintenanceMaximum Length:150Employee's Affiliation - Collective Contract Maintenance -
oraHrxFrEmpSpecialStatus: string
Title:
Employee Special StatusMaximum Length:150Employee Special Status -
oraHrxFrEmpSpecialStatus_DisplayValue: string
Title:
Employee Special StatusEmployee Special Status -
oraHrxFrLastDayWorkedPaid: string
(date)
Title:
Last day worked and paid at the usual salaryLast day worked and paid at the usual salary -
oraHrxFrMnthDSNEleFctu: string
(date)
Title:
Month of the monthly DSN carrying the latest elementsMonth of the monthly DSN carrying the latest elements -
oraHrxFrNoticePeriodType: string
Title:
Notice Period TypeMaximum Length:150Notice Period Type -
oraHrxFrNoticePeriodType_DisplayValue: string
Title:
Notice Period TypeNotice Period Type -
oraHrxFrNoticePrdTypeEndDt: string
(date)
Title:
Notice Period Type End DateNotice Period Type End Date -
oraHrxFrTermAgrmntSignDt: string
(date)
Title:
Termination Agreement Signature DateTermination Agreement Signature Date -
oraHrxFRTermNotiDate: string
(date)
Title:
Contract Termination Notification DateContract Termination Notification Date -
oraHrxFRTermReason: string
Title:
Reason for Contract TerminationMaximum Length:150Reason for Contract Termination -
oraHrxFRTermReason_Display: string
Title:
Reason for Contract TerminationReason for Contract Termination -
oraHrxFrTransactionInProgress: string
Title:
Transaction in ProgressMaximum Length:150Transaction in Progress -
OraHrxNoticePeriodTypeStartDt: string
(date)
Title:
Notice Period Type Start DateNotice Period Type Start Date
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFGBVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Default Value:GBContext Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext 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:
LinksThe link relations associated with the resource instance. -
OraHrxGbPsSwcDailyRate: string
Title:
Daily RateMaximum Length:150Daily Rate -
OraHrxGbPsSwcDailyRate_Display: string
Title:
Daily RateDaily Rate -
OraHrxGbPsSwcDestination: string
Title:
DestinationMaximum Length:150Destination -
OraHrxGbPsSwcDestination_Display: string
Title:
DestinationDestination -
OraHrxGbPsSwcLeavingReason: string
Title:
Reason for LeavingMaximum Length:150Reason for Leaving -
OraHrxGbPsSwcLeavingReason_Display: string
Title:
Reason for LeavingReason for Leaving -
OraHrxGbPsSwcOrigin: string
Title:
OriginMaximum Length:150Origin -
OraHrxGbPsSwcOrigin_Display: string
Title:
OriginOrigin -
OraHrxGbPsSwcPayRevDate: string
(date)
Title:
Pay Review DatePay Review Date -
OraHrxGbPsSwcPost: string
Title:
PostMaximum Length:150Post -
OraHrxGbPsSwcPost_Display: string
Title:
PostPost -
OraHrxGbPsSwcSchArrival: string
(date)
Title:
School Arrival DateSchool Arrival Date
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFKWVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Default Value:KWContext Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
_EMPLOYMENT_STATUS: string
Title:
Employment StatusMaximum Length:150Employment Status -
_EMPLOYMENT_STATUS_Display: string
Title:
Employment StatusEmployment 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:
LinksThe 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 ValueMaximum Length:30Default Value:ORA_HRX_BEContext Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
_END_CONTRACT_REASON: string
Title:
End Contract ReasonMaximum Length:150End Contract Reason -
_END_CONTRACT_REASON_Display: string
Title:
End Contract ReasonEnd Contract Reason -
_END_CONTRACT_TYPE: string
Title:
End Contract TypeMaximum Length:150End Contract Type -
_END_CONTRACT_TYPE_Display: string
Title:
End Contract TypeEnd Contract Type -
_END_MANDATORY_DATE: string
(date)
Title:
Mandatory Replacement End DateMandatory Replacement End Date -
_MANDATORY_REPLACEMENT: string
Title:
Mandatory ReplacementMaximum Length:150Mandatory Replacement -
_REPLACING_CONTRACT_NO: string
Title:
Replacement Contract NumberMaximum Length:150Replacement Contract Number -
_REPLACING_PERSON_NO: string
Title:
Replacement Person NumberMaximum Length:150Replacement Person Number -
_WORKING_SCHEDULE_PATTERN: string
Title:
Working Schedule PatternMaximum Length:150Working Schedule Pattern -
_WORKING_SCHEDULE_PATTERN_Display: string
Title:
Working Schedule PatternWorking 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:
LinksThe 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 ValueMaximum Length:30Default Value:ORA_HRX_ITContext Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext 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:
LinksThe link relations associated with the resource instance. -
oraHrxItSublevel: string
Title:
SublevelMaximum Length:150Sublevel -
oraHrxItSublevel_Display: string
Title:
SublevelSublevel -
PerLabourAgreement: number
Title:
Labor AgreementLabor Agreement -
PerLabourAgreement_Display: string
Title:
Labor AgreementLabor Agreement -
PerQualification: string
Title:
QualificationMaximum Length:150Qualification -
PerQualification_Display: string
Title:
QualificationQualification -
PerQualificationLevel: string
Title:
LevelMaximum Length:150Level -
PerQualificationLevel_Display: string
Title:
LevelLevel
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFSAVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Default Value:SAContext Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
_EMPLOYMENT_STATUS: string
Title:
Employment StatusMaximum Length:150Employment Status -
_EMPLOYMENT_STATUS_Display: string
Title:
Employment StatusEmployment Status -
_PROFESSION: string
Title:
ProfessionMaximum Length:150Profession -
ContractId: integer
(int64)
Title:
Contract ID -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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: