1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Locations V2
  4. Locations Extensible Flexfields Container
  5. Locations Extensible Flexfields

Get all

get

/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationsEFFContainer/{locationsEFFContainerUniqID}/child/locationsEFF

Request

Path Parameters
  • 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=
  • 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
  • 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>
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey
      Finder Variables
      • LocationId; integer;
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • EffectiveEndDate; string
    • EffectiveStartDate; string
    • LocationDetailsId; integer
    • __FLEX_Context; string
    • __FLEX_Context_DisplayValue; string


    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AddressUsageType; string; Type of the address usage.
    • AddressUsageTypeMeaning; string; Meaning of the address usage.
    • Building; string; Building name of the address.
    • Country; string; Country for the location address.
    • EffectiveEndDate; string; Effective end date for the location address.
    • EffectiveStartDate; string; Effective start date for the location address.
    • FloorNumber; string; Floor number of the address.
    • Latitude; number; Distance between the equator and a location address located to its north or south, expressed in degrees and minutes.
    • LocAddressUsageId; integer; Unique identifier for the address usage type.
    • LongPostalCode; string; Long postal code for the location address. Long postal codes are used in some countries in addition to the short postal codes.
    • Longitude; number; Distance between the prime meridian and a location address located to its east or west, expressed in degrees and minutes.
    • PostalCode; string; Postal code for the location address.
    • Provider; string; Company that has validated a location address.
    • Region1; string; Primary region in which the address is located. This value may be required depending on the country specified.
    • Region2; string; Secondary region withing the primary region.
    • Region3; string; Subregion within the secondary region.
    • TimezoneCode; string; Code of the time zone.
    • TownOrCity; string; Town or city of the location address. This value may be required depending on the country specified.
    • ValidationStatusCode; string; Level of accuracy of a location address as determined by an address provider.


    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • ActionReason; string; Reason for the action being performed on the record.
    • ActionReasonCode; string; Reason code for the action being performed on the record. Valid values are defined in the actionReasonsLOV.
    • ActiveStatus; string; Status of the location, such as active.
    • ActiveStatusMeaning; string; Meaning of the status of the location.
    • AnnualWorkingDurationUnits; string; Code of the unit of the location's standard annual working duration.
    • AnnualWorkingDurationUnitsMeaning; string; Meaning of the unit of the location's standard annual working duration.
    • BillToSiteFlag; boolean; Indicates whether the location is a bill to site. The default value is true.
    • Description; string; Description of the location.
    • DesignatedReceiverId; integer; Unique identifier for the person designated as the receiver for the location.
    • DesignatedReceiverNumber; string; Number for the person designated as the receiver for the location.
    • EffectiveEndDate; string; Effective end date of the location.
    • EffectiveStartDate; string; Effective start date of the location.
    • EmailAddress; string; Email address for the location.
    • EmployeeLocationFlag; boolean; Indicates whether the location is an employee location. The default value is true.
    • FaxAreaCode; string; Area code of the fax number for the location.
    • FaxCountryCode; string; Country code of the fax number for the location.
    • FaxExtension; string; Extension for the fax number of the location.
    • FaxNumber; string; Local fax number for the location.
    • GeoHierarchyNodeCode; string; Code of the geography tree node for the location.
    • GeoHierarchyNodeName; string; Name of the geography tree node for the location.
    • InventoryOrganizationId; integer; Unique identifier for the inventory organization.
    • InventoryOrganizationName; string; Name of the inventory organization.
    • LocationCode; string; Code that uniquely references the location within the set.
    • LocationId; integer; Surrogate identifier for the location.
    • LocationName; string; Name of the location.
    • MainPhoneAreaCode; string; Area code of the main phone number for the location.
    • MainPhoneCountryCode; string; Country code of the main phone number for the location.
    • MainPhoneExtension; string; Extension for the main phone number for the location.
    • MainPhoneNumber; string; Local main phone number for the location.
    • OfficeSiteFlag; boolean; Indicates whether the location is an office site. The default value is true.
    • OfficialLanguageCode; string; Code of the location's official language.
    • OfficialLanguageMeaning; string; Name of the location's official language.
    • OtherPhoneAreaCode; string; Area code of the other phone number for the location.
    • OtherPhoneCountryCode; string; Country code of the other phone number for the location.
    • OtherPhoneExtension; string; Extension for the other phone number of the location.
    • OtherPhoneNumber; string; Local number of the other phone number for the location.
    • ReceivingSiteFlag; boolean; Indicates whether the location is a receiving site. The default value is true.
    • SetCode; string; Code of the set to which the location belongs.
    • SetId; integer; Surrogate identifier for the set to which the location belongs.
    • SetName; string; Name of the set to which the location belongs.
    • ShipToLocationCode; string; Code for the ship to location.
    • ShipToLocationId; integer; Unique identifier for the ship to location.
    • ShipToSiteFlag; boolean; Indicates whether the location is a ship to site. The default value is true.
    • StandardAnnualWorkingDuration; number; Standard annual working duration for the location.
    • StandardWorkingFrequency; string; Code of the frequency of the location's standard working hours.
    • StandardWorkingFrequencyMeaning; string; Meaning of the frequency of the location's standard working hours.
    • StandardWorkingHours; number; Number of standard working hours for the location.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : locationsV2-locationsEFFContainer-locationsEFF
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
  • 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: 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: object
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : LocationExtraInfoJE_5FES_5FPRL_5FNOprivateVO
Type: array
Show Source
Nested Schema : LocationExtraInfoJE_5FES_5FPRL_5FYESprivateVO
Type: array
Show Source
Nested Schema : LocationExtraInfoJE_5FES_5FRENTED_5FLOCATIONprivateVO
Type: array
Show Source
Nested Schema : LocationExtraInfoJExESPropertyLocationprivateVO
Type: array
Show Source
Nested Schema : LocationExtraInfoORA_5FPER_5FOPERATIVE_5FLEGAL_5FEMPprivateVO
Type: array
Show Source
Nested Schema : locationsV2-locationsEFFContainer-locationsEFF-LocationExtraInfoJE_5FES_5FPRL_5FNOprivateVO-item-response
Type: object
Show Source
Nested Schema : locationsV2-locationsEFFContainer-locationsEFF-LocationExtraInfoJE_5FES_5FPRL_5FYESprivateVO-item-response
Type: object
Show Source
Nested Schema : locationsV2-locationsEFFContainer-locationsEFF-LocationExtraInfoJE_5FES_5FRENTED_5FLOCATIONprivateVO-item-response
Type: object
Show Source
Nested Schema : locationsV2-locationsEFFContainer-locationsEFF-LocationExtraInfoJExESPropertyLocationprivateVO-item-response
Type: object
Show Source
Nested Schema : locationsV2-locationsEFFContainer-locationsEFF-LocationExtraInfoORA_5FPER_5FOPERATIVE_5FLEGAL_5FEMPprivateVO-item-response
Type: object
Show Source
Back to Top