Get one nested packing unit
get
/fscmRestApi/resources/11.13.18.05/packingUnits/{PackingUnitId}/child/nestedPackingUnits/{PackingUnitId2}
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 -
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 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 : packingUnits-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. -
attachments: array
Attachments
Title:
Attachments
The Attachments resource manages the attachments associated with the packing unit resource. -
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. -
contents: array
Contents
Title:
Contents
The Contents resource manages the operations on packing unit contents. -
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. -
nestedPackingUnits: array
Nested Packing Units
Title:
Nested Packing Units
The Nested Packing Units resources manages the operations on nested packing units. -
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. -
notes: array
Notes
Title:
Notes
The Notes resource gets comments, information, or instructions for packing units. -
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. -
packingUnitDFFs: array
Flexfields for Packing Units
Title:
Flexfields for Packing Units
The Flexfields for Packing Units resource manages the descriptive flexfields for packing units. -
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 : Attachments
Type:
array
Title:
Attachments
The Attachments resource manages the attachments associated with the packing unit resource.
Show Source
Nested Schema : Contents
Type:
array
Title:
Contents
The Contents resource manages the operations on packing unit contents.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Nested Packing Units
Type:
array
Title:
Nested Packing Units
The Nested Packing Units resources manages the operations on nested packing units.
Show Source
Nested Schema : Notes
Type:
array
Title:
Notes
The Notes resource gets comments, information, or instructions for packing units.
Show Source
Nested Schema : Flexfields for Packing Units
Type:
array
Title:
Flexfields for Packing Units
The Flexfields for Packing Units resource manages the descriptive flexfields for packing units.
Show Source
Nested Schema : packingUnits-nestedPackingUnits-attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Login that the user used when creating the document. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attachment record. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfo
JSON-formatted string containing information required to programmatically retrieve a large file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the contents in the attachment expires. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) of the attachment. This will be populated only where attachment type is file. This is the reference to the file uploaded in the Oracle WebCenter Content server. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the user most recently updated the attachment. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who most recently updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the document. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) appended to the base URI derived from the endpoint associated with application that is identified by the MODULE_ID. The attribute is not currently used by the Packing Units resource. -
Url: string
Title:
Url
Maximum Length:4000
URL (Uniform Resource Locator) that locates the attachment. This will be populated only for attachment type as URL. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login that the user used when adding or modifying the attachment.
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.
Nested Schema : packingUnits-nestedPackingUnits-contents-item-response
Type:
Show Source
object
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the content item.
-
ItemDescription: string
Maximum Length:
240
Description of the content item. -
ItemNumber: string
Read Only:
true
Maximum Length:255
Number that identifies the content item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotNumber: string
Maximum Length:
80
Lot number of the container item, if container item is under lot control. -
OrganizationCode: string
Read Only:
true
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.
-
PackingUnitContentId: integer
(int64)
Value that uniquely identifies the packing unit content.
-
Quantity: number
Quantity of the content item.
-
Revision: string
Maximum Length:
18
Revision of the container item, if it is under revision control. -
serials: array
Serials
Title:
Serials
The Serials resource manages the operations on serials. -
UOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure of the content item. -
UOMName: string
Read Only:
true
Maximum Length:255
Name of the unit of measure of the content item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Serials
Type:
array
Title:
Serials
The Serials resource manages the operations on serials.
Show Source
Nested Schema : packingUnits-nestedPackingUnits-contents-serials-item-response
Type:
Show Source
object
-
CurrentStatus: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the current status of the serial number of the content item. -
CurrentStatusMeaning: string
Read Only:
true
Maximum Length:80
Description of the current status of the serial number of the content item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SerialNumber: string
Read Only:
true
Maximum Length:80
Serial number of the container item, if container item is under serial control.
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 : packingUnits-nestedPackingUnits-notes-item-response
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
Value that uniquely identifies the relationship. This attribute is not currently used by the packingUnits resource. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
Abbreviation that identifies the corporate currency. This attribute is not currently used by the packingUnits resource. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the note. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the note record. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
Value that uniquely identifies the creator of the note. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
Type of currency conversion rate. This attribute is not currently used by the packingUnits resource. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
Abbreviation that identifies the currency. This attribute is not currently used by the packingUnits resource. -
DeleteFlag: boolean
Title:
Delete Indicator
Read Only:true
Contains one of the following values: true or false. If true, then the note can be deleted. If false, then the note can be deleted. The default value is true. -
EmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The email address of the user who created the note. -
FormattedAddress: string
Title:
Primary Address
Read Only:true
The address of the user who created the note. -
FormattedPhoneNumber: string
Title:
Primary Phone
Read Only:true
The phone number of the user who created the note. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the user most recently updated the note data. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who most recently updated the note record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
Login of the user who most recently updated the note record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoteId: integer
(int64)
Title:
Note ID
Read Only:true
Value that uniquely identifies the note. -
NoteNumber: string
Maximum Length:
30
The alternate unique identifier of the note. A user key that's system generated or from an external system. -
NoteTitle: string
Title:
Title
Maximum Length:500
The title of the note entered by the user. -
NoteTxt: string
(byte)
Title:
Note
Text of the actual note. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
Abbreviation that identifies the categorization of the note type. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
Value that uniquely identifies the parent note. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
Value that uniquely identifies the party to which the note is associated. -
PartyName: string
Title:
Author
Read Only:true
Maximum Length:360
Name of the user who created the record. -
SourceObjectCode: string
Title:
Related Object Type
Maximum Length:30
Abbreviation that identifies the object as defined in the OBJECTS metadata which is associated with the note. The object identifier is SHIPPING_LPN for packing units. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
Value that uniquely identifies the packing unit. -
UpdateFlag: boolean
Title:
Update Indicator
Read Only:true
Contains one of the following values: true or false. If true, then the note can be updated. If false, then the note cannot be updated. The default value is true. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
Abbreviation that identifies the visibility level of the note.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : packingUnits-nestedPackingUnits-packingUnitDFFs-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for packing unit. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LPNId: integer
(int64)
Value that uniquely identifies the packing unit flexfields.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- attachments
-
Parameters:
- PackingUnitId:
$request.path.PackingUnitId
- PackingUnitId2:
$request.path.PackingUnitId2
The Attachments resource manages the attachments associated with the packing unit resource. - PackingUnitId:
- contents
-
Parameters:
- PackingUnitId:
$request.path.PackingUnitId
- PackingUnitId2:
$request.path.PackingUnitId2
The Contents resource manages the operations on packing unit contents. - PackingUnitId:
- nestedPackingUnits
-
Parameters:
- PackingUnitId:
$request.path.PackingUnitId
- PackingUnitId2:
$request.path.PackingUnitId2
The Nested Packing Units resources manages the operations on nested packing units. - PackingUnitId:
- notes
-
Parameters:
- PackingUnitId:
$request.path.PackingUnitId
- PackingUnitId2:
$request.path.PackingUnitId2
The Notes resource gets comments, information, or instructions for packing units. - PackingUnitId:
- packingUnitDFFs
-
Parameters:
- PackingUnitId:
$request.path.PackingUnitId
- PackingUnitId2:
$request.path.PackingUnitId2
The Flexfields for Packing Units resource manages the descriptive flexfields for packing units. - PackingUnitId: