Jump to

• Request
• Response

Get one packaging string

get

/fscmRestApi/resources/11.13.18.05/packagingStrings/{PackagingStringId}

Request

Path Parameters

• PackagingStringId(required): integer(int64)
  The value that uniquely identifies the packaging string. It is a primary key that the application generates when it creates a packaging string.

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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 Top

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.

Body ()

Root Schema : packagingStrings-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode10":{
            "maxLength":"3",
            "type":"string",
            "description":"The unique code of the tenth unit in the packaging string. This is a multiple of the ninth unit.",
            "nullable":true,
            "x-queryable":true
        },
        "PackagingStringId":{
            "type":"integer",
            "description":"The value that uniquely identifies the packaging string. It is a primary key that the application generates when it creates a packaging string.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UOMMultiplier10":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UOMMultiplier7":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UOMMultiplier6":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UOMMultiplier5":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UOMMultiplier4":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UOMMultiplier9":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UOMMultiplier8":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode9":{
            "maxLength":"3",
            "type":"string",
            "description":"The unique code of the ninth unit in the packaging string. This is a multiple of the eighth unit.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMCode8":{
            "maxLength":"3",
            "type":"string",
            "description":"The unique code of the eighth unit in the packaging string. This is a multiple of the seventh unit.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMName10":{
            "type":"string",
            "description":"The name of the tenth unit in the packaging string. This is a multiple of the ninth unit.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMCode1":{
            "maxLength":"3",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMCode3":{
            "maxLength":"3",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMCode2":{
            "maxLength":"3",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMMultiplier3":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UOMCode5":{
            "maxLength":"3",
            "type":"string",
            "description":"The unique code of the fifth unit in the packaging string. This is a multiple of the fourth unit.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMMultiplier2":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UOMCode4":{
            "maxLength":"3",
            "type":"string",
            "description":"The unique code of the fourth unit in the packaging string. This is a multiple of the third unit.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMCode7":{
            "maxLength":"3",
            "type":"string",
            "description":"The unique code of the seventh unit in the packaging string. This is a multiple of the sixth unit.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMCode6":{
            "maxLength":"3",
            "type":"string",
            "description":"The unique code of the sixth unit in the packaging string. This is a multiple of the fifth unit.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMName8":{
            "type":"string",
            "description":"The name of the eighth unit in the packaging string. This is a multiple of the seventh unit.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMName9":{
            "type":"string",
            "description":"The name of the ninth unit in the packaging string. This is a multiple of the eighth unit.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMName6":{
            "type":"string",
            "description":"The name of the sixth unit in the packaging string. This is a multiple of the fifth unit.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMName7":{
            "type":"string",
            "description":"The name of the seventh unit in the packaging string. This is a multiple of the sixth unit.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMName4":{
            "type":"string",
            "description":"The name of the fourth unit in the packaging string. This is a multiple of the third unit.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMName5":{
            "type":"string",
            "description":"The name of the fifth unit in the packaging string. This is a multiple of the fourth unit.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMName2":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMName3":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "PackagingString":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMName1":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top