1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Manufacturing
  4. Work Order Dispatch Lists

Get one operation

get

/fscmRestApi/resources/11.13.18.05/dispatchListWorkOrderOperations/{dispatchListWorkOrderOperationsUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Work Order Dispatch Lists resource and used to uniquely identify an instance of Work Order Dispatch Lists. The client should not generate the hash key value. Instead, the client should query on the Work Order Dispatch Lists collection resource in order to navigate to a specific instance of Work Order Dispatch Lists to get the hash key.
Query Parameters
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : dispatchListWorkOrderOperations-item-response
Type: object
Show Source
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Item Description
    Read Only: true
    Maximum Length: 240
    Description of the item.
  • Read Only: true
    Maximum Length: 300
    Number of the item that the plant is manufacturing.
  • Links
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the operation.
  • 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.
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name of the operation.
  • Title: Operation Sequence
    Read Only: true
    Number that the user defines that uniquely identifies an operation in the work order.
  • Read Only: true
    Maximum Length: 255
    Status of the operation. Values include Started or Stopped.
  • Read Only: true
    Abbreviation that identifies the operation. Values include 0 or 1, where 0 is Stopped and 1 is Started.
  • Read Only: true
    Maximum Length: 18
    Abbreviation that identifies the inventory organization.
  • 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.
  • Read Only: true
    Maximum Length: 240
    Name of the inventory organization.
  • Title: Completion Date
    Read Only: true
    Scheduled date and time when the work order operation completes.
  • Title: Start Date
    Read Only: true
    Scheduled date and time when the work order operation starts.
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Unique name of a process work definition.
  • Title: Project Number
    Read Only: true
    Value that uniquely identifies the project. This attribute is associated with a feature that requires opt in.
  • 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.
  • Title: Order
    Read Only: true
    Maximum Length: 30
    Purchase order number that the work order references.
  • 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.
  • Title: Line
    Read Only: true
    Line number on the purchase order that the work order references.
  • 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.
  • Read Only: true
    Quantity of the work order operations that are in the Dispatch status.
  • Title: Task Number
    Read Only: true
    Value that uniquely identifies the task. This attribute is associated with a feature that requires opt in.
  • 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.
  • Title: UOM Name
    Read Only: true
    Maximum Length: 25
    Unit of measure of the quantity that the plant is manufacturing.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the work area.
  • 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.
  • Title: Name
    Read Only: true
    Maximum Length: 80
    Name of the work area.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the work center.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the work center.
  • 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.
  • Title: Name
    Read Only: true
    Maximum Length: 80
    Name of the work center.
  • 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.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the work order.
  • 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.
  • 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.
  • 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.
  • Title: Priority
    Read Only: true
    Priority of the work order.
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 : dispatchListWorkOrderOperations-WorkOrderOperationProductSerial-item-response
Type: object
Show Source
  • Links
  • 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.
  • Read Only: true
    Number that you define that uniquely identifies an operation in the work order.
  • 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.
  • Read Only: true
    Maximum Length: 80
    Serial number of the item that the plant is manufacturing.
  • Read Only: true
    Maximum Length: 255
    Status of the serial for the assembly of the operation. Values include Started or Stopped.
  • 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.
  • 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.
  • Read Only: true
    Maximum Length: 240
    Description of the status of the serial.
  • 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.
  • 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.
Links
WorkOrderOperationProductSerial
Parameters:
  • dispatchListWorkOrderOperationsUniqID: $request.path.dispatchListWorkOrderOperationsUniqID
The Product Serials for Work Order Operations resource manages the serials for the work order operation according to dispatch status.
Back to Top

Examples

This example describes how to get one work order operation 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/dispatchListWorkOrderOperationsUniqId"

For example, the following command gets work order operation 300100085483220 for dispatch lists for work order 300100085483217:

curl -u username:password "https://servername/fscmRestApi/resources/version/dispatchListWorkOrderOperations/00080000000EACED0005770800000000000000CC0000000EACED00057708000110F07EFE081E0000000EACED00057708000110F07EFE08330000000EACED00057708000110F07CD8B2AC0000000EACED00057708000110F07EFE083D0000000552454144590000000EACED0005770800000000000000CC000000164F52415F5749455F44495350415443485F5354415445"

Note that the large number you include after dispatchListWorkOrderOperations is a hash key value that identifies the work center resource. The response payload in the collection action includes the hash key as part of the self link for a work center resource. One way to identify the hash key value is to perform a get all work order operations for dispatch lists action, and then examine the response payload.

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "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
}
Back to Top