Get all lots
get
/fscmRestApi/resources/11.13.18.05/receiptAdviceLines/{receiptAdviceLinesUniqID}/child/lots
Request
Path Parameters
-
receiptAdviceLinesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- PurchaseOrderScheduleId, IntransitShipmentLineId, TransferOrderLineId and RMALineId ---for the Receipt Advice Lines resource and used to uniquely identify an instance of Receipt Advice Lines. The client should not generate the hash key value. Instead, the client should query on the Receipt Advice Lines collection resource with a filter on the primary key values in order to navigate to a specific instance of Receipt Advice Lines.
For example: receiptAdviceLines?q=PurchaseOrderScheduleId=<value1>;IntransitShipmentLineId=<value2>;TransferOrderLineId=<value3>;RMALineId=<value4>
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: Finds lots according to the primary key criteria.
Finder Variables:- LotNumber; string; Number that identifies the lot.
- PrimaryKey: Finds lots according to the 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:- ExpirationDate; string; Date and time by when the lot expires.
-
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 : receiptAdviceLines-lots
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 : receiptAdviceLines-lots-item-response
Type:
Show Source
object
-
ExpirationDate: string
(date)
Read Only:
true
Date and time by when the lot expires. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
lotAttributeDFF: array
Flexfields for Lot Attributes
Title:
Flexfields for Lot Attributes
The Flexfields for Lot Attributes resource manages the descriptive flexfield information for lot attributes. -
LotNumber: string
Read Only:
true
Maximum Length:80
Number that identifies the lot. -
LotQuantity: number
Read Only:
true
Quantity for the lot in the receipt advice line unit of measure. -
lotSerials: array
Serials for Lots
Title:
Serials for Lots
The Serials for Lots resource manages the serial numbers associated with a lot. -
lotStandardDFF: array
Flexfields for Lot Numbers
Title:
Flexfields for Lot Numbers
The Flexfields for Lot Numbers resource manages the descriptive flexfield information for maintaining lot numbers. -
SecondaryLotQuantity: number
Read Only:
true
Quantity for the lot in the secondary unit of measure.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Lot Attributes
Type:
array
Title:
Flexfields for Lot Attributes
The Flexfields for Lot Attributes resource manages the descriptive flexfield information for lot attributes.
Show Source
Nested Schema : Serials for Lots
Type:
array
Title:
Serials for Lots
The Serials for Lots resource manages the serial numbers associated with a lot.
Show Source
Nested Schema : Flexfields for Lot Numbers
Type:
array
Title:
Flexfields for Lot Numbers
The Flexfields for Lot Numbers resource manages the descriptive flexfield information for maintaining lot numbers.
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 : receiptAdviceLines-lots-lotAttributeDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for lot attributes. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotNumber: string
Title:
Lot
Maximum Length:80
Number that identifies the lot. -
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : receiptAdviceLines-lots-lotSerials-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
serialAttributeDFF: array
Flexfields for Serial Attributes
Title:
Flexfields for Serial Attributes
The Flexfields for Serial Attributes resource manages the descriptive flexfield information for serial number attributes. -
SerialNumber: string
Read Only:
true
Maximum Length:80
Number that identifies a single unit of the inventory item. -
serialStandardDFF: array
Flexfields for Serial Numbers
Title:
Flexfields for Serial Numbers
The Flexfields for Serial Numbers resource manages the descriptive flexfield information for serial numbers.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Serial Attributes
Type:
array
Title:
Flexfields for Serial Attributes
The Flexfields for Serial Attributes resource manages the descriptive flexfield information for serial number attributes.
Show Source
Nested Schema : Flexfields for Serial Numbers
Type:
array
Title:
Flexfields for Serial Numbers
The Flexfields for Serial Numbers resource manages the descriptive flexfield information for serial numbers.
Show Source
Nested Schema : receiptAdviceLines-lots-lotSerials-serialAttributeDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for serial attributes. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
CurrentOrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SerialNumber: string
Title:
Serial Number
Maximum Length:80
Number that identifies a single unit of the inventory item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : receiptAdviceLines-lots-lotSerials-serialStandardDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for serial numbers. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
CurrentOrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SerialNumber: string
Title:
Serial Number
Maximum Length:80
Number that identifies a single unit of the inventory item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : receiptAdviceLines-lots-lotStandardDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for lot numbers. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotNumber: string
Title:
Lot
Maximum Length:80
Number that identifies the lot. -
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source