Get all locators
get
/fscmRestApi/resources/11.13.18.05/subinventories/{subinventoriesUniqID}/child/locators
Request
Path Parameters
-
subinventoriesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- OrganizationId and SecondaryInventoryName ---for the Subinventories resource and used to uniquely identify an instance of Subinventories. The client should not generate the hash key value. Instead, the client should query on the Subinventories collection resource with a filter on the primary key values in order to navigate to a specific instance of Subinventories.
For example: subinventories?q=OrganizationId=<value1>;SecondaryInventoryName=<value2>
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 -
finder: string
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:
- PrimaryKey
-
limit: 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.
-
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- Description; string; Description of the locator.
- DisableDate; string; Date when the locator is disabled for use in the application.
- InventoryLocationType; string; Value that identifies the locator type. A list of accepted values is defined in the lookup type INV_LOCATOR_TYPES.
- MaterialStatusCode; string; Abbreviation that identifies the material status that references the locator.
- MaterialStatusId; integer; Value that uniquely identifies the material status that references the locator.
- PickingOrder; number; Picking order for the locator.
- StructureInstanceNumber; integer; Value that uniquely identifies the locator structure.
- SubinventoryCode; string; Abbreviation that identifies the subinventory name.
-
totalResults: boolean
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
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : subinventories-locators
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subinventories-locators-item-response
Type:
Show Source
object
-
Description: string
Title:
Description
Maximum Length:50
Description of the locator. -
DisableDate: string
(date)
Title:
End Date
Date when the locator is disabled for use in the application. -
InventoryLocationType: string
Title:
Type
Maximum Length:30
Value that identifies the locator type. A list of accepted values is defined in the lookup type INV_LOCATOR_TYPES. -
itemLocators: array
Item Locators
Title:
Item Locators
The Item Locators resource manages operations on item locators. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
locatorsDFF: array
Flexfields for Locators
Title:
Flexfields for Locators
The Flexfields for Locators resource manages descriptive flexfields that contain details about locators. -
locatorsKeyFlex: array
Flexfields for Locator Keys
Title:
Flexfields for Locator Keys
The Flexfields for Locator Keys resource manages flexfields that contain details about locator keys. -
MaterialStatusCode: string
Maximum Length:
255
Abbreviation that identifies the material status that references the locator. -
MaterialStatusId: integer
(int64)
Title:
Status
Value that uniquely identifies the material status that references the locator. -
PickingOrder: number
Title:
Picking Order
Picking order for the locator. -
StructureInstanceNumber: integer
(int64)
Title:
Locator Structure
Value that uniquely identifies the locator structure. -
SubinventoryCode: string
Maximum Length:
10
Abbreviation that identifies the subinventory name.
Nested Schema : Item Locators
Type:
array
Title:
Item Locators
The Item Locators resource manages operations on item locators.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Locators
Type:
array
Title:
Flexfields for Locators
The Flexfields for Locators resource manages descriptive flexfields that contain details about locators.
Show Source
Nested Schema : Flexfields for Locator Keys
Type:
array
Title:
Flexfields for Locator Keys
The Flexfields for Locator Keys resource manages flexfields that contain details about locator keys.
Show Source
-
Array of:
object Discriminator: _STRUCTURE_INSTANCE_NUMBER
Discriminator:
{ "propertyName":"_STRUCTURE_INSTANCE_NUMBER", "mapping":{ "1021":"#/components/schemas/oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-response" } }
Nested Schema : subinventories-locators-itemLocators-item-response
Type:
Show Source
object
-
CountRequired: string
Title:
Count Required
Maximum Length:1
Contains one of the following values. 1: The application requires counting during periodic-automatic replenishment for the item in the locator. 2: The application doesn't require this counting. There isn't a default value for this attribute. -
DefaultCountType: string
Maximum Length:
255
The type of periodic automatic replenishment. A list of accepted values is defined in the lookup type INV_DEFAULT_REPLEN_COUNT_TYPE. The default value is Order par. -
DefaultCountTypeCode: string
Title:
Replenishment Count Type
Maximum Length:30
Abbreviation that identifies the type of periodic automatic replenishment. A list of accepted values is defined in the lookup type INV_DEFAULT_REPLEN_COUNT_TYPE. The default value is 4. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the Item.
-
ItemNumber: string
Maximum Length:
255
Name of the inventory item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocatorId: integer
(int64)
Title:
Locator
Value that uniquely identifies the locator. -
LocatorItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item locator. -
LocatorName: string
Maximum Length:
255
Name of the locator that references the locator item. -
OrganizationCode: string
Maximum Length:
255
Abbreviation that identifies the organization that references the item locator. -
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
-
ParLevel: number
Title:
PAR Level
Level that the application uses during periodic-automatic replenishment for the item locator. -
ParMaximumQuantity: number
Title:
PAR Maximum Quantity
Maximum quantity to use during periodic-automatic replenishment. -
ParUOMCode: string
Maximum Length:
3
Code that identifies the unit of measure to use for quantities during periodic-automatic replenishment. -
ParUOMMeasure: string
Title:
PAR Level UOM
Unit of measure to use for quantities during periodic-automatic replenishment. -
QuantityCountTolerance: number
Title:
Count Tolerance Percentage
Count tolerance percent to use before the application doesn't allow the count. This tolerance prevents data entry mistakes when counting, and prevents ordering too much quantity for the replenishment request. -
SubinventoryCode: string
Maximum Length:
10
Abbreviation that identifies the subinventory.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : subinventories-locators-locatorsDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context
Maximum Length:30
Context value of the locator that the descriptive flexfield references. -
__FLEX_Context_DisplayValue: string
Title:
Context
Display value of the locator that the descriptive flexfield references. -
InventoryLocationId: integer
(int64)
Title:
Locator
Value that uniquely identifies the locator. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Discriminator: _STRUCTURE_INSTANCE_NUMBER
Type:
object
Discriminator: _STRUCTURE_INSTANCE_NUMBER
Discriminator Values
Match One Schema
Show Source
Nested Schema : oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-response
Type:
Show Source
object
-
_INVENTORY_LOCATION_ID: integer
(int64)
Title:
Locator
Number that uniquely identifies the locator. -
_STRUCTURE_INSTANCE_NUMBER: integer
(int64)
Title:
Locator Structure
Default Value:1021
Value that uniquely identifies the locator structure for the subinventory when a locator control is enabled for the subinventory. -
_SUBINVENTORY_ID: integer
(int64)
Value that uniquely identifies subinventory.
-
aisle: string
Title:
Aisle
Maximum Length:40
-
bin: string
Title:
Bin
Maximum Length:40
-
EnabledFlag: string
Maximum Length:
1
Default Value:Y
Contains one of the following values. Y: enable the locator. N: do not enable the locator. There is no default value for this attribute. -
EndDateActive: string
(date)
Date when the locator becomes inactive.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
rack: string
Title:
Rack
Maximum Length:40
-
row: string
Title:
Row
Maximum Length:40
-
StartDateActive: string
(date)
Date when the locator becomes active.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
This example describes how to get all locators in one subinventory.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/subinventories/subinventoriesUniqID/child/locators"
For example, the following command gets all locators in subinventory 00020000000EACED0005770800000000000000CF000000084142435355423031:
curl -u username:password "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators"
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "items": [ { "Description": null, "DisableDate": null, "InventoryLocationType": null, "PickingOrder": null, "MaterialStatusId": 1, "StructureInstanceNumber": 101, "SubinventoryCode": "ABCSUB01", "MaterialStatusCode": "Active", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100129677370", "name": "locators", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100129677370", "name": "locators", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031", "name": "subinventories", "kind": "item" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100129677370/lov/LocatorTypeLov", "name": "LocatorTypeLov", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100129677370/lov/KeyFlexfieldStructureInstanceLov", "name": "KeyFlexfieldStructureInstanceLov", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100129677370/child/itemLocators", "name": "itemLocators", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100129677370/child/locatorsKeyFlex", "name": "locatorsKeyFlex", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100129677370/child/locatorsDFF", "name": "locatorsDFF", "kind": "collection" } ] }, { "Description": null, "DisableDate": null, "InventoryLocationType": null, "PickingOrder": null, "MaterialStatusId": 1, "StructureInstanceNumber": 101, "SubinventoryCode": "ABCSUB01", "MaterialStatusCode": "Active", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100129677372", "name": "locators", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100129677372", "name": "locators", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031", "name": "subinventories", "kind": "item" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100129677372/lov/LocatorTypeLov", "name": "LocatorTypeLov", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100129677372/lov/KeyFlexfieldStructureInstanceLov", "name": "KeyFlexfieldStructureInstanceLov", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100129677372/child/itemLocators", "name": "itemLocators", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100129677372/child/locatorsKeyFlex", "name": "locatorsKeyFlex", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100129677372/child/locatorsDFF", "name": "locatorsDFF", "kind": "collection" } ] } ], "count": 2, "hasMore": true, "limit": 2, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators", "name": "locators", "kind": "collection" } ] }