Get all packs
get
/fscmRestApi/resources/11.13.18.05/supplierProducts/{supplierProductsUniqID}/child/packs
Request
Path Parameters
-
supplierProductsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Supplier Products resource and used to uniquely identify an instance of Supplier Products. The client should not generate the hash key value. Instead, the client should query on the Supplier Products collection resource in order to navigate to a specific instance of Supplier Products to get the hash key.
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: Find packs according to the specified primary key criteria.
Finder Variables:- TransactionId; integer; Value that uniquely identifies the pack row in the staging interface.
- PrimaryKey: Find packs according to the specified primary key criteria.
-
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:- CommonItemNumber; string; Name or number of the item for a common pack.
- CommonOrganizationCode; string; Abbreviation that identifies the organization for a common pack. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
- CommonOrganizationId; integer; Value that uniquely identifies the organization for a common pack. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
- CreatedBy; string; User who created the pack.
- CreationDate; string; Date and time when the application created the pack.
- ItemNumber; string; Name or number of the part, item, product, or service.
- ItemTransactionId; integer; Value that identifies the product row in staging.
- LastUpdateDate; string; Date and time when the pack was most recently updated.
- LastUpdatedBy; string; User who most recently updated the pack.
- OrganizationCode; string; Abbreviation that identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
- OrganizationId; integer; Value that uniquely identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
- ProductNumber; string; Name or number of the spoke part, item, product, or service.
- SpokeSystemCode; string; Abbreviation that identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.
- SpokeSystemId; integer; Value that uniquely identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.
- SupplierId; integer; Value that uniquely identifies the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.
- SupplierName; string; Name of the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.
- TransactionId; integer; Value that uniquely identifies the pack row in staging.
-
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 : supplierProducts-packs
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 : supplierProducts-packs-item-response
Type:
Show Source
object
-
CommonItemNumber: string
Maximum Length:
240
Name or number of the item for a common pack. -
CommonOrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the organization for a common pack. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task. -
CommonOrganizationId: integer
(int64)
Value that uniquely identifies the organization for a common pack. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the pack. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the application created the pack. -
ItemNumber: string
Maximum Length:
820
Name or number of the part, item, product, or service. -
ItemTransactionId: integer
(int64)
Value that identifies the product row in staging.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the pack was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the pack. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
-
packComponents: array
Pack Components
Title:
Pack Components
The Pack Components resource is used to manage pack components of supplier products. -
ProductNumber: string
Maximum Length:
255
Name or number of the spoke part, item, product, or service. -
SpokeSystemCode: string
Abbreviation that identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.
-
SpokeSystemId: integer
(int64)
Value that uniquely identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.
-
SupplierId: integer
(int64)
Value that uniquely identifies the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.
-
SupplierName: string
Title:
Supplier
Name of the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task. -
TransactionId: integer
(int64)
Value that uniquely identifies the pack row in staging.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Pack Components
Type:
array
Title:
Pack Components
The Pack Components resource is used to manage pack components of supplier products.
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 : supplierProducts-packs-packComponents-item-response
Type:
Show Source
object
-
AssemblyItemNumber: string
Maximum Length:
820
Number that identifies the parent item of the component item of a pack. -
ComponentItemNumber: string
Maximum Length:
820
Number that identifies the component item of a pack. -
ComponentProductDescription: string
Title:
Component Product Description
Maximum Length:240
Spoke item description of the component item of a pack. -
ComponentProductNumber: string
Title:
Component Product Number
Maximum Length:255
Spoke item number of the component item of a pack. -
ComponentQuantity: number
Quantity of the component item used in the pack.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the pack component. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the application created the pack component. -
ItemTransactionId: integer
(int64)
Value that identifies the product row in staging.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the pack component was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the pack component. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
-
ParentProductNumber: string
Title:
Parent Product Number
Maximum Length:255
Spoke item number of the parent item of the component item of a pack. -
SpokeSystemCode: string
Abbreviation that identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.
-
SpokeSystemId: integer
(int64)
Value that uniquely identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.
-
SupplierId: integer
(int64)
Value that uniquely identifies the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.
-
SupplierName: string
Title:
Supplier
Name of the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task. -
TransactionId: integer
Value that uniquely identifies the pack component row in staging.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source