1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Manufacturing
  4. Work Order Operation Start Stops

Get all starts and stops

get

/fscmRestApi/resources/11.13.18.05/operationStartStops

Request

Query Parameters
  • 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
  • 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 start and stop times for one work order operation.
      Finder Variables:
      • WoOperationStartStopId; integer; Value that uniquely identifies the work order operation start and stop record.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • OperationSequenceNumber; number; Sequence to use when performing the work order operations.
    • OperationStartTime; string; Date and time when the work order operation starts. You must make sure OperationStartTime does not contain a value when you stop the operation.
    • OperationStopTime; string; Date and time when the work order operation stops. You must make sure OperationStopTime does not contain a value when you start the operation.
    • OrganizationCode; string; Abbreviation that identifies the inventory organization that the application enabled for manufacturing.
    • OrganizationId; integer; Value that uniquely identifies the inventory organization that the application enabled for manufacturing. It is a primary key that the application generates when it creates the inventory organization.
    • SerialNumber; string; Serial number that the work order item references.
    • WoOperationId; integer; Value that uniquely identifies the work order operation. It is a primary key that the application generates when it creates the work order operation. If you provide a value for the WoOperationId attribute, then it is not necessary to provide a value for these attributes: OrganizationId, OrganizationCode, WorkOrderNumber, WorkOrderId, and OperationSequenceNumber.
    • WoOperationStartStopId; integer; Value that uniquely identifies the start and stop for the work order operation. You must make sure this attribute does not contain a value when you start the work order operation. The response will include value for this attribute. This attribute is required when you stop an operation.
    • WoProductSerialId; integer; Value that uniquely identifies the product serial in the work order. It is a primary key that the application generates when it creates the serial number. If you are performing a serialized operation, then you must provide a value for the WoProductSerialId attribute or for the SerialNumber attribute.
    • 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; Number that identifies the work order. This number is unique in the manufacturing organization. It is a unique number from the numbering scheme defined by these plant parameters: Work Order Prefix or Work Order Starting Number.
  • 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
  • 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 : operationStartStops
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : operationStartStops-item-response
Type: object
Show Source
  • Links
  • Title: Operation Sequence
    Sequence to use when performing the work order operations.
  • Date and time when the work order operation starts. You must make sure OperationStartTime does not contain a value when you stop the operation.
  • Date and time when the work order operation stops. You must make sure OperationStopTime does not contain a value when you start the operation.
  • Maximum Length: 18
    Abbreviation that identifies the inventory organization that the application enabled for manufacturing.
  • Value that uniquely identifies the inventory organization that the application enabled for manufacturing. It is a primary key that the application generates when it creates the inventory organization.
  • Title: Serial Number
    Maximum Length: 80
    Serial number that the work order item references.
  • Value that uniquely identifies the work order operation. It is a primary key that the application generates when it creates the work order operation. If you provide a value for the WoOperationId attribute, then it is not necessary to provide a value for these attributes: OrganizationId, OrganizationCode, WorkOrderNumber, WorkOrderId, and OperationSequenceNumber.
  • Value that uniquely identifies the start and stop for the work order operation. You must make sure this attribute does not contain a value when you start the work order operation. The response will include value for this attribute. This attribute is required when you stop an operation.
  • Value that uniquely identifies the product serial in the work order. It is a primary key that the application generates when it creates the serial number. If you are performing a serialized operation, then you must provide a value for the WoProductSerialId attribute or for the SerialNumber attribute.
  • Value that uniquely identifies the work order. It is a primary key that the application generates when it creates the work order.
  • Maximum Length: 255
    Number that identifies the work order. This number is unique in the manufacturing organization. It is a unique number from the numbering scheme defined by these plant parameters: Work Order Prefix or Work Order Starting Number.
Back to Top

Examples

This example describes how to get all stop and start operations.

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/operationStartStops"

Example Response Body

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

{
  "items" : [ {
  "WoOperationStartStopId" : 300100114413477,
  "OperationStartTime" : "2017-08-14T17:15:00+00:00",
  "OperationStopTime" : null,
  "OrganizationId" : 207,
  "WoOperationId" : 300100114297517,
  "OperationSequenceNumber" : 20,
  "WoProductSerialId" : null,
  "WorkOrderId" : 300100114297515,
  "WorkOrderNumber" : "M1-1109",
  "SerialNumber" : null,
  "OrganizationCode" : "M1"
  }, {
...
  } ],
...
}
Back to Top