Get
get
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}/child/disabilitiesDDF/{disabilitiesDDFUniqID}
Request
Path Parameters
-
disabilitiesDDFUniqID(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=
-
disabilitiesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- DisabilityId, EffectiveStartDate and EffectiveEndDate ---for the Disabilities resource and used to uniquely identify an instance of Disabilities. The client should not generate the hash key value. Instead, the client should query on the Disabilities collection resource with a filter on the primary key values in order to navigate to a specific instance of Disabilities.
For example: disabilities?q=DisabilityId=<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(required):
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(required):
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_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFAEVO-item-response
-
DE -
object
oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFDEVO-item-response
-
FR -
object
oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFFRVO-item-response
-
HRX_NL_DISABILITY_INFO -
object
oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFHRX__5FNL__5FDISABILITY__5FINFOVO-item-response
-
IN -
object
oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFINVO-item-response
-
KW -
object
oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFKWVO-item-response
-
ORA_HRX_BH -
object
oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFORA__5FHRX__5FBHVO-item-response
-
ORA_HRX_MX_DISABILITY -
object
oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFORA__5FHRX__5FMX__5FDISABILITYVO-item-response
-
ORA_HRX_OM -
object
oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFORA__5FHRX__5FOMVO-item-response
-
ORA_HRX_QA -
object
oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFORA__5FHRX__5FQAVO-item-response
-
SA -
object
oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFSAVO-item-response
-
US -
object
oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFUSVO-item-response
Nested Schema : oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFAEVO-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
-
_ORA_HRX_AE_REPORTING_DESCR: string
Title:
Reporting Description
Maximum Length:150
-
_SOCIAL_SECURITY_RELEVANANCE: string
Title:
Applicable to Social Security
Maximum Length:150
-
_SOCIAL_SECURITY_RELEVANANCE_Display: string
Title:
Applicable to Social Security
-
DisabilityId: integer
(int64)
-
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_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFDEVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Default Value:DE
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
_HRX_DE_DIS_1KL: string
Title:
1. Kl
Maximum Length:150
-
_HRX_DE_DIS_aG: string
Title:
aG
Maximum Length:150
-
_HRX_DE_DIS_AUTH_LOCATION: string
Title:
Authority Location
Maximum Length:150
-
_HRX_DE_DIS_B: string
Title:
B
Maximum Length:150
-
_HRX_DE_DIS_Bl: string
Title:
Bl
Maximum Length:150
-
_HRX_DE_DIS_CERT_AUTHORITY: string
Title:
Certifying Authority
Maximum Length:150
-
_HRX_DE_DIS_CERT_AUTHORITY_Display: string
Title:
Certifying Authority
-
_HRX_DE_DIS_COEQUAL: string
Title:
Coequal
Maximum Length:150
-
_HRX_DE_DIS_DEGREE: string
Title:
Degree
Maximum Length:150
-
_HRX_DE_DIS_DEGREE_Display: string
Title:
Degree
-
_HRX_DE_DIS_EB: string
Title:
EB
Maximum Length:150
-
_HRX_DE_DIS_G: string
Title:
G
Maximum Length:150
-
_HRX_DE_DIS_Gl: string
Title:
Gl
Maximum Length:150
-
_HRX_DE_DIS_H: string
Title:
H
Maximum Length:150
-
_HRX_DE_DIS_MINER_BEN_CERTIF: string
Title:
Miner Benefit Certificate
Maximum Length:150
-
_HRX_DE_DIS_PT_WORK_DETAILS: string
Title:
Part Time Work Details
Maximum Length:150
-
_HRX_DE_DIS_PT_WORK_DETAILS_Display: string
Title:
Part Time Work Details
-
_HRX_DE_DIS_RF: string
Title:
RF
Maximum Length:150
-
_HRX_DE_DIS_VB: string
Title:
VB
Maximum Length:150
-
_HRX_DE_DIS_WORPLACE_COUNT: number
Title:
Workplace Count
-
_HRX_DE_REGISTRATION_ID: string
Title:
Registration ID
Maximum Length:150
-
_HRX_DE_VALID_FROM_DT: string
(date)
Title:
Valid from Date
-
_HRX_DE_VALID_TO_DT: string
(date)
Title:
Valid to Date
-
DisabilityId: integer
(int64)
-
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_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFFRVO-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
-
_DOETH_INCLUDE: string
Title:
Include in the Disability Report
Maximum Length:150
-
_DOETH_INCLUDE_Display: string
Title:
Include in the Disability Report
-
_LONG_UNEMPLOYMENT: string
Title:
Long Unemployment Before Hire
Maximum Length:150
-
_LONG_UNEMPLOYMENT_Display: string
Title:
Long Unemployment Before Hire
-
_PREVIOUS_PLACEMENT: string
Title:
Previous Placement
Maximum Length:150
-
_PREVIOUS_PLACEMENT_Display: string
Title:
Previous Placement
-
_SERIOUS_DISABILITY: string
Title:
Serious Disability
Maximum Length:150
-
_SERIOUS_DISABILITY_DATE: string
(date)
Title:
Serious Disability Recognition Date
-
_SERIOUS_DISABILITY_Display: string
Title:
Serious Disability
-
_SERIOUS_DISABILITY_DURATION: string
Title:
Serious Disability Decision Duration
Maximum Length:150
-
_SERIOUS_DISABILITY_DURATION_Display: string
Title:
Serious Disability Decision Duration
-
DisabilityId: integer
(int64)
-
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_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFHRX__5FNL__5FDISABILITY__5FINFOVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Default Value:HRX_NL_DISABILITY_INFO
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
_DISABILITY_PAYMENT_TYPE: string
Title:
Disability Payment Type
Maximum Length:150
-
_DISABILITY_PAYMENT_TYPE_DisplayValue: string
Title:
Disability Payment Type
-
DisabilityId: integer
(int64)
-
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_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFINVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Default Value:IN
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
_PROOF_ATTACHED: string
Title:
Disability Certificate
Maximum Length:150
-
DisabilityId: integer
(int64)
-
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_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFKWVO-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
-
_DISABILITY_RANGE: string
Title:
Range of Disability
Maximum Length:150
-
_DISABILITY_RANGE_Display: string
Title:
Range of Disability
-
_REPORTING_DESCRIPTION: string
Title:
Reporting Description
Maximum Length:150
-
DisabilityId: integer
(int64)
-
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_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFORA__5FHRX__5FBHVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Default Value:ORA_HRX_BH
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
DisabilityId: integer
(int64)
-
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. -
oraHrxBhRepDesc: string
Title:
Reporting Description
Maximum Length:150
Nested Schema : oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFORA__5FHRX__5FMX__5FDISABILITYVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Default Value:ORA_HRX_MX_DISABILITY
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
_ORA_HRX_MX_DISAB_CONSEQUENCE: string
Title:
Consequence
Maximum Length:150
-
_ORA_HRX_MX_DISAB_CONSEQUENCE_Display: string
Title:
Consequence
-
_ORA_HRX_MX_DISAB_CONTROL: string
Title:
Disability Control
Maximum Length:150
-
_ORA_HRX_MX_DISAB_CONTROL_Display: string
Title:
Disability Control
-
_ORA_HRX_MX_DISAB_SUBSIDIZED: number
Title:
Subsidized Days
-
_ORA_HRX_MX_LABOR_RISK_TYPE: string
Title:
Type of Labor Risk
Maximum Length:150
-
_ORA_HRX_MX_LABOR_RISK_TYPE_Display: string
Title:
Type of Labor Risk
-
_ORA_HRX_MX_RELATED_DISABILITY: string
Title:
Related Disability
Maximum Length:150
-
_ORA_HRX_MX_RELATED_DISABILITY_Display: string
Title:
Related Disability
-
DisabilityId: integer
(int64)
-
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_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFORA__5FHRX__5FOMVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Default Value:ORA_HRX_OM
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
DisabilityId: integer
(int64)
-
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. -
oraHrxOmRepDesc: string
Title:
Reporting Description
Maximum Length:150
Nested Schema : oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFORA__5FHRX__5FQAVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Default Value:ORA_HRX_QA
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
DisabilityId: integer
(int64)
-
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. -
oraHrxQaRptDesc: string
Title:
Reporting Description
Maximum Length:150
Nested Schema : oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFSAVO-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_OFFICE: string
Title:
Employment Office
Maximum Length:150
-
_EMPLOYMENT_OFFICE_Display: string
Title:
Employment Office
-
_ORA_HRX_SA_REPORTING_DESCR: string
Title:
Reporting Description
Maximum Length:150
-
DisabilityId: integer
(int64)
-
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_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFUSVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Default Value:US
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
_ADA_CONFIRMED_BY: number
Title:
Accommodation Confirmed By
-
_ADA_CONFIRMED_BY_Display: string
Title:
Accommodation Confirmed By
-
_ADA_COST: number
Title:
Accommodation Cost
-
_ADA_DATE_CONFIRMED: string
(date)
Title:
Accommodation Approved Date
-
_ADA_DATE_PROVIDED: string
(date)
Title:
Accommodation Provided Date
-
_ADA_DATE_REQUESTED: string
(date)
Title:
Requested Accommodation Date
-
_ADA_DESCRIPTION: string
Title:
Accommodation Description
Maximum Length:150
-
_ADA_STATUS: string
Title:
Requested Accommodation Status
Maximum Length:150
-
_ADA_STATUS_Display: string
Title:
Requested Accommodation Status
-
_ADA_TYPE: string
Title:
Type
Maximum Length:150
-
_ADA_TYPE_Display: string
Title:
Type
-
DisabilityId: integer
(int64)
-
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
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_PERSON_DISABILITY_LEG_DDF
- finder:
- LVVO___FLEX_Context
-
Parameters:
- finder:
ValidValuesFinder%3BBind_ApplicationId%3D800%2CBind_DescriptiveFlexfieldCode%3DPER_PERSON_DISABILITY_LEG_DDF
- finder: