Get all operations
get
/fscmRestApi/resources/11.13.18.05/dispatchListWorkOrderOperations
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 operations that are at a dispatch state.
Finder Variables:- DispatchState; string; Current dispatch status of quantities, such as Ready to be worked on, Completed, Scrapped, or Rejected. It also represents Optional operations.
- OperationId; integer; Value that uniquely identifies a work order operation. It is a primary key that the application generates when it creates an operation.
- findByProjectNumberTaskNumber: Find work order operations and dispatch statuses according to the project and task number. This finder is associated with a feature that requires opt in.
Finder Variables:- ProjectNumber; string; Number that identifies the project associated with the dispatch list. This attribute is associated with a feature that requires opt in.
- TaskNumber; string; Number that identifies the task associated with the dispatch list. This attribute is associated with a feature that requires opt in.
- findBySerialNumber: Find work order operations and dispatch statuses according to the item serial number.
Finder Variables:- DispatchState; string; Current dispatch status of an operation, such as Ready to be worked on, Completed, Scrapped, or Rejected. It also represents Optional operations.
- OrganizationCode; string; Abbreviation that identifies the inventory organization.
- SerialNumber; string; Serial number of the item that the plant is manufacturing.
- PrimaryKey: Find operations that are at a dispatch state.
-
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:- DispatchState; string; Value that indicates the current dispatch status of an operation. Valid values include Ready to be worked on, Completed, Scrapped, or Rejected. It also represents optional operations.
- InventoryItemId; integer; Value that uniquely identifies the item. It is a primary key that the application generates when it creates the item.
- ItemNumber; string; Number of the item that the plant is manufacturing.
- OperationId; integer; Value that uniquely identifies the work order operation. It is a primary key that the application generates when it creates the inventory organization.
- OperationSequenceNumber; number; Number that the user defines that uniquely identifies an operation in the work order.
- OperationStartStopStatusCode; integer; Abbreviation that identifies the operation. Values include 0 or 1, where 0 is Stopped and 1 is Started.
- OrganizationCode; string; Abbreviation that identifies the inventory organization.
- OrganizationId; integer; Value that uniquely identifies the inventory organization. It is a primary key that the application generates when it creates an inventory organization.
- PlannedCompletionDate; string; Scheduled date and time when the work order operation completes.
- PlannedStartDate; string; Scheduled date and time when the work order operation starts.
- ProcessName; string; Unique name of a process work definition.
- PurchaseOrder; string; Purchase order number that the work order references.
- PurchaseOrderId; integer; Value that uniquely identifies a purchase order. It is a primary key that the application generates when it creates the purchase order. If the work order is for contract manufacturing, then this attribute will contain a value.
- Quantity; number; Quantity of the work order operations that are in the Dispatch status.
- WorkAreaCode; string; Abbreviation that identifies the work area.
- WorkAreaId; integer; Value that uniquely identifies the work area. It is a primary key that the application generates when it creates the work area.
- WorkCenterCode; string; Abbreviation that identifies the work center.
- WorkCenterId; integer; Value that uniquely identifies the work center. It is a primary key that the application generates when it creates the work center.
- WorkMethodCode; string; Abbreviation that identifies the manufacturing method that the work order uses. Valid values include DISCRETE_MANUFACTURING and PROCESS_MANUFACTURING.
- WorkOrderId; integer; Value that uniquely identifies the work order. It is a primary key that the application generates when it creates the work order.
- WorkOrderNumber; string; Value that uniquely identifies a work order in an inventory organization. The application generates this number according to the organization settings.
-
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:
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.
Root Schema : dispatchListWorkOrderOperations
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 : dispatchListWorkOrderOperations-item-response
Type:
Show Source
object
-
CustomerId: number
Read Only:
true
Value that uniquely identifies the customer. It is a primary key that the application generates when it creates the customer. If the application reserves the work order as supply for the sales order, then this attribute will contain a value. -
CustomerName: string
Read Only:
true
Maximum Length:255
Name of the customer on the sales order that the work order references. Fulfillment reserves this work order as supply for the sales order. -
DispatchState: string
Title:
Lookup Code
Read Only:true
Maximum Length:30
Value that indicates the current dispatch status of an operation. Valid values include Ready to be worked on, Completed, Scrapped, or Rejected. It also represents optional operations. -
ExecutionSequence: number
Read Only:
true
Number that indicates the execution sequence of operations when a work order allows resequencing. It is read-only value. This attribute is associated with a feature that requires opt in. -
InventoryItemId: integer
(int64)
Title:
Item Number
Read Only:true
Value that uniquely identifies the item. It is a primary key that the application generates when it creates the item. -
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the item. -
ItemNumber: string
Read Only:
true
Maximum Length:300
Number of the item that the plant is manufacturing. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OperationDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the operation. -
OperationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work order operation. It is a primary key that the application generates when it creates the inventory organization. -
OperationName: string
Title:
Name
Read Only:true
Maximum Length:120
Name of the operation. -
OperationSequenceNumber: number
Title:
Operation Sequence
Read Only:true
Number that the user defines that uniquely identifies an operation in the work order. -
OperationStartStopStatus: string
Read Only:
true
Maximum Length:255
Status of the operation. Values include Started or Stopped. -
OperationStartStopStatusCode: integer
(int64)
Read Only:
true
Abbreviation that identifies the operation. Values include 0 or 1, where 0 is Stopped and 1 is Started. -
OrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the inventory organization. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory organization. It is a primary key that the application generates when it creates an inventory organization. -
OrganizationName: string
Read Only:
true
Maximum Length:240
Name of the inventory organization. -
PlannedCompletionDate: string
(date-time)
Title:
Completion Date
Read Only:true
Scheduled date and time when the work order operation completes. -
PlannedStartDate: string
(date-time)
Title:
Start Date
Read Only:true
Scheduled date and time when the work order operation starts. -
ProcessName: string
Title:
Name
Read Only:true
Maximum Length:120
Unique name of a process work definition. -
ProjectId: integer
(int64)
Title:
Project Number
Read Only:true
Value that uniquely identifies the project. This attribute is associated with a feature that requires opt in. -
ProjectNumber: string
Title:
Project Number
Read Only:true
Maximum Length:25
Number that identifies the project associated with the dispatch list. This attribute is associated with a feature that requires opt in. -
PurchaseOrder: string
Title:
Order
Read Only:true
Maximum Length:30
Purchase order number that the work order references. -
PurchaseOrderId: integer
(int64)
Read Only:
true
Value that uniquely identifies a purchase order. It is a primary key that the application generates when it creates the purchase order. If the work order is for contract manufacturing, then this attribute will contain a value. -
PurchaseOrderLine: number
Title:
Line
Read Only:true
Line number on the purchase order that the work order references. -
PurchaseOrderLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order line. It is a primary key that the application generates when it creates the purchase order line. If the work order is for contract manufacturing, then this attribute will contain a value. -
Quantity: number
Read Only:
true
Quantity of the work order operations that are in the Dispatch status. -
TaskId: integer
(int64)
Title:
Task Number
Read Only:true
Value that uniquely identifies the task. This attribute is associated with a feature that requires opt in. -
TaskNumber: string
Title:
Task Number
Read Only:true
Maximum Length:100
Number that identifies the task associated with the dispatch list. This attribute is associated with a feature that requires opt in. -
UnitOfMeasure: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Unit of measure of the quantity that the plant is manufacturing. -
WorkAreaCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the work area. -
WorkAreaId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work area. It is a primary key that the application generates when it creates the work area. -
WorkAreaName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the work area. -
WorkCenterCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the work center. -
WorkCenterDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the work center. -
WorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work center. It is a primary key that the application generates when it creates the work center. -
WorkCenterName: string
Title:
Name
Read Only:true
Maximum Length:120
Name of the work center. -
WorkMethodCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the manufacturing method that the work order uses. Valid values include DISCRETE_MANUFACTURING and PROCESS_MANUFACTURING. -
WorkOrderDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the work order. -
WorkOrderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work order. It is a primary key that the application generates when it creates the work order. -
WorkOrderNumber: string
Title:
Work Order
Read Only:true
Maximum Length:120
Value that uniquely identifies a work order in an inventory organization. The application generates this number according to the organization settings. -
WorkOrderOperationProductSerial: array
Product Serials for Work Order Operations
Title:
Product Serials for Work Order Operations
The Product Serials for Work Order Operations resource manages the serials for the work order operation according to dispatch status. -
WorkOrderPriority: number
Title:
Priority
Read Only:true
Priority of the work order.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Product Serials for Work Order Operations
Type:
array
Title:
Product Serials for Work Order Operations
The Product Serials for Work Order Operations resource manages the serials for the work order operation according to dispatch status.
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 : dispatchListWorkOrderOperations-WorkOrderOperationProductSerial-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OperationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the operation. It is a primary key that the application generates for an operation on the work order. The item serial is in a dispatch status for this operation. -
OperationSequenceNumber: number
Read Only:
true
Number that you define that uniquely identifies an operation in the work order. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work order serial. It is a primary key that the application generates when it creates the serial number. -
SerialNumber: string
Read Only:
true
Maximum Length:80
Serial number of the item that the plant is manufacturing. -
SerialStartStopStatus: string
Read Only:
true
Maximum Length:255
Status of the serial for the assembly of the operation. Values include Started or Stopped. -
SerialStartStopStatusCode: integer
(int64)
Read Only:
true
Abbreviation that identifies the serial for the assembly of the operation. Values include 0 or 1, where 0 is Stopped and 1 is Started. -
SerialStatus: string
Read Only:
true
Maximum Length:30
Status of the item serial that the plant is manufacturing. Values include Associated, In Progress, Rejected, Scrapped, or Completed. -
SerialStatusDescription: string
Read Only:
true
Maximum Length:240
Description of the status of the serial. -
WorkOrderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work order. It is a primary key that the application generates when it creates the work order. -
WorkOrderProductSerialId: integer
Read Only:
true
Value that uniquely identifies the product serial number. It is a primary key that the application generates when it creates the serial number for an item.
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 work order operations for dispatch lists.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/dispatchListWorkOrderOperations"
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "items" : [ { "OrganizationId" : 300100075212216, "OrganizationCode" : "MFG002", "OrganizationName" : "Atlanta", "WorkAreaId" : 300100081228354, "WorkAreaCode" : "TABLET", "WorkAreaName" : "Tablets", "WorkCenterId" : 300100081228366, "WorkCenterCode" : "TPCK", "WorkCenterName" : "Tablet Packing", "WorkCenterDescription" : "Tablet Packing", "WorkOrderId" : 300100085483217, "WorkOrderNumber" : "WO-002-1003", "WorkOrderDescription" : null, "InventoryItemId" : 300100083879158, "ItemNumber" : "AS4751200", "ItemDescription" : "Vision Slimline 5100 Tablet, 32 GB, 8\" Display", "OperationId" : 300100085483220, "OperationSequenceNumber" : 30, "OperationName" : "Tablet Packing", "OperationDescription" : "Tablet Packing", "DispatchState" : "COMPLETE", "Quantity" : 2, "UnitOfMeasure" : "Each", "PlannedStartDate" : "2015-12-11T17:12:36-07:00", "PlannedCompletionDate" : "2015-12-11T17:13:48-07:00", "WorkOrderPriority" : null, "PurchaseOrderId" : null, "PurchaseOrder" : null, "PurchaseOrderLineId" : null, "PurchaseOrderLine" : null, "CustomerId" : null, "CustomerName" : null }, { ... } ], ... }