Get all packaging strings
get
/fscmRestApi/resources/11.13.18.05/packagingStrings
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: Find packaging strings according to the packaging string identifier as the primary key.
Finder Variables:- PackagingStringId; integer; The value that uniquely identifies the packaging string. It is a primary key that the application generates when it creates a packaging string.
- findByUomCode: Find packaging strings that have the primary unit of measure as an element. This finder is intended for seeking eligible packaging strings which may be reused for an item.
Finder Variables:- UomCode; string; The code that uniquely identifies the primary unit of measure for an item.
- PrimaryKey: Find packaging strings according to the packaging string identifier as 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:- CreatedBy; string; User who created the record.
- CreationDate; string; Date and time when the user created the record.
- LastUpdateDate; string; Date and time when the user most recently updated the record.
- LastUpdatedBy; string; User who most recently updated the record.
- PackagingString; string; The packaging string. It is a unique value created with the UOM elements and multipliers. The setting of the SCM Common: Display Order of Packaging String Units profile option determines if the string reads as ascending or descending.
- PackagingStringId; integer; The value that uniquely identifies the packaging string. It is a primary key that the application generates when it creates a packaging string.
- UOMCode1; string; The unique code of the first unit in the packaging string. This is always the base unit; for example, in the string EA 10/BX 25/CS, the first unit code is EA.
- UOMCode10; string; The unique code of the tenth unit in the packaging string. This is a multiple of the ninth unit.
- UOMCode2; string; The unique code of the second unit in the packaging string. This is a multiple of the base unit; for example, in the string EA 10/BX 25/CS, the second unit code is BX. It is a multiple of EA.
- UOMCode3; string; The unique code of the third unit in the packaging string. This is a multiple of the second unit; for example, in the string EA 10/BX 25/CS, the third unit code is CS. It is a multiple of BX.
- UOMCode4; string; The unique code of the fourth unit in the packaging string. This is a multiple of the third unit.
- UOMCode5; string; The unique code of the fifth unit in the packaging string. This is a multiple of the fourth unit.
- UOMCode6; string; The unique code of the sixth unit in the packaging string. This is a multiple of the fifth unit.
- UOMCode7; string; The unique code of the seventh unit in the packaging string. This is a multiple of the sixth unit.
- UOMCode8; string; The unique code of the eighth unit in the packaging string. This is a multiple of the seventh unit.
- UOMCode9; string; The unique code of the ninth unit in the packaging string. This is a multiple of the eighth unit.
- UOMMultiplier10; integer; The value used as the multiplier between the ninth unit and the tenth unit. This attribute indicates how many ninth units are in the tenth unit.
- UOMMultiplier2; integer; The value used as the multiplier between the base unit and the second unit. This attribute indicates how many base units are in the second unit; for example, in the string EA 10/BX 25/CS, the value of UOMMultiplier2 is 10. This means, there are 10 Each to a Box.
- UOMMultiplier3; integer; The value used as the multiplier between second unit and the third unit. This attribute indicates how many second units are in the third unit; for example, in the string EA 10/BX 25/CS, the value of UOMMultiplier3 is 25. It is a multiple of BX, or Box. This means, there are 25 Boxes to a Case.
- UOMMultiplier4; integer; The value used as the multiplier between the third unit and the fourth unit. This attribute indicates how many third units are in the fourth unit.
- UOMMultiplier5; integer; The value used as the multiplier between the fourth unit and the fifth unit. This attribute indicates how many fourth units are in the fifth unit.
- UOMMultiplier6; integer; The value used as the multiplier between the fifth unit and the sixth unit. This attribute indicates how many fifth units are in the sixth unit.
- UOMMultiplier7; integer; The value used as the multiplier between the sixth unit and the seventh unit. This attribute indicates how many sixth units are in the seventh unit.
- UOMMultiplier8; integer; The value used as the multiplier between the seventh unit and the eighth unit. This attribute indicates how many seventh units are in the eighth unit.
- UOMMultiplier9; integer; The value used as the multiplier between the eighth unit and the ninth unit. This attribute indicates how many eighth units are in the ninth unit.
- UOMName1; string; The name of the first unit in the packaging string. This is always the base unit; for example, in the string EA 10/BX 25/CS, the first unit name is Each.
- UOMName10; string; The name of the tenth unit in the packaging string. This is a multiple of the ninth unit.
- UOMName2; string; The name of the second unit in the packaging string. This is a multiple of the base unit; for example, in the string EA 10/BX 25/CS, the second unit name is Box.
- UOMName3; string; The name of the third unit in the packaging string. This is a multiple of the second unit; for example, in the string EA 10/BX 25/CS, the third unit name is Case.
- UOMName4; string; The name of the fourth unit in the packaging string. This is a multiple of the third unit.
- UOMName5; string; The name of the fifth unit in the packaging string. This is a multiple of the fourth unit.
- UOMName6; string; The name of the sixth unit in the packaging string. This is a multiple of the fifth unit.
- UOMName7; string; The name of the seventh unit in the packaging string. This is a multiple of the sixth unit.
- UOMName8; string; The name of the eighth unit in the packaging string. This is a multiple of the seventh unit.
- UOMName9; string; The name of the ninth unit in the packaging string. This is a multiple of the eighth 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(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 : packagingStrings
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 : packagingStrings-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PackagingString: string
The packaging string. It is a unique value created with the UOM elements and multipliers. The setting of the SCM Common: Display Order of Packaging String Units profile option determines if the string reads as ascending or descending.
-
PackagingStringId: integer
(int64)
Read Only:
true
The value that uniquely identifies the packaging string. It is a primary key that the application generates when it creates a packaging string. -
UOMCode1: string
Maximum Length:
3
The unique code of the first unit in the packaging string. This is always the base unit; for example, in the string EA 10/BX 25/CS, the first unit code is EA. -
UOMCode10: string
Maximum Length:
3
The unique code of the tenth unit in the packaging string. This is a multiple of the ninth unit. -
UOMCode2: string
Maximum Length:
3
The unique code of the second unit in the packaging string. This is a multiple of the base unit; for example, in the string EA 10/BX 25/CS, the second unit code is BX. It is a multiple of EA. -
UOMCode3: string
Maximum Length:
3
The unique code of the third unit in the packaging string. This is a multiple of the second unit; for example, in the string EA 10/BX 25/CS, the third unit code is CS. It is a multiple of BX. -
UOMCode4: string
Maximum Length:
3
The unique code of the fourth unit in the packaging string. This is a multiple of the third unit. -
UOMCode5: string
Maximum Length:
3
The unique code of the fifth unit in the packaging string. This is a multiple of the fourth unit. -
UOMCode6: string
Maximum Length:
3
The unique code of the sixth unit in the packaging string. This is a multiple of the fifth unit. -
UOMCode7: string
Maximum Length:
3
The unique code of the seventh unit in the packaging string. This is a multiple of the sixth unit. -
UOMCode8: string
Maximum Length:
3
The unique code of the eighth unit in the packaging string. This is a multiple of the seventh unit. -
UOMCode9: string
Maximum Length:
3
The unique code of the ninth unit in the packaging string. This is a multiple of the eighth unit. -
UOMMultiplier10: integer
(int64)
The value used as the multiplier between the ninth unit and the tenth unit. This attribute indicates how many ninth units are in the tenth unit.
-
UOMMultiplier2: integer
(int64)
The value used as the multiplier between the base unit and the second unit. This attribute indicates how many base units are in the second unit; for example, in the string EA 10/BX 25/CS, the value of UOMMultiplier2 is 10. This means, there are 10 Each to a Box.
-
UOMMultiplier3: integer
(int64)
The value used as the multiplier between second unit and the third unit. This attribute indicates how many second units are in the third unit; for example, in the string EA 10/BX 25/CS, the value of UOMMultiplier3 is 25. It is a multiple of BX, or Box. This means, there are 25 Boxes to a Case.
-
UOMMultiplier4: integer
(int64)
The value used as the multiplier between the third unit and the fourth unit. This attribute indicates how many third units are in the fourth unit.
-
UOMMultiplier5: integer
(int64)
The value used as the multiplier between the fourth unit and the fifth unit. This attribute indicates how many fourth units are in the fifth unit.
-
UOMMultiplier6: integer
(int64)
The value used as the multiplier between the fifth unit and the sixth unit. This attribute indicates how many fifth units are in the sixth unit.
-
UOMMultiplier7: integer
(int64)
The value used as the multiplier between the sixth unit and the seventh unit. This attribute indicates how many sixth units are in the seventh unit.
-
UOMMultiplier8: integer
(int64)
The value used as the multiplier between the seventh unit and the eighth unit. This attribute indicates how many seventh units are in the eighth unit.
-
UOMMultiplier9: integer
(int64)
The value used as the multiplier between the eighth unit and the ninth unit. This attribute indicates how many eighth units are in the ninth unit.
-
UOMName1: string
The name of the first unit in the packaging string. This is always the base unit; for example, in the string EA 10/BX 25/CS, the first unit name is Each.
-
UOMName10: string
The name of the tenth unit in the packaging string. This is a multiple of the ninth unit.
-
UOMName2: string
The name of the second unit in the packaging string. This is a multiple of the base unit; for example, in the string EA 10/BX 25/CS, the second unit name is Box.
-
UOMName3: string
The name of the third unit in the packaging string. This is a multiple of the second unit; for example, in the string EA 10/BX 25/CS, the third unit name is Case.
-
UOMName4: string
The name of the fourth unit in the packaging string. This is a multiple of the third unit.
-
UOMName5: string
The name of the fifth unit in the packaging string. This is a multiple of the fourth unit.
-
UOMName6: string
The name of the sixth unit in the packaging string. This is a multiple of the fifth unit.
-
UOMName7: string
The name of the seventh unit in the packaging string. This is a multiple of the sixth unit.
-
UOMName8: string
The name of the eighth unit in the packaging string. This is a multiple of the seventh unit.
-
UOMName9: string
The name of the ninth unit in the packaging string. This is a multiple of the eighth 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.