Update
patch
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationsEFFContainer/{locationsEFFContainerUniqID}/child/locationsEFF/{locationsEFFUniqID}
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=
-
locationsEFFUniqID(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.
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.
Supported Media Types
- application/json
Root 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-patch-request
Type:
Show Source
object
-
CategoryCode: string
Maximum Length:
80
Default Value:HCM_LOC
-
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
Nested Schema : LocationExtraInfoORA_5FPER_5FOPERATIVE_5FLEGAL_5FEMPprivateVO
Type:
Show Source
array
Nested Schema : locationsV2-locationsEFFContainer-locationsEFF-LocationExtraInfoJE_5FES_5FPRL_5FNOprivateVO-item-patch-request
Type:
Show Source
object
-
_Property__Rental: string
Title:
Property Rental
Maximum Length:150
Property Rental -
_Property__Rental_Display: string
Title:
Property Rental
Property Rental -
EffectiveEndDate(required): string
(date)
-
EffectiveStartDate(required): string
(date)
-
LeiInformationCategory: string
Maximum Length:
30
Default Value:JE_ES_PRL_NO
-
LocationExtraInfoId: integer
(int64)
-
LocationId(required): integer
(int64)
-
SequenceNumber: integer
(int32)
Nested Schema : locationsV2-locationsEFFContainer-locationsEFF-LocationExtraInfoJE_5FES_5FPRL_5FYESprivateVO-item-patch-request
Type:
Show Source
object
-
_Property__Rental: string
Title:
Property Rental
Maximum Length:150
Property Rental -
_Property__Rental_Display: string
Title:
Property Rental
Property Rental -
_Rates__Reference: string
Title:
Rates Reference
Maximum Length:150
Rates Reference -
EffectiveEndDate(required): string
(date)
-
EffectiveStartDate(required): string
(date)
-
LeiInformationCategory: string
Maximum Length:
30
Default Value:JE_ES_PRL_YES
-
LocationExtraInfoId: integer
(int64)
-
LocationId(required): integer
(int64)
-
SequenceNumber: integer
(int32)
Nested Schema : locationsV2-locationsEFFContainer-locationsEFF-LocationExtraInfoJE_5FES_5FRENTED_5FLOCATIONprivateVO-item-patch-request
Type:
Show Source
object
-
_Door__Num: string
Title:
Door Number
Maximum Length:150
Door Number -
_Floor__Num: string
Title:
Floor Number
Maximum Length:150
Floor Number -
_Property__Rental: string
Title:
Property Rental
Maximum Length:150
Property Rental -
_Property__Rental_Display: string
Title:
Property Rental
Property Rental -
_Rates__Reference: string
Title:
Rates Reference
Maximum Length:150
Rates Reference -
_Stair__Num: string
Title:
Stair Number
Maximum Length:150
Stair Number -
EffectiveEndDate: string
(date)
-
EffectiveStartDate: string
(date)
-
LeiInformationCategory: string
Maximum Length:
30
Default Value:JE_ES_RENTED_LOCATION
-
LocationExtraInfoId: integer
(int64)
-
LocationId: integer
(int64)
-
SequenceNumber: integer
(int32)
Nested Schema : locationsV2-locationsEFFContainer-locationsEFF-LocationExtraInfoJExESPropertyLocationprivateVO-item-patch-request
Type:
Show Source
object
-
_Building: string
Title:
Building
Maximum Length:150
Building -
_City: string
Title:
City
Maximum Length:150
City -
_Complement: string
Title:
Complement
Maximum Length:150
Complement -
_Country: string
Title:
Country
Maximum Length:150
Country -
_Country_Display: string
Title:
Country
Country -
_Door: string
Title:
Door
Maximum Length:150
Door -
_Floor: string
Title:
Floor
Maximum Length:150
Floor -
_LandRegistryReference: string
Title:
Land Registry Reference
Maximum Length:150
Land Registry Reference -
_LocationName: string
Title:
Location Name
Maximum Length:150
Location Name -
_LocationNumber: string
Title:
Location Number
Maximum Length:150
Location Number -
_LocationType: string
Title:
Location Type
Maximum Length:150
Location Type -
_LocationType_Display: string
Title:
Location Type
Location Type -
_NumberQualifier: string
Title:
Number Qualifier
Maximum Length:150
Number Qualifier -
_NumberQualifier_Display: string
Title:
Number Qualifier
Number Qualifier -
_NumberType: string
Title:
Number Type
Maximum Length:150
Number Type -
_NumberType_Display: string
Title:
Number Type
Number Type -
_Portal: string
Title:
Portal
Maximum Length:150
Portal -
_PostalCode: string
Title:
Postal Code
Maximum Length:150
Postal Code -
_Province: string
Title:
Province
Maximum Length:150
Province -
_Province_Display: string
Title:
Province
Province -
_Stairs: string
Title:
Stairs
Maximum Length:150
Stairs -
EffectiveEndDate: string
(date)
-
EffectiveStartDate: string
(date)
-
LeiInformationCategory: string
Maximum Length:
30
Default Value:JExESPropertyLocation
-
LocationExtraInfoId: integer
(int64)
-
LocationId: integer
(int64)
-
SequenceNumber: integer
(int32)
Nested Schema : locationsV2-locationsEFFContainer-locationsEFF-LocationExtraInfoORA_5FPER_5FOPERATIVE_5FLEGAL_5FEMPprivateVO-item-patch-request
Type:
Show Source
object
-
EffectiveEndDate: string
(date)
-
EffectiveStartDate: string
(date)
-
LeiInformationCategory: string
Maximum Length:
30
Default Value:ORA_PER_OPERATIVE_LEGAL_EMP
-
LocationExtraInfoId: integer
(int64)
-
LocationId: integer
(int64)
-
oraPerLegalEmployer: number
Title:
Legal Employer
Legal Employer -
oraPerLegalEmployer_Display: string
Title:
Legal Employer
Legal Employer -
SequenceNumber: integer
(int32)
Response
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: 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 : 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 : locationsV2-locationsEFFContainer-locationsEFF-LocationExtraInfoJE_5FES_5FPRL_5FNOprivateVO-item-response
Type:
Show Source
object
-
_Property__Rental: string
Title:
Property Rental
Maximum Length:150
Property Rental -
_Property__Rental_Display: string
Title:
Property Rental
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 -
_Property__Rental_Display: string
Title:
Property Rental
Property Rental -
_Rates__Reference: string
Title:
Rates Reference
Maximum Length:150
Rates Reference -
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
Door Number -
_Floor__Num: string
Title:
Floor Number
Maximum Length:150
Floor Number -
_Property__Rental: string
Title:
Property Rental
Maximum Length:150
Property Rental -
_Property__Rental_Display: string
Title:
Property Rental
Property Rental -
_Rates__Reference: string
Title:
Rates Reference
Maximum Length:150
Rates Reference -
_Stair__Num: string
Title:
Stair Number
Maximum Length:150
Stair Number -
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
Building -
_City: string
Title:
City
Maximum Length:150
City -
_Complement: string
Title:
Complement
Maximum Length:150
Complement -
_Country: string
Title:
Country
Maximum Length:150
Country -
_Country_Display: string
Title:
Country
Country -
_Door: string
Title:
Door
Maximum Length:150
Door -
_Floor: string
Title:
Floor
Maximum Length:150
Floor -
_LandRegistryReference: string
Title:
Land Registry Reference
Maximum Length:150
Land Registry Reference -
_LocationName: string
Title:
Location Name
Maximum Length:150
Location Name -
_LocationNumber: string
Title:
Location Number
Maximum Length:150
Location Number -
_LocationType: string
Title:
Location Type
Maximum Length:150
Location Type -
_LocationType_Display: string
Title:
Location Type
Location Type -
_NumberQualifier: string
Title:
Number Qualifier
Maximum Length:150
Number Qualifier -
_NumberQualifier_Display: string
Title:
Number Qualifier
Number Qualifier -
_NumberType: string
Title:
Number Type
Maximum Length:150
Number Type -
_NumberType_Display: string
Title:
Number Type
Number Type -
_Portal: string
Title:
Portal
Maximum Length:150
Portal -
_PostalCode: string
Title:
Postal Code
Maximum Length:150
Postal Code -
_Province: string
Title:
Province
Maximum Length:150
Province -
_Province_Display: string
Title:
Province
Province -
_Stairs: string
Title:
Stairs
Maximum Length:150
Stairs -
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
Legal Employer -
oraPerLegalEmployer_Display: string
Title:
Legal Employer
Legal Employer -
SequenceNumber: integer
(int32)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source