Create packaging strings
post
/fscmRestApi/resources/11.13.18.05/packagingStrings
Request
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
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.
-
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.
Response
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 : 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.