Get all stocking locations
get
/fscmRestApi/resources/11.13.18.05/stockingLocations
Request
Query Parameters
-
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: Finds stocking locations according to the specified primary key criteria.
Finder Variables:- StockLocationId; integer; Value that uniquely identifies the stocking location.
- PrimaryKey: Finds stocking locations according to the specified primary key criteria.
-
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:- Condition; string; Condition of subinventory stocking locations. Valid values are Usable and Defective. A list of accepted values is defined in the lookup type ORA_RCL_STOCK_LOC_CONDITION.
- ConditionMeaning; string; Value that indicates the condition of subinventory stocking locations. Valid values are Usable and Defective. A list of accepted values is defined in the lookup type ORA_RCL_STOCK_LOC_CONDITION.
- LocationType; string; Type of location. Valid values are TECHNICIAN, UNMANNED, MANNED, and SITE_DEDICATED. A list of accepted values is defined in the lookup type ORA_RCL_STOCK_LOC_TYPE. You can't add additional location types.
- LocationTypeMeaning; string; Description of the location type. Valid values are Technician, Unmanned Warehouse, Manned Warehouse, and Site Dedicated Warehouse. A list of accepted values is defined in the lookup type ORA_RCL_STOCK_LOC_TYPE. You can't add additional location types.
- OrganizationCode; string; Abbreviation that identifies the inventory organization with associated attributes related to stocking locations defined in service logistics.
- OrganizationId; integer; Value that uniquely identifies the inventory organization with associated attributes related to stocking locations defined in service logistics.
- StockLocationId; integer; Value that uniquely identifies the stocking location.
- Subinventory; string; Name of the subinventory with associated attributes related to stocking locations defined in service logistics.
-
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:
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 : stockingLocations
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 : stockingLocations-item-response
Type:
Show Source
object
-
Condition: string
Maximum Length:
10
Condition of subinventory stocking locations. Valid values are Usable and Defective. A list of accepted values is defined in the lookup type ORA_RCL_STOCK_LOC_CONDITION. -
ConditionMeaning: string
Maximum Length:
80
Value that indicates the condition of subinventory stocking locations. Valid values are Usable and Defective. A list of accepted values is defined in the lookup type ORA_RCL_STOCK_LOC_CONDITION. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationType: string
Maximum Length:
10
Type of location. Valid values are TECHNICIAN, UNMANNED, MANNED, and SITE_DEDICATED. A list of accepted values is defined in the lookup type ORA_RCL_STOCK_LOC_TYPE. You can't add additional location types. -
LocationTypeMeaning: string
Maximum Length:
80
Description of the location type. Valid values are Technician, Unmanned Warehouse, Manned Warehouse, and Site Dedicated Warehouse. A list of accepted values is defined in the lookup type ORA_RCL_STOCK_LOC_TYPE. You can't add additional location types. -
OrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the inventory organization with associated attributes related to stocking locations defined in service logistics. -
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization with associated attributes related to stocking locations defined in service logistics.
-
siteDedicatedLocations: array
Site-Dedicated Locations
Title:
Site-Dedicated Locations
Service that's used to create site-dedicated, stocking-location addresses in the RCL_SITE_DEDICATED_LOCATIONS table to define which customer sites the parts in the associated service logistics stocking location can be used. -
StockLocationId: integer
(int64)
Value that uniquely identifies the stocking location.
-
Subinventory: string
Maximum Length:
10
Name of the subinventory with associated attributes related to stocking locations defined in service logistics.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Site-Dedicated Locations
Type:
array
Title:
Site-Dedicated Locations
Service that's used to create site-dedicated, stocking-location addresses in the RCL_SITE_DEDICATED_LOCATIONS table to define which customer sites the parts in the associated service logistics stocking location can be used.
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 : stockingLocations-siteDedicatedLocations-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartySiteId: integer
(int64)
Value that uniquely identifies the customer site (HZ_PARTY_SITES) associated with the service logistics stocking-locations table (RCL_STOCK_LOCATION).
-
PartySiteNumber: string
Maximum Length:
30
Number that identifies the customer site (HZ_PARTY_SITES) associated with the service logistics stocking-locations table (RCL_STOCK_LOCATION). -
SiteDedicatedLocId: integer
(int64)
Value that uniquely identifies the site-dedicated location record in the dedicated sites table (RCL_SITE_DEDICATED_LOCATIONS).
-
StockLocationId: integer
(int64)
Value that uniquely identifies the row in the service logistics stocking-location table (RCL_STOCK_LOCATION).
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source