Get one serial number
get
/fscmRestApi/resources/11.13.18.05/workOrders/{WorkOrderId}/child/WorkOrderSerialNumber/{WorkOrderProductSerialId}
Request
Path Parameters
-
WorkOrderId(required): integer(int64)
Value that uniquely identifies the work order. It is a primary key that the application generates when it creates the work order.
-
WorkOrderProductSerialId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : workOrders-WorkOrderSerialNumber-item-response
Type:
Show Source
object
-
InventoryItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item, product, or assembly in the inventory organization. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OperationName: string
Title:
Name
Read Only:true
Maximum Length:120
Name of the operation that references this serial number. -
OperationSequenceNumber: number
Title:
Operation Sequence
Read Only:true
Sequence to use when performing the work order operations that reference this serial number. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory organization that's enabled for manufacturing. It is a primary key of the inventory organization. -
SerialNumber: string
Maximum Length:
80
Serial number that the work order product references. -
SerialStatus: string
Read Only:
true
Maximum Length:30
This is an internal work execution status for the serial number. A list of accepted values is defined in the lookup type ORA_WIE_SERIAL_STATUS. -
SerialStatusDescription: string
Title:
Meaning
Read Only:true
Maximum Length:80
Description of the status of the serial number. -
StandardOperationCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the operation. -
StandardOperationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the operation that the work order references. It is a primary key that the application generates when it creates the operation. -
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. -
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:80
Name of the work center. -
WorkOrderId: integer
(int64)
Value that uniquely identifies the work order that this serial number references. It is a primary key that the application generates when it creates the work order.
-
WorkOrderOperationId: 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 work order operation. -
WorkOrderOperationMaterialId: integer
(int64)
Read Only:
true
Value that uniquely identifies the material for the work order operation. It is a primary key that the application generates when it creates the material for the work order operation. -
WorkOrderProductSerialId: integer
(int64)
Read Only:
true
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.
Examples
This example describes how to get one product serial for one work order.
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/workOrders/WorkOrderId/child/WorkOrderSerialNumber/WorkOrderProductSerialId"
For example, the following command gets product serial 300100085483241 for work order 300100085483217:
curl -u username:password "https://servername/fscmRestApi/resources/version/workOrders/300100085483217/child/WorkOrderSerialNumber/300100085483241"
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "OrganizationId" : 300100075212216, "WorkOrderProductSerialId" : 300100085483241, "WorkOrderId" : 300100085483217, "WorkOrderOperationMaterialId" : 300100085483240, "WorkOrderOperationId" : 300100085483220, "OperationSequenceNumber" : 30, "OperationName" : "Tablet Packing", "StandardOperationId" : 300100084274253, "StandardOperationCode" : "TPCK", "WorkAreaId" : 300100081228354, "WorkAreaName" : "Tablets", "WorkCenterId" : 300100081228366, "WorkCenterName" : "Tablet Packing", "InventoryItemId" : 300100083879158, "SerialNumber" : "SN22001", "SerialStatus" : "COMPLETED", "SerialStatusDescription" : "Completed" }