Get all lines
get
/fscmRestApi/resources/11.13.18.05/linesToInspect
Request
Query Parameters
-
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 lines to inspect according to the primary key.
Finder Variables:- ParentTransactionId; integer; Value that uniquely identifies the parent transaction.
- findLines: Find received lines that require inspection according to the bind variables that you provide. You must include the following: 1, bindOrganizationId or bindOrganizationCode; 2, bindDocumentType or bindSourceDocumentCode; 3, bindDocumentNumber.
Finder Variables:- bindASNLineNumber; integer; Line number for the advance shipment notice.
- bindASNNumber; string; Number that identifies the advanced shipment notice for the shipment from the supplier.
- bindBackToBack; string; Contains Y or N. Y: use back-to-back shipping. N: reference a transfer order. Note that the order line for the supply source for the reservation references this purchase order.
- bindConsigned; string; Contains Y or N. Y: the item is consigned. N: the item is not consigned.
- bindDocumentLineNumber; string; Line number for the document number.
- bindDocumentNumber; string; Document number that identifies one of the following: the purchase order number for the purchase order, advance shipment notice, or advance shipment billing notice; the number for the return material authorization for the source document code of type RMA; the in-transit shipment number for the source document code of type INVENTORY; or the transfer order number for the source document code of type TRANSFER ORDER.
- bindDocumentScheduleNumber; string; Schedule number for the document line number.
- bindDocumentType; string; Document type according to the originating source, such as purchase order or return material authorization. The RCV_SOURCE_DOCUMENT_TYPE lookup defines the values that you can use with this attribute.
- bindFromDate; string; Start date of the time interval to use when finding the lines to inspect.
- bindItemId; integer; Value that uniquely identifies an item.
- bindItemNumber; string; Purchasing number of the item to receive. An item is any part, material, product, or service that includes attributes that are unique when compared to other items.
- bindOrganizationCode; string; Value that identifies the ship-to organization code for the received line.
- bindOrganizationId; integer; Value that uniquely identifies the ship-to organization for the received line.
- bindPOHeaderId; integer; Value that uniquely identifies the purchase order header.
- bindPOLineId; integer; Value that uniquely identifies the purchase order line.
- bindPOLineLocationId; integer; Value that uniquely identifies the purchase order schedule.
- bindParentTransactionId; integer; Value that uniquely identifies the parent transaction.
- bindReceiptAdviceHeaderId; integer; Value that uniquely identifies the receipt advice header.
- bindReceiptAdviceLineId; integer; Value that uniquely identifies the receipt advice line.
- bindReceiptNumber; string; Number that acknowledges that the warehouse received the shipment.
- bindShipmentHeaderId; integer; Value that uniquely identifies the shipment header.
- bindShipmentLineId; integer; Value that uniquely identifies the shipment line.
- bindSourceDocumentCode; string; Document type of the shipment. You can use one of the following values for this attribute: PO, RMA, TRANSFER ORDER, or INVENTORY.
- bindToDate; string; End date of the time interval to use when finding the lines to inspect.
- bindTransferOrderHeaderId; integer; Value that uniquely identifies the transfer order header. Each transfer order can request to move an item from one location to another location.
- bindTransferOrderLineId; integer; Value that uniquely identifies the transfer order line.
- PrimaryKey: Find lines to inspect according to the primary key.
-
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:- ASNLineNumber; integer; Line number of the advanced shipment notice.
- ASNNumber; string; Number that identifies the advanced shipment notice for the shipment from the supplier.
- ASNType; string; Abbreviation that identifies the document type that specifies how to use this transaction. This attribute contains one of the following values. ASN: create an advance shipment notice; ASBN: create an advance shipment billing notice; STD: create a receipt.
- AvailableQuantity; number; Quantity that is available to inspect the parent transaction.
- BackToBack; string; Contains Y or N. Y: use back-to-back shipping. N: reference a transfer order. Note that the order line for the supply source for the reservation references this purchase order. The default value is N.
- CategoryId; integer; Value that uniquely identifies the category name.
- CategoryName; string; Name of the category that classifies the item. A category groups items that possess similar characteristics, such as plastics, paints, inks, foods, and so on.
- Comments; string; Comments provided with the receiving transaction.
- ConsignedItems; string; Contains Y, N, or empty. Y: the item is consigned. N: the item is not consigned. The default value is N.
- CurrencyCode; string; Abbreviation that identifies the currency, such as USD.
- CurrencyConversionDate; string; Date to use when determining the rates that your deployment uses when calculating the currency conversion.
- CurrencyConversionRate; number; Rate to use when calculating the currency conversion.
- CurrencyConversionType; string; Currency conversion type.
- CustomerId; integer; Value that uniquely identifies the customer.
- CustomerPartyName; string; Name of the party who purchases the item, typically for a fee.
- DestinationType; string; Destination type for the item on the transaction line. This attribute determines the accounting behavior of the transaction line. The RCV_DESTINATION_TYPE lookup defines the values that you can use with this attribute.
- DestinationTypeCode; string; Abbreviation that identifies the destination type for the item on the transaction line. This attribute determines the accounting behavior of the transaction line. The RCV_DESTINATION_TYPE lookup defines the values that you can use with this attribute.
- DocumentLineNumber; string; Line number for the document.
- DocumentNumber; string; Document number that identifies one of the following: the purchase order number for a purchase order, advance shipment notice, or advance shipment billing notice; the number for the return material authorization for the source document code of type RMA; the in-transit shipment number for the source document code of type INVENTORY; or the transfer order number for the source document code of type TRANSFER ORDER.
- DocumentScheduleNumber; string; Schedule number for the document.
- DocumentType; string; Document type according to the originating source, such as purchase order or return material authorization. The RCV_SOURCE_DOCUMENT_TYPE lookup defines the values that you can use with this attribute.
- EmployeeId; integer; Value that uniquely identifies the employee.
- EmployeeName; string; Name of the person who performed the transaction.
- FromOrganizationCode; string; Abbreviation that identifies the name of the organization that is the point of origin of the shipment. This value is empty for purchase orders and advanced shipment notices.
- FromOrganizationId; integer; Value that uniquely identifies the organization that is the point of origin of the shipment. This value is empty for purchase orders and advance shipment notices.
- FromOrganizationName; string; Name of the source organization.
- InspectionStatus; string; Inspection status of the item. The RCV_INSPECTION_STATUS lookup defines the values that you can use with this attribute.
- InspectionStatusCode; string; Abbreviation that identifies the inspection status of the item. The RCV_INSPECTION_STATUS lookup defines the values that you can use with this attribute.
- ItemDescription; string; Description of the item.
- ItemId; integer; Value that uniquely identifies the item.
- ItemNumber; string; Number that identifies the item to receive. This item is any part, material, product, or service that contains unique attributes when compared to other items.
- ItemRevision; string; Revision of the item.
- LineStatus; string; Current status of the received line, such as received, delivered, or inspected. The RCV_LINE_STATUS lookup defines the values that you can use with this attribute.
- Location; string; Physical location of the warehouse that receives the item.
- LocationId; integer; Value that uniquely identifies the receiving location.
- Locator; string; Name of the locator where the item currently resides.
- LocatorId; integer; Value that uniquely identifies the locator.
- POHeaderId; integer; Value that uniquely identifies the purchase order header.
- POLineId; integer; Value that uniquely identifies the purchase order line.
- POLineLocationId; integer; Value that uniquely identifies the purchase order schedule.
- PORevisionNumber; integer; Value that identifies the revision of the purchase order.
- ParentTransactionId; integer; Value that uniquely identifies the parent transaction.
- ParentTransactionType; string; Transaction type of the parent transaction.
- PrimaryUOMCode; string; Abbreviation that identifies the primary unit of measure that the item uses.
- Reason; string; Rationale for classifying the transaction.
- ReasonId; integer; Value that uniquely identifies the transaction reason.
- ReceiptAdviceHeaderId; integer; Value that uniquely identifies the receipt advice header.
- ReceiptAdviceLineId; integer; Value that uniquely identifies the receipt advice line.
- ReceiptException; string; Contains Y, N, or empty. Y: the transaction contains an exception. N or empty: no exceptions.
- ReceiptNumber; string; Number that identifies receipt of the shipment in the warehouse.
- ReceiptSourceCode; string; Abbreviation that identifies the source type of the shipment.
- Routing; string; Routing name for the type of transaction entry that determines the steps that receive the item. The RCV_ROUTING_HEADERS lookup defines the values that you can use with this attribute.
- RoutingHeaderId; integer; Value that uniquely identifies the routing header.
- SecondaryAvailableQuantity; number; Quantity that is available to inspect in the secondary unit of measure.
- SecondaryUOMCode; string; Abbreviation that identifies the secondary unit of measure for the quantity that the receipt transaction contains.
- SecondaryUnitOfMeasure; string; Unit of measure for the quantity that the receipt transaction contains.
- ShipmentHeaderId; integer; Value that uniquely identifies the shipment header.
- ShipmentLineId; integer; Value that uniquely identifies the shipment line.
- SourceDocumentCode; string; Document type of the shipment. You can use one of the following values for this attribute: PO, RMA, TRANSFER ORDER, or INVENTORY.
- Subinventory; string; Name of the subinventory where the item currently resides.
- TOShipmentNumber; string; Number that identifies the transfer order shipment.
- ToOrganizationCode; string; Abbreviation that identifies the name of the ship-to organization of the received line.
- ToOrganizationId; integer; Value that uniquely identifies the ship-to organization of the received line.
- TransactionDate; string; Date when the transaction finished.
- TransferOrderDistId; integer; Value that uniquely identifies the transfer order distribution.
- TransferOrderHeaderId; integer; Value that uniquely identifies the transfer order header. Each transfer order can request to move an item from one location to another location.
- TransferOrderLineId; integer; Value that uniquely identifies the transfer order line.
- UOMCode; string; Abbreviation that identifies the unit of measure that the received transaction uses.
- UnitOfMeasure; string; Unit of measure that the received transaction uses.
- VendorId; integer; Value that uniquely identifies the supplier.
- VendorItemNumber; string; Number that the supplier uses to identify the item.
- VendorName; string; Name of the company that provides a product in return for an item that might or might not require payment.
- VendorSiteCode; string; Abbreviation that identifies the name of the buying organization that conducts business with the supplier.
- VendorSiteId; integer; Value that uniquely identifies the supplier site.
-
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 : linesToInspect
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 : linesToInspect-item-response
Type:
Show Source
object
-
ASNLineNumber: integer
(int64)
Read Only:
true
Line number of the advanced shipment notice. -
ASNNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the advanced shipment notice for the shipment from the supplier. -
ASNType: string
Read Only:
true
Maximum Length:25
Abbreviation that identifies the document type that specifies how to use this transaction. This attribute contains one of the following values. ASN: create an advance shipment notice; ASBN: create an advance shipment billing notice; STD: create a receipt. -
AvailableQuantity: number
Read Only:
true
Quantity that is available to inspect the parent transaction. -
BackToBack: string
Read Only:
true
Maximum Length:1
Contains Y or N. Y: use back-to-back shipping. N: reference a transfer order. Note that the order line for the supply source for the reservation references this purchase order. The default value is N. -
CategoryId: integer
(int64)
Read Only:
true
Value that uniquely identifies the category name. -
CategoryName: string
Read Only:
true
Maximum Length:250
Name of the category that classifies the item. A category groups items that possess similar characteristics, such as plastics, paints, inks, foods, and so on. -
Comments: string
Read Only:
true
Maximum Length:4000
Comments provided with the receiving transaction. -
ConsignedItems: string
Read Only:
true
Maximum Length:1
Contains Y, N, or empty. Y: the item is consigned. N: the item is not consigned. The default value is N. -
CurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the currency, such as USD. -
CurrencyConversionDate: string
(date)
Read Only:
true
Date to use when determining the rates that your deployment uses when calculating the currency conversion. -
CurrencyConversionRate: number
Read Only:
true
Rate to use when calculating the currency conversion. -
CurrencyConversionType: string
Read Only:
true
Maximum Length:30
Currency conversion type. -
CustomerId: integer
(int64)
Read Only:
true
Value that uniquely identifies the customer. -
CustomerPartyName: string
Read Only:
true
Maximum Length:360
Name of the party who purchases the item, typically for a fee. -
DestinationType: string
Read Only:
true
Maximum Length:80
Destination type for the item on the transaction line. This attribute determines the accounting behavior of the transaction line. The RCV_DESTINATION_TYPE lookup defines the values that you can use with this attribute. -
DestinationTypeCode: string
Read Only:
true
Maximum Length:25
Abbreviation that identifies the destination type for the item on the transaction line. This attribute determines the accounting behavior of the transaction line. The RCV_DESTINATION_TYPE lookup defines the values that you can use with this attribute. -
DocumentLineNumber: string
Read Only:
true
Maximum Length:30
Line number for the document. -
DocumentNumber: string
Read Only:
true
Maximum Length:80
Document number that identifies one of the following: the purchase order number for a purchase order, advance shipment notice, or advance shipment billing notice; the number for the return material authorization for the source document code of type RMA; the in-transit shipment number for the source document code of type INVENTORY; or the transfer order number for the source document code of type TRANSFER ORDER. -
DocumentScheduleNumber: string
Read Only:
true
Maximum Length:80
Schedule number for the document. -
DocumentType: string
Read Only:
true
Maximum Length:80
Document type according to the originating source, such as purchase order or return material authorization. The RCV_SOURCE_DOCUMENT_TYPE lookup defines the values that you can use with this attribute. -
EmployeeId: integer
(int64)
Read Only:
true
Value that uniquely identifies the employee. -
EmployeeName: string
Read Only:
true
Maximum Length:2000
Name of the person who performed the transaction. -
FromOrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the name of the organization that is the point of origin of the shipment. This value is empty for purchase orders and advanced shipment notices. -
FromOrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the organization that is the point of origin of the shipment. This value is empty for purchase orders and advance shipment notices. -
FromOrganizationName: string
Read Only:
true
Maximum Length:240
Name of the source organization. -
InspectionStatus: string
Read Only:
true
Maximum Length:80
Inspection status of the item. The RCV_INSPECTION_STATUS lookup defines the values that you can use with this attribute. -
InspectionStatusCode: string
Read Only:
true
Maximum Length:25
Abbreviation that identifies the inspection status of the item. The RCV_INSPECTION_STATUS lookup defines the values that you can use with this attribute. -
ItemDescription: string
Read Only:
true
Maximum Length:240
Description of the item. -
ItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item. -
ItemNumber: string
Read Only:
true
Maximum Length:300
Number that identifies the item to receive. This item is any part, material, product, or service that contains unique attributes when compared to other items. -
ItemRevision: string
Read Only:
true
Maximum Length:18
Revision of the item. -
LineStatus: string
Read Only:
true
Maximum Length:80
Current status of the received line, such as received, delivered, or inspected. The RCV_LINE_STATUS lookup defines the values that you can use with this attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Location: string
Read Only:
true
Maximum Length:60
Physical location of the warehouse that receives the item. -
LocationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the receiving location. -
Locator: string
Read Only:
true
Maximum Length:4000
Name of the locator where the item currently resides. -
LocatorId: integer
(int64)
Read Only:
true
Value that uniquely identifies the locator. -
manufacturerParts: array
Manufacturer Parts
Title:
Manufacturer Parts
The Manufacturer Parts resource manages the manufacturer parts associated with a receipt line. -
ParentTransactionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the parent transaction. -
ParentTransactionType: string
Read Only:
true
Maximum Length:25
Transaction type of the parent transaction. -
POHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order header. -
POLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order line. -
POLineLocationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order schedule. -
PORevisionNumber: integer
(int64)
Read Only:
true
Value that identifies the revision of the purchase order. -
PrimaryUOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the primary unit of measure that the item uses. -
Reason: string
Read Only:
true
Maximum Length:30
Rationale for classifying the transaction. -
ReasonId: integer
(int64)
Read Only:
true
Value that uniquely identifies the transaction reason. -
ReceiptAdviceHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the receipt advice header. -
ReceiptAdviceLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the receipt advice line. -
ReceiptException: string
Read Only:
true
Maximum Length:1
Contains Y, N, or empty. Y: the transaction contains an exception. N or empty: no exceptions. -
ReceiptNumber: string
Read Only:
true
Maximum Length:30
Number that identifies receipt of the shipment in the warehouse. -
ReceiptSourceCode: string
Read Only:
true
Maximum Length:25
Abbreviation that identifies the source type of the shipment. -
Routing: string
Read Only:
true
Maximum Length:80
Routing name for the type of transaction entry that determines the steps that receive the item. The RCV_ROUTING_HEADERS lookup defines the values that you can use with this attribute. -
RoutingHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the routing header. -
SecondaryAvailableQuantity: number
Read Only:
true
Quantity that is available to inspect in the secondary unit of measure. -
SecondaryUnitOfMeasure: string
Read Only:
true
Maximum Length:25
Unit of measure for the quantity that the receipt transaction contains. -
SecondaryUOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the secondary unit of measure for the quantity that the receipt transaction contains. -
ShipmentHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the shipment header. -
ShipmentLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the shipment line. -
SourceDocumentCode: string
Read Only:
true
Maximum Length:25
Document type of the shipment. You can use one of the following values for this attribute: PO, RMA, TRANSFER ORDER, or INVENTORY. -
Subinventory: string
Read Only:
true
Maximum Length:10
Name of the subinventory where the item currently resides. -
ToOrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the name of the ship-to organization of the received line. -
ToOrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the ship-to organization of the received line. -
TOShipmentNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the transfer order shipment. -
TransactionDate: string
(date)
Read Only:
true
Date when the transaction finished. -
TransferOrderDistId: integer
(int64)
Read Only:
true
Value that uniquely identifies the transfer order distribution. -
TransferOrderHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the transfer order header. Each transfer order can request to move an item from one location to another location. -
TransferOrderLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the transfer order line. -
UnitOfMeasure: string
Read Only:
true
Maximum Length:25
Unit of measure that the received transaction uses. -
UOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the unit of measure that the received transaction uses. -
VendorId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier. -
VendorItemNumber: string
Read Only:
true
Maximum Length:300
Number that the supplier uses to identify the item. -
VendorName: string
Read Only:
true
Maximum Length:360
Name of the company that provides a product in return for an item that might or might not require payment. -
VendorSiteCode: string
Read Only:
true
Maximum Length:240
Abbreviation that identifies the name of the buying organization that conducts business with the supplier. -
VendorSiteId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier site.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Manufacturer Parts
Type:
array
Title:
Manufacturer Parts
The Manufacturer Parts resource manages the manufacturer parts associated with a receipt line.
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 : linesToInspect-manufacturerParts-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManufacturerName: string
Title:
Manufacturer
Read Only:true
Maximum Length:700
Name of the manufacturer. -
ManufacturerPartNumber: string
Title:
Manufacturer Part Number
Read Only:true
Maximum Length:255
Number issued by the manufacturer that uniquely identifies the individual product.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
This example describes how to get all lines to inspect.
Example cURL Command
Use the following cURL command to submit a request on the REST resource. This example gets lines to inspect in inventory organization V1, for purchase order 1744, on purchase order line 1, and for receipt number 5457:
curl -u username:password "https://servername/fscmRestApi/resources/version/linesToInspect?finder=findLines;bindOrganizationCode=V1,bindDocumentNumber=1744,bindDocumentLineNumber=1,bindDocumentType=Purchase order,bindReceiptNumber=5457,bindParentTransactionId=411133"
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "items" : [ { "ToOrganizationCode" : "V1", "ToOrganizationId" : 204, "FromOrganizationName" : null, "FromOrganizationCode" : null, "FromOrganizationId" : null, "ItemNumber" : "f40000", "ItemDescription" : "Modem - Serial Control", "ItemId" : 79, "ItemRevision" : null, "ReceiptNumber" : "5457", "LineStatus" : "Transferred", "DocumentType" : "Purchase order", "SourceDocumentCode" : "PO", "DocumentNumber" : "1744", "DocumentLineNumber" : "1", "DocumentScheduleNumber" : "1", "TransactionDate" : "2004-09-29", "VendorName" : "First Network Devices", "VendorId" : 21, "VendorSiteCode" : "34", "VendorSiteId" : 41, "VendorItemNumber" : null, "TOShipmentNumber" : null, "ASNType" : null, "ASNNumber" : null, "ASNLineNumber" : null, "CustomerPartyName" : null, "CustomerId" : null, "AvailableQuantity" : 600, "UOMCode" : "Ea", "UnitOfMeasure" : "Each", "SecondaryAvailableQuantity" : null, "SecondaryUOMCode" : null, "SecondaryUnitOfMeasure" : null, "DestinationType" : "Receiving", "DestinationTypeCode" : "RECEIVING", "Location" : "V1- New York City", "LocationId" : 204, "Routing" : "Inspection required", "RoutingHeaderId" : 2, "POHeaderId" : 9969, "POLineLocationId" : 11334, "POLineId" : 10114, "PORevisionNumber" : 0, "ShipmentHeaderId" : 5464, "ShipmentLineId" : 5738, "TransferOrderHeaderId" : null, "TransferOrderLineId" : null, "TransferOrderDistId" : null, "ReceiptAdviceHeaderId" : null, "ReceiptAdviceLineId" : null, "ReceiptSourceCode" : "VENDOR", "ConsignedItems" : "N", "BackToBack" : "N", "CategoryName" : "Office Supplies", "CategoryId" : 36, "CurrencyCode" : "USD", "CurrencyConversionRate" : 1, "CurrencyConversionDate" : "2001-07-23", "CurrencyConversionType" : null, "ParentTransactionType" : "TRANSFER", "ParentTransactionId" : 411133, "InspectionStatus" : "Not inspected", "InspectionStatusCode" : "NOT INSPECTED", "PrimaryUOMCode" : "Ea", "Reason" : null, "ReasonId" : null, "ReceiptException" : null, "EmployeeName" : "Stock, Ms. Pat", "EmployeeId" : 25, "Comments" : null, "Subinventory" : null, "Locator" : null, "LocatorId" : null, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/linesToInspect/411133", "name" : "linesToInspect", "kind" : "item" }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/linesToInspect/411133", "name" : "linesToInspect", "kind" : "item" } ] } ], "count" : 1, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/linesToInspect", "name" : "linesToInspect", "kind" : "collection" } ] }