Get an extensible flexfield container of location
get
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationsEFFContainer/{locationsEFFContainerUniqID}
Request
Path Parameters
-
locationsEFFContainerUniqID(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=
-
locationsV2UniqID(required): string
This is the hash key of the attributes which make up the composite key for the Locations V2 resource and used to uniquely identify an instance of Locations V2. The client should not generate the hash key value. Instead, the client should query on the Locations V2 collection resource in order to navigate to a specific instance of Locations V2 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 : locationsV2-locationsEFFContainer-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
locationsEFF: array
locationsEFF
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : locationsEFF
Type:
Show Source
array
-
Array of:
object Discriminator: CategoryCode
Discriminator:
{ "propertyName":"CategoryCode", "mapping":{ "HCM_LOC":"#/components/schemas/oracle_apps_hcm_locations_flex_locationextraInfoeff_category_view_j__LocationEitCategoryHcmLocprivateVO-item-response" } }
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 : Discriminator: CategoryCode
Type:
object
Discriminator: CategoryCode
Discriminator Values
Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_locations_flex_locationextraInfoeff_category_view_j__LocationEitCategoryHcmLocprivateVO-item-response
Type:
Show Source
object
-
CategoryCode: string
Maximum Length:
80
Default Value:HCM_LOC
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationExtraInfoJE_5FES_5FPRL_5FNOprivateVO: array
LocationExtraInfoJE_5FES_5FPRL_5FNOprivateVO
-
LocationExtraInfoJE_5FES_5FPRL_5FYESprivateVO: array
LocationExtraInfoJE_5FES_5FPRL_5FYESprivateVO
-
LocationExtraInfoJE_5FES_5FRENTED_5FLOCATIONprivateVO: array
LocationExtraInfoJE_5FES_5FRENTED_5FLOCATIONprivateVO
-
LocationExtraInfoJExESPropertyLocationprivateVO: array
LocationExtraInfoJExESPropertyLocationprivateVO
-
LocationExtraInfoORA_5FPER_5FOPERATIVE_5FLEGAL_5FEMPprivateVO: array
LocationExtraInfoORA_5FPER_5FOPERATIVE_5FLEGAL_5FEMPprivateVO
-
LocationId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : LocationExtraInfoORA_5FPER_5FOPERATIVE_5FLEGAL_5FEMPprivateVO
Type:
Show Source
array
Nested Schema : locationsV2-locationsEFFContainer-locationsEFF-LocationExtraInfoJE_5FES_5FPRL_5FNOprivateVO-item-response
Type:
Show Source
object
-
_Property__Rental: string
Title:
Property Rental
Maximum Length:150
-
_Property__Rental_Display: string
Title:
Property Rental
-
CreatedBy: string
Read Only:
true
Maximum Length:64
-
CreationDate: string
(date-time)
Read Only:
true
-
EffectiveEndDate: string
(date)
-
EffectiveStartDate: string
(date)
-
LastUpdateDate: string
(date-time)
Read Only:
true
-
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
-
LeiInformationCategory: string
Maximum Length:
30
Default Value:JE_ES_PRL_NO
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationExtraInfoId: integer
(int64)
-
LocationId: integer
(int64)
-
SequenceNumber: integer
(int32)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : locationsV2-locationsEFFContainer-locationsEFF-LocationExtraInfoJE_5FES_5FPRL_5FYESprivateVO-item-response
Type:
Show Source
object
-
_Property__Rental: string
Title:
Property Rental
Maximum Length:150
-
_Property__Rental_Display: string
Title:
Property Rental
-
_Rates__Reference: string
Title:
Rates Reference
Maximum Length:150
-
CreatedBy: string
Read Only:
true
Maximum Length:64
-
CreationDate: string
(date-time)
Read Only:
true
-
EffectiveEndDate: string
(date)
-
EffectiveStartDate: string
(date)
-
LastUpdateDate: string
(date-time)
Read Only:
true
-
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
-
LeiInformationCategory: string
Maximum Length:
30
Default Value:JE_ES_PRL_YES
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationExtraInfoId: integer
(int64)
-
LocationId: integer
(int64)
-
SequenceNumber: integer
(int32)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : locationsV2-locationsEFFContainer-locationsEFF-LocationExtraInfoJE_5FES_5FRENTED_5FLOCATIONprivateVO-item-response
Type:
Show Source
object
-
_Door__Num: string
Title:
Door Number
Maximum Length:150
-
_Floor__Num: string
Title:
Floor Number
Maximum Length:150
-
_Property__Rental: string
Title:
Property Rental
Maximum Length:150
-
_Property__Rental_Display: string
Title:
Property Rental
-
_Rates__Reference: string
Title:
Rates Reference
Maximum Length:150
-
_Stair__Num: string
Title:
Stair Number
Maximum Length:150
-
CreatedBy: string
Read Only:
true
Maximum Length:64
-
CreationDate: string
(date-time)
Read Only:
true
-
EffectiveEndDate: string
(date)
-
EffectiveStartDate: string
(date)
-
LastUpdateDate: string
(date-time)
Read Only:
true
-
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
-
LeiInformationCategory: string
Maximum Length:
30
Default Value:JE_ES_RENTED_LOCATION
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationExtraInfoId: integer
(int64)
-
LocationId: integer
(int64)
-
SequenceNumber: integer
(int32)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : locationsV2-locationsEFFContainer-locationsEFF-LocationExtraInfoJExESPropertyLocationprivateVO-item-response
Type:
Show Source
object
-
_Building: string
Title:
Building
Maximum Length:150
-
_City: string
Title:
City
Maximum Length:150
-
_Complement: string
Title:
Complement
Maximum Length:150
-
_Country: string
Title:
Country
Maximum Length:150
-
_Country_Display: string
Title:
Country
-
_Door: string
Title:
Door
Maximum Length:150
-
_Floor: string
Title:
Floor
Maximum Length:150
-
_LandRegistryReference: string
Title:
Land Registry Reference
Maximum Length:150
-
_LocationName: string
Title:
Location Name
Maximum Length:150
-
_LocationNumber: string
Title:
Location Number
Maximum Length:150
-
_LocationType: string
Title:
Location Type
Maximum Length:150
-
_LocationType_Display: string
Title:
Location Type
-
_NumberQualifier: string
Title:
Number Qualifier
Maximum Length:150
-
_NumberQualifier_Display: string
Title:
Number Qualifier
-
_NumberType: string
Title:
Number Type
Maximum Length:150
-
_NumberType_Display: string
Title:
Number Type
-
_Portal: string
Title:
Portal
Maximum Length:150
-
_PostalCode: string
Title:
Postal Code
Maximum Length:150
-
_Province: string
Title:
Province
Maximum Length:150
-
_Province_Display: string
Title:
Province
-
_Stairs: string
Title:
Stairs
Maximum Length:150
-
CreatedBy: string
Read Only:
true
Maximum Length:64
-
CreationDate: string
(date-time)
Read Only:
true
-
EffectiveEndDate: string
(date)
-
EffectiveStartDate: string
(date)
-
LastUpdateDate: string
(date-time)
Read Only:
true
-
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
-
LeiInformationCategory: string
Maximum Length:
30
Default Value:JExESPropertyLocation
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationExtraInfoId: integer
(int64)
-
LocationId: integer
(int64)
-
SequenceNumber: integer
(int32)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : locationsV2-locationsEFFContainer-locationsEFF-LocationExtraInfoORA_5FPER_5FOPERATIVE_5FLEGAL_5FEMPprivateVO-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
-
CreationDate: string
(date-time)
Read Only:
true
-
EffectiveEndDate: string
(date)
-
EffectiveStartDate: string
(date)
-
LastUpdateDate: string
(date-time)
Read Only:
true
-
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
-
LeiInformationCategory: string
Maximum Length:
30
Default Value:ORA_PER_OPERATIVE_LEGAL_EMP
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationExtraInfoId: integer
(int64)
-
LocationId: integer
(int64)
-
oraPerLegalEmployer: number
Title:
Legal Employer
-
oraPerLegalEmployer_Display: string
Title:
Legal Employer
-
SequenceNumber: integer
(int32)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- locationsEFF
-
Parameters:
- locationsEFFContainerUniqID:
$request.path.locationsEFFContainerUniqID
- locationsV2UniqID:
$request.path.locationsV2UniqID
- locationsEFFContainerUniqID: