Get a location
get
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}
Request
Path Parameters
-
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
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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-item-response
Type:
Show Source
object-
ActionId: integer
Surrogate identifier for the action being performed on the location.
-
ActionReason: string
Title:
Action ReasonRead Only:trueMaximum Length:80Reason for the action being performed on the record. -
ActionReasonCode: string
Title:
Action Reason CodeMaximum Length:30Reason code for the action being performed on the record. Valid values are defined in the actionReasonsLOV. -
ActionReasonId: integer
Title:
Action ReasonUnique identifier of the action reason. -
ActiveStatus: string
Title:
Status CodeMaximum Length:30Default Value:AStatus of the location, such as active. -
ActiveStatusMeaning: string
Title:
StatusRead Only:trueMaximum Length:80Meaning of the status of the location. -
addresses: array
Addresses
Title:
AddressesThe addresses resource is a child of the locations resource. It provides all the addresses of the location including the main address as of the specified date. By default, the current date is retained. -
AnnualWorkingDurationUnits: string
Title:
Annual Working Duration Units CodeMaximum Length:10Code of the unit of the location's standard annual working duration. -
AnnualWorkingDurationUnitsMeaning: string
Title:
Annual Working Duration UnitsRead Only:trueMaximum Length:80Meaning of the unit of the location's standard annual working duration. -
attachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
bannerOverrideMessages: array
Banner Override Messages
Title:
Banner Override MessagesThe bannerOverrideMessages resource provides all the status information and related messages for an object. -
BillToSiteFlag: boolean
Title:
Bill-to SiteMaximum Length:30Default Value:trueIndicates whether the location is a bill to site. The default value is true. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64User who created the location record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate and time when the location record was created. -
Description: string
Title:
DescriptionMaximum Length:240Description of the location. -
DesignatedReceiverId: integer
(int64)
Title:
Designated Receiver IDUnique identifier for the person designated as the receiver for the location. -
DesignatedReceiverName: string
Title:
Designated ReceiverRead Only:trueMaximum Length:240Name of the person designated as the receiver for the location. -
DesignatedReceiverNumber: string
Title:
Designated Receiver NumberMaximum Length:30Number for the person designated as the receiver for the location. -
EffectiveEndDate: string
(date)
Title:
Effective End DateEffective end date of the location. -
EffectiveStartDate: string
(date)
Title:
Effective Start DateEffective start date of the location. -
EmailAddress: string
Title:
EmailMaximum Length:240Email address for the location. -
EmployeeLocationFlag: boolean
Title:
Employee LocationMaximum Length:1Default Value:trueIndicates whether the location is an employee location. The default value is true. -
FaxAreaCode: string
Title:
Fax Area CodeMaximum Length:60Area code of the fax number for the location. -
FaxCountryCode: string
Title:
Fax Country CodeMaximum Length:30Country code of the fax number for the location. -
FaxExtension: string
Title:
Fax ExtensionMaximum Length:60Extension for the fax number of the location. -
FaxNumber: string
Title:
Fax NumberMaximum Length:60Local fax number for the location. -
GeoHierarchyNodeCode: string
Title:
Geographic Hierarchy CodeMaximum Length:100Code of the geography tree node for the location. -
GeoHierarchyNodeName: string
Title:
Geographic HierarchyRead Only:trueMaximum Length:80Name of the geography tree node for the location. -
InventoryOrganizationId: integer
(int64)
Title:
Inventory Organization IDUnique identifier for the inventory organization. -
InventoryOrganizationName: string
Title:
Inventory OrganizationMaximum Length:240Name of the inventory organization. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate and time when the location record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64User who last updated the location record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LocationCode: string
Title:
CodeMaximum Length:120Code that uniquely references the location within the set. -
LocationId: integer
(int64)
Title:
Location IDSurrogate identifier for the location. -
locationLegislativeEFF: array
locationLegislativeEFF
-
LocationName: string
Title:
NameMaximum Length:60Name of the location. -
locationsDFF: array
locationsDFF
-
locationsEFFContainer: array
Locations Extensible Flexfields Container
Title:
Locations Extensible Flexfields ContainerThe locationEFFContainer resource is a child of the locations resource. It's a container for the locations extensible flexfields. -
MainPhoneAreaCode: string
Title:
Main Phone Area CodeMaximum Length:60Area code of the main phone number for the location. -
MainPhoneCountryCode: string
Title:
Main Phone Country CodeMaximum Length:30Country code of the main phone number for the location. -
MainPhoneExtension: string
Title:
Main Phone ExtensionMaximum Length:60Extension for the main phone number for the location. -
MainPhoneNumber: string
Title:
Main Phone NumberMaximum Length:60Local main phone number for the location. -
OfficeSiteFlag: boolean
Title:
Office SiteMaximum Length:30Default Value:trueIndicates whether the location is an office site. The default value is true. -
OfficialLanguageCode: string
Title:
Official Language CodeMaximum Length:30Code of the location's official language. -
OfficialLanguageMeaning: string
Title:
Official LanguageRead Only:trueMaximum Length:80Name of the location's official language. -
OtherPhoneAreaCode: string
Title:
Other Phone Area CodeMaximum Length:60Area code of the other phone number for the location. -
OtherPhoneCountryCode: string
Title:
Other Phone Country CodeMaximum Length:30Country code of the other phone number for the location. -
OtherPhoneExtension: string
Title:
Other Phone ExtensionMaximum Length:60Extension for the other phone number of the location. -
OtherPhoneNumber: string
Title:
Other Phone NumberMaximum Length:60Local number of the other phone number for the location. -
ReceivingSiteFlag: boolean
Title:
Receiving SiteMaximum Length:30Default Value:trueIndicates whether the location is a receiving site. The default value is true. -
SetCode: string
Title:
Set CodeMaximum Length:30Code of the set to which the location belongs. -
SetId: integer
(int64)
Title:
Set IDSurrogate identifier for the set to which the location belongs. -
SetName: string
Title:
Set NameRead Only:trueMaximum Length:80Name of the set to which the location belongs. -
ShipToLocationCode: string
Title:
Ship-to Location CodeMaximum Length:120Code for the ship to location. -
ShipToLocationId: integer
(int64)
Title:
Ship-to Location IDUnique identifier for the ship to location. -
ShipToLocationName: string
Title:
Ship-to LocationRead Only:trueMaximum Length:60Name of the ship to location. -
ShipToSiteFlag: boolean
Title:
Ship-to SiteMaximum Length:30Default Value:trueIndicates whether the location is a ship to site. The default value is true. -
StandardAnnualWorkingDuration: number
Title:
Standard Annual Working DurationStandard annual working duration for the location. -
StandardWorkingFrequency: string
Title:
Standard Working Frequency CodeMaximum Length:30Code of the frequency of the location's standard working hours. -
StandardWorkingFrequencyMeaning: string
Title:
Standard Working Hours FrequencyRead Only:trueMaximum Length:80Meaning of the frequency of the location's standard working hours. -
StandardWorkingHours: number
Title:
Standard Working HoursNumber of standard working hours for the location.
Nested Schema : Addresses
Type:
arrayTitle:
AddressesThe addresses resource is a child of the locations resource. It provides all the addresses of the location including the main address as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : locationLegislativeEFF
Type:
Show Source
array-
Array of:
object Discriminator: CategoryCode
Discriminator:
{ "propertyName":"CategoryCode", "mapping":{ "HCM_LOC_LEG":"#/components/schemas/oracle_apps_hcm_locations_flex_locationlegeff_category_view_j__LocationLegCategoryHcmLocLegprivateVO-item-response" } }
Nested Schema : Locations Extensible Flexfields Container
Type:
arrayTitle:
Locations Extensible Flexfields ContainerThe locationEFFContainer resource is a child of the locations resource. It's a container for the locations extensible flexfields.
Show Source
Nested Schema : locationsV2-addresses-item-response
Type:
Show Source
object-
AddlAddressAttribute1: string
Title:
Additional Address Attribute 1Maximum Length:150Additional address attribute, used by localizations. -
AddlAddressAttribute2: string
Title:
Additional Address Attribute 2Maximum Length:150Additional address attribute, used by localizations. -
AddlAddressAttribute3: string
Title:
Additional Address Attribute 3Maximum Length:150Additional address attribute, used by localizations. -
AddlAddressAttribute4: string
Title:
Additional Address Attribute 4Maximum Length:150Additional address attribute, used by localizations. -
AddlAddressAttribute5: string
Title:
Additional Address Attribute 5Maximum Length:150Additional address attribute, used by localizations. -
AddressLine1: string
Title:
Address Line 1Maximum Length:240First line of the location address. -
AddressLine2: string
Title:
Address Line 2Maximum Length:240Second line of the location address. -
AddressLine3: string
Title:
Address Line 3Maximum Length:240Third line of the location address. -
AddressLine4: string
Title:
Address Line 4Maximum Length:240Fourth line of the location address. -
AddressUsageType: string
Title:
Address Usage Type CodeMaximum Length:30Type of the address usage. -
AddressUsageTypeMeaning: string
Title:
Location Address TypeRead Only:trueMaximum Length:80Meaning of the address usage. -
Building: string
Title:
BuildingMaximum Length:240Building name of the address. -
Country: string
Title:
CountryMaximum Length:60Country for the location address. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64User who created the address record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate and time when the address record was created. -
EffectiveEndDate: string
(date)
Title:
Effective End DateEffective end date for the location address. -
EffectiveStartDate: string
(date)
Title:
Effective Start DateEffective start date for the location address. -
FloorNumber: string
Title:
Floor NumberMaximum Length:40Floor number of the address. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate and time when the address record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64User who last updated the address record. -
Latitude: number
Title:
LatitudeDistance between the equator and a location address located to its north or south, expressed in degrees and minutes. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LocAddressUsageId: integer
(int64)
Title:
Location Address Usage IDUnique identifier for the address usage type. -
Longitude: number
Title:
LongitudeDistance between the prime meridian and a location address located to its east or west, expressed in degrees and minutes. -
LongPostalCode: string
Title:
Long Postal CodeMaximum Length:30Long postal code for the location address. Long postal codes are used in some countries in addition to the short postal codes. -
PostalCode: string
Title:
Postal CodeMaximum Length:30Postal code for the location address. -
Provider: string
Title:
ProviderMaximum Length:150Company that has validated a location address. -
Region1: string
Title:
Region 1Maximum Length:120Primary region in which the address is located. This value may be required depending on the country specified. -
Region2: string
Title:
Region 2Maximum Length:120Secondary region withing the primary region. -
Region3: string
Title:
Region 3Maximum Length:120Subregion within the secondary region. -
Timezone: string
Title:
Time ZoneRead Only:trueTime zone of the location address. -
TimezoneCode: string
Title:
Time Zone CodeMaximum Length:50Code of the time zone. -
TownOrCity: string
Title:
Town or CityMaximum Length:60Town or city of the location address. This value may be required depending on the country specified. -
ValidateAddressFlag: boolean
Default Value:
falseIndicates whether the location address needs to be validated. Valid values are true and false. The default value is false. -
ValidationStatusCode: string
Title:
Validation Status CodeMaximum Length:120Level of accuracy of a location address as determined by an address provider.
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 : locationsV2-attachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Discriminator: CategoryCode
Type:
objectDiscriminator: CategoryCode
Discriminator Values
Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_locations_flex_locationlegeff_category_view_j__LocationLegCategoryHcmLocLegprivateVO-item-response
Type:
Show Source
object-
CategoryCode: string
Maximum Length:
80Default Value:HCM_LOC_LEG -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LocationId: integer
(int64)
-
LocationLegislativeHRX_5FCA_5FLOC_5FEER_5FRULESprivateVO: array
LocationLegislativeHRX_5FCA_5FLOC_5FEER_5FRULESprivateVO
-
LocationLegislativeHRX_5FFR_5FEXT_5FREPORTING_5FINFOprivateVO: array
LocationLegislativeHRX_5FFR_5FEXT_5FREPORTING_5FINFOprivateVO
-
LocationLegislativeHRX_5FUS_5FEEO1_5FINFORMATIONprivateVO: array
LocationLegislativeHRX_5FUS_5FEEO1_5FINFORMATIONprivateVO
-
LocationLegislativeHRX_5FUS_5FLOC_5FEEO_5FVETS_5FINFprivateVO: array
LocationLegislativeHRX_5FUS_5FLOC_5FEEO_5FVETS_5FINFprivateVO
-
LocationLegislativeHRX_5FUS_5FMWS_5FINFORMATIONprivateVO: array
LocationLegislativeHRX_5FUS_5FMWS_5FINFORMATIONprivateVO
-
LocationLegislativeHRX_5FUS_5FPA_5FPSD_5FINFORMATIONprivateVO: array
LocationLegislativeHRX_5FUS_5FPA_5FPSD_5FINFORMATIONprivateVO
-
LocationLegislativeHRX_5FUS_5FREPORTING_5FINFORMATIONprivateVO: array
LocationLegislativeHRX_5FUS_5FREPORTING_5FINFORMATIONprivateVO
-
LocationLegislativeHRX_5FUS_5FUNEMPLOYMENT_5FREPORTINGprivateVO: array
LocationLegislativeHRX_5FUS_5FUNEMPLOYMENT_5FREPORTINGprivateVO
-
LocationLegislativeHRX_5FUS_5FVETS_5FINFORMATIONprivateVO: array
LocationLegislativeHRX_5FUS_5FVETS_5FINFORMATIONprivateVO
-
LocationLegislativeORA_5FHRX_5FCA_5FPM_5FLOCprivateVO: array
LocationLegislativeORA_5FHRX_5FCA_5FPM_5FLOCprivateVO
-
LocationLegislativeORA_5FHRX_5FCA_5FWC_5FLOCprivateVO: array
LocationLegislativeORA_5FHRX_5FCA_5FWC_5FLOCprivateVO
-
LocationLegislativeORA_5FHRX_5FIN_5FEMPLR_5FCONT_5FINFOprivateVO: array
LocationLegislativeORA_5FHRX_5FIN_5FEMPLR_5FCONT_5FINFOprivateVO
-
LocationLegislativeORA_5FHRX_5FUS_5FWORK_5FTAX_5FJURDprivateVO: array
LocationLegislativeORA_5FHRX_5FUS_5FWORK_5FTAX_5FJURDprivateVO
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : LocationLegislativeHRX_5FFR_5FEXT_5FREPORTING_5FINFOprivateVO
Type:
Show Source
arrayNested Schema : LocationLegislativeHRX_5FUS_5FLOC_5FEEO_5FVETS_5FINFprivateVO
Type:
Show Source
arrayNested Schema : LocationLegislativeHRX_5FUS_5FPA_5FPSD_5FINFORMATIONprivateVO
Type:
Show Source
arrayNested Schema : LocationLegislativeHRX_5FUS_5FREPORTING_5FINFORMATIONprivateVO
Type:
Show Source
arrayNested Schema : LocationLegislativeHRX_5FUS_5FUNEMPLOYMENT_5FREPORTINGprivateVO
Type:
Show Source
arrayNested Schema : LocationLegislativeORA_5FHRX_5FIN_5FEMPLR_5FCONT_5FINFOprivateVO
Type:
Show Source
arrayNested Schema : LocationLegislativeORA_5FHRX_5FUS_5FWORK_5FTAX_5FJURDprivateVO
Type:
Show Source
arrayNested Schema : locationsV2-locationLegislativeEFF-LocationLegislativeHRX_5FCA_5FLOC_5FEER_5FRULESprivateVO-item-response
Type:
Show Source
object-
_CMA_CODE: string
Title:
Census Metropolitan AreaMaximum Length:150Census Metropolitan Area -
_CMA_CODE_Display: string
Title:
Census Metropolitan AreaCensus Metropolitan Area -
CreatedBy: string
Read Only:
trueMaximum 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:
trueMaximum Length:64 -
LegislationCode: string
Maximum Length:
30Default Value:LleInformationCategory -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LleInformationCategory: string
Maximum Length:
30Default Value:HRX_CA_LOC_EER_RULES -
LocationId: integer
(int64)
-
LocationLegId: integer
(int64)
-
SequenceNumber: integer
(int32)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : locationsV2-locationLegislativeEFF-LocationLegislativeHRX_5FFR_5FEXT_5FREPORTING_5FINFOprivateVO-item-response
Type:
Show Source
object-
_ISSUER_NUMBER: string
Title:
Issuer NumberMaximum Length:150Issuer Number -
_LOCATION_TYPE: string
Title:
Location TypeMaximum Length:150Location Type -
_LOCATION_TYPE_Display: string
Title:
Location TypeLocation Type -
_ORG_SIRET: string
Title:
Organization SIRETMaximum Length:150Organization SIRET -
_REPORTING_CODE: string
Title:
Reporting CodeMaximum Length:150Reporting Code -
CreatedBy: string
Read Only:
trueMaximum 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:
trueMaximum Length:64 -
LegislationCode: string
Maximum Length:
30Default Value:LleInformationCategory -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LleInformationCategory: string
Maximum Length:
30Default Value:HRX_FR_EXT_REPORTING_INFO -
LocationId: integer
(int64)
-
LocationLegId: integer
(int64)
-
SequenceNumber: integer
(int32)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : locationsV2-locationLegislativeEFF-LocationLegislativeHRX_5FUS_5FEEO1_5FINFORMATIONprivateVO-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64 -
CreationDate: string
(date-time)
Read Only:
true -
EffectiveEndDate: string
(date)
-
EffectiveStartDate: string
(date)
-
headquartersEstablishment: string
Title:
Headquarters EstablishmentMaximum Length:150Headquarters Establishment -
headquartersEstablishment_Display: string
Title:
Headquarters EstablishmentHeadquarters Establishment -
LastUpdateDate: string
(date-time)
Read Only:
true -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64 -
LegislationCode: string
Maximum Length:
30Default Value:LleInformationCategory -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LleInformationCategory: string
Maximum Length:
30Default Value:HRX_US_EEO1_INFORMATION -
LocationId: integer
(int64)
-
LocationLegId: integer
(int64)
-
SequenceNumber: integer
(int32)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : locationsV2-locationLegislativeEFF-LocationLegislativeHRX_5FUS_5FLOC_5FEEO_5FVETS_5FINFprivateVO-item-response
Type:
Show Source
object-
_HR_REPORTING_LOCATION: string
Title:
HR Reporting LocationMaximum Length:150HR Reporting Location -
_HR_REPORTING_LOCATION_DisplayValue: string
Title:
HR Reporting LocationHR Reporting Location -
_HR_REPORTING_PROXY: number
Title:
HR Reporting ProxyHR Reporting Proxy -
_HR_REPORTING_PROXY_Display: string
Title:
HR Reporting ProxyHR Reporting Proxy -
CreatedBy: string
Read Only:
trueMaximum 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:
trueMaximum Length:64 -
LegislationCode: string
Maximum Length:
30Default Value:LleInformationCategory -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LleInformationCategory: string
Maximum Length:
30Default Value:HRX_US_LOC_EEO_VETS_INF -
LocationId: integer
(int64)
-
LocationLegId: integer
(int64)
-
SequenceNumber: integer
(int32)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : locationsV2-locationLegislativeEFF-LocationLegislativeHRX_5FUS_5FMWS_5FINFORMATIONprivateVO-item-response
Type:
Show Source
object-
_MWS_COMMENT: string
Title:
CommentMaximum Length:150Comment -
_MWS_REPORTING_DESC: string
Title:
Worksite DescriptionMaximum Length:150Worksite Description -
_MWS_REPORTING_INCLUDE: string
Title:
Include for ReportingMaximum Length:150Include for Reporting -
_MWS_REPORTING_INCLUDE_DisplayValue: string
Title:
Include for ReportingInclude for Reporting -
_MWS_REPORTING_NAME: string
Title:
Trade NameMaximum Length:150Trade Name -
_MWS_UNIT_NUMBER: string
Title:
Unit NumberMaximum Length:150Unit Number -
CreatedBy: string
Read Only:
trueMaximum 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:
trueMaximum Length:64 -
LegislationCode: string
Maximum Length:
30Default Value:LleInformationCategory -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LleInformationCategory: string
Maximum Length:
30Default Value:HRX_US_MWS_INFORMATION -
LocationId: integer
(int64)
-
LocationLegId: integer
(int64)
-
SequenceNumber: integer
(int32)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : locationsV2-locationLegislativeEFF-LocationLegislativeHRX_5FUS_5FPA_5FPSD_5FINFORMATIONprivateVO-item-response
Type:
Show Source
object-
_PA_NONRESIDENT_EIT_RATE: string
Title:
Nonresident EIT Rate for Pennsylvania Work LocationMaximum Length:150Nonresident EIT Rate for Pennsylvania Work Location -
_PA_WORK_PSD_CODE: string
Title:
PSD Code for Pennsylvania Work LocationMaximum Length:150PSD Code for Pennsylvania Work Location -
_PA_WORK_PSD_CODE_Display: string
Title:
PSD Code for Pennsylvania Work LocationPSD Code for Pennsylvania Work Location -
CreatedBy: string
Read Only:
trueMaximum 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:
trueMaximum Length:64 -
LegislationCode: string
Maximum Length:
30Default Value:LleInformationCategory -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LleInformationCategory: string
Maximum Length:
30Default Value:HRX_US_PA_PSD_INFORMATION -
LocationId: integer
(int64)
-
LocationLegId: integer
(int64)
-
SequenceNumber: integer
(int32)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : locationsV2-locationLegislativeEFF-LocationLegislativeHRX_5FUS_5FREPORTING_5FINFORMATIONprivateVO-item-response
Type:
Show Source
object-
_DUNS_NUMBER: string
Title:
D-U-N-S NumberMaximum Length:150D-U-N-S Number -
_GOVERNMENT_CONTRACTOR: string
Title:
Government ContractorMaximum Length:150Government Contractor -
_GOVERNMENT_CONTRACTOR_Display: string
Title:
Government ContractorGovernment Contractor -
_NAICS_NUMBER: string
Title:
NAICS NumberMaximum Length:150NAICS Number -
CreatedBy: string
Read Only:
trueMaximum Length:64 -
CreationDate: string
(date-time)
Read Only:
true -
EffectiveEndDate: string
(date)
-
EffectiveStartDate: string
(date)
-
establishmentComments1: string
Title:
Establishment Comments1Maximum Length:150Establishment Comments1 -
establishmentComments2: string
Title:
Establishment Comments2Maximum Length:150Establishment Comments2 -
includedLastYearInCaPayDataRep: string
Title:
Included Last Year in CA Pay Data ReportMaximum Length:150Included Last Year in CA Pay Data Report -
includedLastYearInCaPayDataRep_DisplayValue: string
Title:
Included Last Year in CA Pay Data ReportIncluded Last Year in CA Pay Data Report -
LastUpdateDate: string
(date-time)
Read Only:
true -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64 -
LegislationCode: string
Maximum Length:
30Default Value:LleInformationCategory -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LleInformationCategory: string
Maximum Length:
30Default Value:HRX_US_REPORTING_INFORMATION -
LocationId: integer
(int64)
-
LocationLegId: integer
(int64)
-
locationUniqueKey: number
Title:
Location Unique KeyLocation Unique Key -
mainActivitiesLine1: string
Title:
Main Activities, Line 1Maximum Length:150Main Activities, Line 1 -
mainActivitiesLine2: string
Title:
Main Activities, Line 2Maximum Length:150Main Activities, Line 2 -
reportedLastYear: string
Title:
Included Last Year in EEO1 ReportMaximum Length:150Included Last Year in EEO1 Report -
reportedLastYear_DisplayValue: string
Title:
Included Last Year in EEO1 ReportIncluded Last Year in EEO1 Report -
reportingName: string
Title:
Unit NameMaximum Length:150Unit Name -
SequenceNumber: integer
(int32)
-
taxReportingUnit: number
Title:
Tax Reporting UnitTax Reporting Unit -
taxReportingUnit_Display: string
Title:
Tax Reporting UnitTax Reporting Unit -
uniqueEntityId: string
Title:
Unique Entity IDMaximum Length:150Unique Entity ID -
unitNumber: string
Title:
Unit NumberMaximum Length:150Unit Number
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : locationsV2-locationLegislativeEFF-LocationLegislativeHRX_5FUS_5FUNEMPLOYMENT_5FREPORTINGprivateVO-item-response
Type:
Show Source
object-
_EMPLOYER_UNIT_NUMBER: integer
(int32)
Title:
Employer Unit NumberEmployer Unit Number -
CreatedBy: string
Read Only:
trueMaximum 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:
trueMaximum Length:64 -
LegislationCode: string
Maximum Length:
30Default Value:LleInformationCategory -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LleInformationCategory: string
Maximum Length:
30Default Value:HRX_US_UNEMPLOYMENT_REPORTING -
LocationId: integer
(int64)
-
LocationLegId: integer
(int64)
-
SequenceNumber: integer
(int32)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : locationsV2-locationLegislativeEFF-LocationLegislativeHRX_5FUS_5FVETS_5FINFORMATIONprivateVO-item-response
Type:
Show Source
object-
_HIRING_LOC_NUM: string
Title:
Hiring Location NumberMaximum Length:150Hiring Location Number -
_MAX_NUM_EMP: integer
(int32)
Title:
Maximum Number of EmployeesMaximum Number of Employees -
_MIN_NUM_EMP: integer
(int32)
Title:
Minimum Number of EmployeesMinimum Number of Employees -
_VETS_REPORTING_NAME: string
Title:
Reporting NameMaximum Length:150Reporting Name -
CreatedBy: string
Read Only:
trueMaximum 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:
trueMaximum Length:64 -
LegislationCode: string
Maximum Length:
30Default Value:LleInformationCategory -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LleInformationCategory: string
Maximum Length:
30Default Value:HRX_US_VETS_INFORMATION -
LocationId: integer
(int64)
-
LocationLegId: integer
(int64)
-
SequenceNumber: integer
(int32)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : locationsV2-locationLegislativeEFF-LocationLegislativeORA_5FHRX_5FCA_5FPM_5FLOCprivateVO-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum 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:
trueMaximum Length:64 -
LegislationCode: string
Maximum Length:
30Default Value:LleInformationCategory -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LleInformationCategory: string
Maximum Length:
30Default Value:ORA_HRX_CA_PM_LOC -
LocationId: integer
(int64)
-
LocationLegId: integer
(int64)
-
oraHrxCaPmLocAccount: string
Title:
Provincial Medical Account OverrideMaximum Length:150Provincial Medical Account Override -
oraHrxCaPmLocAccount_Display: string
Title:
Provincial Medical Account OverrideProvincial Medical Account Override -
oraHrxCaPmLocPsu: number
Title:
Provincial Medical Payroll Statutory UnitProvincial Medical Payroll Statutory Unit -
oraHrxCaPmLocPsu_Display: string
Title:
Provincial Medical Payroll Statutory UnitProvincial Medical Payroll Statutory Unit -
oraHrxCaPmLocUniqueSeg: number
Title:
Identifies the Location context uniquelyIdentifies the Location context uniquely -
SequenceNumber: integer
(int32)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : locationsV2-locationLegislativeEFF-LocationLegislativeORA_5FHRX_5FCA_5FWC_5FLOCprivateVO-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum 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:
trueMaximum Length:64 -
LegislationCode: string
Maximum Length:
30Default Value:LleInformationCategory -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LleInformationCategory: string
Maximum Length:
30Default Value:ORA_HRX_CA_WC_LOC -
LocationId: integer
(int64)
-
LocationLegId: integer
(int64)
-
oraHrxCaWcLocClUnit: string
Title:
Workers Compensation Classification Unit OverrideMaximum Length:150Workers Compensation Classification Unit Override -
oraHrxCaWcLocClUnit_Display: string
Title:
Workers Compensation Classification Unit OverrideWorkers Compensation Classification Unit Override -
oraHrxCaWcLocPsu: number
Title:
Workers Compensation Payroll Statutory UnitWorkers Compensation Payroll Statutory Unit -
oraHrxCaWcLocPsu_Display: string
Title:
Workers Compensation Payroll Statutory UnitWorkers Compensation Payroll Statutory Unit -
oraHrxCaWcLocUniqueSeg: number
Title:
Identifies the WC Location context uniquelyIdentifies the WC Location context uniquely -
SequenceNumber: integer
(int32)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : locationsV2-locationLegislativeEFF-LocationLegislativeORA_5FHRX_5FIN_5FEMPLR_5FCONT_5FINFOprivateVO-item-response
Type:
Show Source
object-
alternateEmailId: string
Title:
Alternate Email IDMaximum Length:150Alternate Email ID -
CreatedBy: string
Read Only:
trueMaximum 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:
trueMaximum Length:64 -
LegislationCode: string
Maximum Length:
30Default Value:LleInformationCategory -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LleInformationCategory: string
Maximum Length:
30Default Value:ORA_HRX_IN_EMPLR_CONT_INFO -
LocationId: integer
(int64)
-
LocationLegId: integer
(int64)
-
SequenceNumber: integer
(int32)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : locationsV2-locationLegislativeEFF-LocationLegislativeORA_5FHRX_5FUS_5FWORK_5FTAX_5FJURDprivateVO-item-response
Type:
Show Source
object-
city: string
Title:
CityMaximum Length:150City -
city_Display: string
Title:
CityCity -
county: string
Title:
CountyMaximum Length:150County -
county_Display: string
Title:
CountyCounty -
CreatedBy: string
Read Only:
trueMaximum Length:64 -
CreationDate: string
(date-time)
Read Only:
true -
EffectiveEndDate: string
(date)
-
EffectiveStartDate: string
(date)
-
geocode: string
Title:
GeocodeMaximum Length:150Geocode -
LastUpdateDate: string
(date-time)
Read Only:
true -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64 -
LegislationCode: string
Maximum Length:
30Default Value:LleInformationCategory -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LleInformationCategory: string
Maximum Length:
30Default Value:ORA_HRX_US_WORK_TAX_JURD -
localWagesTaxation: string
Title:
Within City LimitsMaximum Length:150Within City Limits -
localWagesTaxation_Display: string
Title:
Within City LimitsWithin City Limits -
LocationId: integer
(int64)
-
LocationLegId: integer
(int64)
-
paPsdCode: string
Title:
PA PSD CodeMaximum Length:150PA PSD Code -
paPsdCode_Display: string
Title:
PA PSD CodePA PSD Code -
schoolDistrict: string
Title:
School DistrictMaximum Length:150School District -
schoolDistrict_Display: string
Title:
School DistrictSchool District -
SequenceNumber: integer
(int32)
-
specialTaxDistrict: string
Title:
Special Tax DistrictMaximum Length:150Special Tax District -
specialTaxDistrict_Display: string
Title:
Special Tax DistrictSpecial Tax District -
state: string
Title:
StateMaximum Length:150State -
state_Display: string
Title:
StateState -
taxAddress: string
Title:
Tax AddressMaximum Length:150Tax Address -
taxAddressId: string
Title:
Tax Address IDMaximum Length:150Tax Address ID -
taxDistrict: string
Title:
Tax DistrictMaximum Length:150Tax District -
taxDistrict_Display: string
Title:
Tax DistrictTax District
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : locationsV2-locationsDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
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. -
LocationDetailsId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : locationsV2-locationsEFFContainer-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
locationsEFF: array
locationsEFF
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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 : Discriminator: CategoryCode
Type:
objectDiscriminator: 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:
80Default Value:HCM_LOC -
links: array
Links
Title:
LinksThe 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : LocationExtraInfoORA_5FPER_5FOPERATIVE_5FLEGAL_5FEMPprivateVO
Type:
Show Source
arrayNested Schema : locationsV2-locationsEFFContainer-locationsEFF-LocationExtraInfoJE_5FES_5FPRL_5FNOprivateVO-item-response
Type:
Show Source
object-
_Property__Rental: string
Title:
Property RentalMaximum Length:150Property Rental -
_Property__Rental_Display: string
Title:
Property RentalProperty Rental -
CreatedBy: string
Read Only:
trueMaximum 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:
trueMaximum Length:64 -
LeiInformationCategory: string
Maximum Length:
30Default Value:JE_ES_PRL_NO -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LocationExtraInfoId: integer
(int64)
-
LocationId: integer
(int64)
-
SequenceNumber: integer
(int32)
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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 RentalMaximum Length:150Property Rental -
_Property__Rental_Display: string
Title:
Property RentalProperty Rental -
_Rates__Reference: string
Title:
Rates ReferenceMaximum Length:150Rates Reference -
CreatedBy: string
Read Only:
trueMaximum 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:
trueMaximum Length:64 -
LeiInformationCategory: string
Maximum Length:
30Default Value:JE_ES_PRL_YES -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LocationExtraInfoId: integer
(int64)
-
LocationId: integer
(int64)
-
SequenceNumber: integer
(int32)
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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 NumberMaximum Length:150Door Number -
_Floor__Num: string
Title:
Floor NumberMaximum Length:150Floor Number -
_Property__Rental: string
Title:
Property RentalMaximum Length:150Property Rental -
_Property__Rental_Display: string
Title:
Property RentalProperty Rental -
_Rates__Reference: string
Title:
Rates ReferenceMaximum Length:150Rates Reference -
_Stair__Num: string
Title:
Stair NumberMaximum Length:150Stair Number -
CreatedBy: string
Read Only:
trueMaximum 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:
trueMaximum Length:64 -
LeiInformationCategory: string
Maximum Length:
30Default Value:JE_ES_RENTED_LOCATION -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LocationExtraInfoId: integer
(int64)
-
LocationId: integer
(int64)
-
SequenceNumber: integer
(int32)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : locationsV2-locationsEFFContainer-locationsEFF-LocationExtraInfoJExESPropertyLocationprivateVO-item-response
Type:
Show Source
object-
_Building: string
Title:
BuildingMaximum Length:150Building -
_City: string
Title:
CityMaximum Length:150City -
_Complement: string
Title:
ComplementMaximum Length:150Complement -
_Country: string
Title:
CountryMaximum Length:150Country -
_Country_Display: string
Title:
CountryCountry -
_Door: string
Title:
DoorMaximum Length:150Door -
_Floor: string
Title:
FloorMaximum Length:150Floor -
_LandRegistryReference: string
Title:
Land Registry ReferenceMaximum Length:150Land Registry Reference -
_LocationName: string
Title:
Location NameMaximum Length:150Location Name -
_LocationNumber: string
Title:
Location NumberMaximum Length:150Location Number -
_LocationType: string
Title:
Location TypeMaximum Length:150Location Type -
_LocationType_Display: string
Title:
Location TypeLocation Type -
_NumberQualifier: string
Title:
Number QualifierMaximum Length:150Number Qualifier -
_NumberQualifier_Display: string
Title:
Number QualifierNumber Qualifier -
_NumberType: string
Title:
Number TypeMaximum Length:150Number Type -
_NumberType_Display: string
Title:
Number TypeNumber Type -
_Portal: string
Title:
PortalMaximum Length:150Portal -
_PostalCode: string
Title:
Postal CodeMaximum Length:150Postal Code -
_Province: string
Title:
ProvinceMaximum Length:150Province -
_Province_Display: string
Title:
ProvinceProvince -
_Stairs: string
Title:
StairsMaximum Length:150Stairs -
CreatedBy: string
Read Only:
trueMaximum 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:
trueMaximum Length:64 -
LeiInformationCategory: string
Maximum Length:
30Default Value:JExESPropertyLocation -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LocationExtraInfoId: integer
(int64)
-
LocationId: integer
(int64)
-
SequenceNumber: integer
(int32)
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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:
trueMaximum 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:
trueMaximum Length:64 -
LeiInformationCategory: string
Maximum Length:
30Default Value:ORA_PER_OPERATIVE_LEGAL_EMP -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LocationExtraInfoId: integer
(int64)
-
LocationId: integer
(int64)
-
oraPerLegalEmployer: number
Title:
Legal EmployerLegal Employer -
oraPerLegalEmployer_Display: string
Title:
Legal EmployerLegal Employer -
SequenceNumber: integer
(int32)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- actionReasonCodesLOV
-
Parameters:
- finder:
findByActionId%3BActionId%3D{ActionId}
The list of values for action reasons. - finder:
- actionReasonIdLOV
-
The list of values for all the action reasons for a location.
- activeStatusLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DACTIVE_INACTIVE
The common lookups list of values resource is used to query the list of values of common lookups, which are legacy lookups or lookups that have attributes. Common lookups are defined in the common lookup view and support backward compatibility. - finder:
- addresses
-
Parameters:
- locationsV2UniqID:
$request.path.locationsV2UniqID
The addresses resource is a child of the locations resource. It provides all the addresses of the location including the main address as of the specified date. By default, the current date is retained. - locationsV2UniqID:
- annualWorkingDurationUnitsLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_PER_ANN_WORK_DURATION_UOM
The common lookups list of values resource is used to query the list of values of common lookups, which are legacy lookups or lookups that have attributes. Common lookups are defined in the common lookup view and support backward compatibility. - finder:
- attachments
-
Parameters:
- locationsV2UniqID:
$request.path.locationsV2UniqID
The attachments resource is used to view, create, and update attachments. - locationsV2UniqID:
- bannerOverrideMessages
-
Operation: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/bannerOverrideMessagesParameters:
- locationsV2UniqID:
$request.path.locationsV2UniqID
The bannerOverrideMessages resource provides all the status information and related messages for an object. - locationsV2UniqID:
- changeEffectiveStartDate
-
Operation: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/action/changeEffectiveStartDateParameters:
- locationsV2UniqID:
$request.path.locationsV2UniqID
Changes the effective start date of a location by moving the start date of this date-effective record and adjusting the effective end date of the previous record accordingly. - locationsV2UniqID:
- deleteLocationOtherAddresses
-
Parameters:
- locationsV2UniqID:
$request.path.locationsV2UniqID
Deletes the other address or addresses of a location. - locationsV2UniqID:
- designatedReceiverIdLOVVO
-
The list of values of all people who can be specified as the designated receiver of a location.
- geoHierarchyNodeCodesLOV
-
The list of values for geographic hierarchies.
- inventoryOrganizationIdLOV
- inventoryOrganizationsNameLOV
- locationLegislativeEFF
-
Operation: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationLegislativeEFFParameters:
- locationsV2UniqID:
$request.path.locationsV2UniqID
- locationsV2UniqID:
- locationsDFF
-
Parameters:
- locationsV2UniqID:
$request.path.locationsV2UniqID
- locationsV2UniqID:
- locationsEFFContainer
-
Operation: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationsEFFContainerParameters:
- locationsV2UniqID:
$request.path.locationsV2UniqID
The locationEFFContainer resource is a child of the locations resource. It's a container for the locations extensible flexfields. - locationsV2UniqID:
- modifyLocationRowForChildCorrect
-
Parameters:
- locationsV2UniqID:
$request.path.locationsV2UniqID
Marks the location's parent row as dirty for some of the offered features, as required by the approvals framework. When only the child data is modified using REST resources, the framework doesn't mark the parent row as dirty unless one of the parent attributes have been edited. - locationsV2UniqID:
- officialLanguageCodesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DPER_CORRESP_LANG
The common lookups list of values resource is used to query the list of values of common lookups, which are legacy lookups or lookups that have attributes. Common lookups are defined in the common lookup view and support backward compatibility. - finder:
- setCodesLOV
-
Operation: /hcmRestApi/resources/11.13.18.05/hcmSetsLOVThe list of values for sets.
- setIdLOV
-
Operation: /hcmRestApi/resources/11.13.18.05/hcmSetsLOVThe list of values for all the location sets.
- shipToLocationCodesLOV
-
Parameters:
- finder:
findByWord%3BSetId%3D{SetId}
The list of values for locations. - finder:
- shipToLocationIdLOVVO
-
The list of values of all locations that can be specified as the ship to location of a location.
- standardWorkingFrequencyLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DFREQUENCY
The common lookups list of values resource is used to query the list of values of common lookups, which are legacy lookups or lookups that have attributes. Common lookups are defined in the common lookup view and support backward compatibility. - finder:
Examples
The following example shows how to retrieve a location using a query parameter, by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X GET "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/locationsV2?q=LocationCode='PL_CA'"
Example of Response Header
The following is an example of the response header.
Status: HTTP/1.1 200 OK Content-Type: application/vnd.oracle.adf.resourceitem+json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{
"items": [
{
"LocationId": 300100188136324,
"LocationCode": "PL_CA",
"LocationName": "Pleasanton",
"EffectiveStartDate": "2018-01-01",
"EffectiveEndDate": "4712-12-31",
"ActionReasonCode": null,
"ActionReason": null,
"ActiveStatus": "A",
"ActiveStatusMeaning": "Active",
"SetId": 0,
"SetCode": "COMMON",
"SetName": "Common Set",
"Description": "Pleasanton Office",
"InventoryOrganizationId": 458,
"InventoryOrganizationName": "Vision Services",
"OfficialLanguageCode": "US",
"OfficialLanguageMeaning": "American English",
"EmailAddress": "example@example.com",
"GeoHierarchyNodeCode": "DE",
"MainPhoneCountryCode": "1",
"MainPhoneAreaCode": "040",
"MainPhoneNumber": "555-1212",
"MainPhoneExtension": "555-1213",
"FaxCountryCode": "1",
"FaxAreaCode": "050",
"FaxNumber": "555-9999999",
"FaxExtension": "555-9999999",
"OtherPhoneCountryCode": "244",
"OtherPhoneAreaCode": "060",
"OtherPhoneNumber": "555-2222",
"OtherPhoneExtension": "555-2233",
"ShipToSiteFlag": false,
"ShipToLocationId": 3033,
"ShipToLocationCode": "ARMY_PENTAGON_0_2452230072550",
"ShipToLocationName": "Army Pentagon",
"OfficeSiteFlag": true,
"BillToSiteFlag": true,
"ReceivingSiteFlag": true,
"DesignatedReceiverId": 100100124777049,
"DesignatedReceiverNumber": "GHR_LINE_MGR",
"DesignatedReceiverName": "GHR_LINE_MGR",
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2020-05-28T17:44:47+00:00",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"LastUpdateDate": "2020-05-28T17:44:47.767+00:00",
"links": [
{....
}
]
}