Get all nested packing units
get
/fscmRestApi/resources/11.13.18.05/packingUnits/{PackingUnitId}/child/nestedPackingUnits/{PackingUnitId2}/child/nestedPackingUnits
Request
Path Parameters
-
PackingUnitId(required): integer(int64)
Value that uniquely identifies the packing unit.
-
PackingUnitId2(required): integer(int64)
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=
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: Finds nested packing units according to the primary key.
Finder Variables:- PackingUnitId; integer; Value that uniquely identifies the packing unit.
- findAllLevelsByPackingUnit: Finds details of all levels of packing unit.
Finder Variables:- pPackingUnit; string; Value that uniquely identifies the packing unit.
- PrimaryKey: Finds nested packing units according to the primary key.
-
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:- ContainerItemId; integer; Value that uniquely identifies the container item.
- ContainerItemNumber; string; Name of the container item.
- ContainerVolume; number; Total volume of the packing unit container.
- ContainerVolumeUOM; string; Abbreviation that identifies the unit of measure of the packing unit container volume.
- ContainerVolumeUOMName; string; Name of the unit of measure of the packing unit container volume.
- ContentVolume; number; Total volume of the packing unit contents.
- ContentVolumeUOMCode; string; Abbreviation that identifies the unit of measure of the packing unit content volume.
- ContentVolumeUOMName; string; Name of the unit of measure of the packing unit content volume.
- GrossWeight; number; Weight of the packing unit and its contents.
- GrossWeightUOMCode; string; Abbreviation that identifies the unit of measure of the weight of the packing unit and its contents.
- GrossWeightUOMName; string; Name of the unit of measure of the weight of the packing unit and its contents.
- NetWeight; number; Net weight of the packing unit.
- NetWeightUOMCode; string; Abbreviation that identifies the unit of measure for the net weight of the packing unit.
- NetWeightUOMName; string; Name of the unit of measure for the net weight of the packing unit.
- OrganizationCode; string; Abbreviation that identifies the organization of the packing unit.
- OrganizationId; integer; Value that uniquely identifies the organization of the packing unit.
- OutermostPackingUnit; string; Name of the outermost packing unit in which the current packing unit is nested, if the packing unit has a nested structure.
- OutermostPackingUnitId; integer; Value that uniquely identifies the outermost packing unit in which the current packing unit is nested, if the packing unit has a nested structure.
- PackingUnit; string; Name of the packing unit.
- PackingUnitContext; string; Abbreviation that identifies the packing unit context.
- PackingUnitContextMeaning; string; Description of the packing unit context.
- PackingUnitId; integer; Value that uniquely identifies the packing unit.
- ParentPackingUnit; string; Name of the parent packing unit.
- ParentPackingUnitId; integer; Value that uniquely identifies the parent packing unit.
- SealCode; string; Abbreviation that identifies the seal of the packing unit.
- SourceName; string; Name of the source of the packing unit.
- TareWeight; number; Tare weight of the packing unit.
- TareWeightUOMCode; string; Abbreviation that identifies the unit of measure for the tare weight of the packing unit.
- TareWeightUOMName; string; Name of the unit of measure for the tare weight of the packing unit.
- TrackingNumber; string; Tracking number of the packing unit.
-
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 : packingUnits-nestedPackingUnits-nestedPackingUnits
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 : packingUnits-nestedPackingUnits-nestedPackingUnits-item-response
Type:
Show Source
object
-
AllowAutoGeneration: string
Default Value:
No
Contains one of the following values: true or false. If true, then packing unit will be generated based on packing unit setup defined for organization. If false, then packing unit is user-defined. There is no default value for this attribute. -
ContainerItemId: integer
(int64)
Value that uniquely identifies the container item.
-
ContainerItemNumber: string
Maximum Length:
255
Name of the container item. -
ContainerVolume: number
Total volume of the packing unit container.
-
ContainerVolumeUOM: string
Maximum Length:
3
Abbreviation that identifies the unit of measure of the packing unit container volume. -
ContainerVolumeUOMName: string
Read Only:
true
Maximum Length:255
Name of the unit of measure of the packing unit container volume. -
ContentVolume: number
Total volume of the packing unit contents.
-
ContentVolumeUOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure of the packing unit content volume. -
ContentVolumeUOMName: string
Read Only:
true
Maximum Length:255
Name of the unit of measure of the packing unit content volume. -
GrossWeight: number
Weight of the packing unit and its contents.
-
GrossWeightUOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure of the weight of the packing unit and its contents. -
GrossWeightUOMName: string
Read Only:
true
Maximum Length:255
Name of the unit of measure of the weight of the packing unit and its contents. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NetWeight: number
Net weight of the packing unit.
-
NetWeightUOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure for the net weight of the packing unit. -
NetWeightUOMName: string
Read Only:
true
Maximum Length:255
Name of the unit of measure for the net weight of the packing unit. -
OrganizationCode: string
Maximum Length:
255
Abbreviation that identifies the organization of the packing unit. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization of the packing unit.
-
OutermostPackingUnit: string
Read Only:
true
Maximum Length:255
Name of the outermost packing unit in which the current packing unit is nested, if the packing unit has a nested structure. -
OutermostPackingUnitId: integer
(int64)
Read Only:
true
Value that uniquely identifies the outermost packing unit in which the current packing unit is nested, if the packing unit has a nested structure. -
PackingUnit: string
Title:
Packing Unit
Maximum Length:30
Name of the packing unit. -
PackingUnitContext: string
Maximum Length:
30
Abbreviation that identifies the packing unit context. -
PackingUnitContextMeaning: string
Maximum Length:
255
Description of the packing unit context. -
PackingUnitId: integer
(int64)
Read Only:
true
Value that uniquely identifies the packing unit. -
ParentPackingUnit: string
Read Only:
true
Maximum Length:255
Name of the parent packing unit. -
ParentPackingUnitId: integer
(int64)
Read Only:
true
Value that uniquely identifies the parent packing unit. -
SealCode: string
Maximum Length:
30
Abbreviation that identifies the seal of the packing unit. -
SourceName: string
Maximum Length:
30
Name of the source of the packing unit. -
TareWeight: number
Tare weight of the packing unit.
-
TareWeightUOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure for the tare weight of the packing unit. -
TareWeightUOMName: string
Read Only:
true
Maximum Length:255
Name of the unit of measure for the tare weight of the packing unit. -
TrackingNumber: string
Maximum Length:
30
Tracking number of the packing unit.
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.