Get one component
get
/fscmRestApi/resources/11.13.18.05/workOrders/{WorkOrderId}/child/WorkOrderAssemblyComponent/{WoOperationMaterialId}
Request
Path Parameters
-
WoOperationMaterialId(required): integer(int64)
Value that uniquely identifies the rework that references the material. This material is an assembly that the work order will rework. It is a primary key of the material.
-
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.
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-WorkOrderAssemblyComponent-item-response
Type:
Show Source
object
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the item, product, or assembly in the inventory organization.
-
IssuedQuantity: number
Title:
Issued Quantity
Quantity of the reworked assembly that the application issues for the operation when it releases the work order. -
ItemNumber: string
Read Only:
true
Maximum Length:300
Number that identifies the item, which is an output of the work order. -
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. -
OperationSequenceNumber: number
Title:
Operation Sequence
Read Only:true
Sequence to use when performing the work order operations. -
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization that's enabled for manufacturing. It is a primary key of the inventory organization.
-
Quantity: number
Title:
Required Quantity
Planned quantity of the reworked assembly for the work order. This is equal to the work order quantity. -
ReservedQuantity: number
Title:
Reserved Quantity
Read Only:true
Reserved quantity of the reworked assembly for the work order. -
SupplyLocator: string
Maximum Length:
255
Locator in the subinventory to use, by default, when the plant gets the material for rework. -
SupplyLocatorId: integer
(int64)
Title:
Supply Locator
Value that uniquely identifies the locator. It is a primary key that the application generates when it creates the locator. -
SupplySubinventory: string
Title:
Supply Subinventory
Maximum Length:20
Subinventory to use, by default, when the plant gets the material for rework. -
UnitOfMeasure: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Unit of measure that the item uses for the reworked assembly. It is the primary unit of measure. -
WoOperationId: integer
(int64)
Value that uniquely identifies the first count point operation of the rework that references this material. This material is an assembly that the work order will rework. It is a primary key of the work order operation.
-
WoOperationMaterialId: integer
(int64)
Value that uniquely identifies the rework that references the material. This material is an assembly that the work order will rework. It is a primary key of the material.
-
WorkOrderAssemblyComponentLot: array
Lots for Assemblies
Title:
Lots for Assemblies
The Lots for Assemblies resource manages the lot that the application issued for the assembly that the rework work order uses. -
WorkOrderAssemblyComponentSerial: array
Serials for Assemblies
Title:
Serials for Assemblies
The Serials for Assemblies resource manages serial that the application issued for the assembly that the rework work order uses. -
WorkOrderId: integer
(int64)
Value that uniquely identifies the reworked work order. It is a primary key of the rework work order.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Lots for Assemblies
Type:
array
Title:
Lots for Assemblies
The Lots for Assemblies resource manages the lot that the application issued for the assembly that the rework work order uses.
Show Source
Nested Schema : Serials for Assemblies
Type:
array
Title:
Serials for Assemblies
The Serials for Assemblies resource manages serial that the application issued for the assembly that the rework work order uses.
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 : workOrders-WorkOrderAssemblyComponent-WorkOrderAssemblyComponentLot-item-response
Type:
Show Source
object
-
AssociatedQuantity: number
Title:
Quantity
Quantity for the lot number to issue for the reworked work order. -
IssuedQuantity: number
Read Only:
true
Quantity of the lot for the reworked assembly that the application uses for the operation when it releases the work order. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotNumber: string
Title:
Lot Number
Maximum Length:80
Lot number of the reworked assembly. -
WoOperationMaterialId: integer
(int64)
Value that uniquely identifies the reworked assembly. It is a primary key that the application generates when it creates the item.
-
WoOperationMaterialLotId: integer
(int64)
Read Only:
true
Value that uniquely identifies the lot of the reworked assembly. It is a primary key that the application generates when it creates a lot. -
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workOrders-WorkOrderAssemblyComponent-WorkOrderAssemblyComponentSerial-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. -
LotNumber: string
Lot number of the reworked assembly.
-
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
Title:
Serial Number
Maximum Length:80
Serial number that identifies the reworked assembly. -
WoOperationMaterialId: integer
(int64)
Value that uniquely identifies the reworked assembly. It is a primary key that the application generates when it creates the item.
-
WoOperationMaterialLotId: integer
(int64)
Read Only:
true
Value that uniquely identifies the lot of the reworked assembly. It is a primary key that the application generates when it creates a lot. -
WoOperationMaterialSerialId: integer
(int64)
Read Only:
true
Value that uniquely identifies the serial of the reworked assembly. It is a primary key that the application generates when it creates a 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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- WorkOrderAssemblyComponentLot
-
Parameters:
- WoOperationMaterialId:
$request.path.WoOperationMaterialId
- WorkOrderId:
$request.path.WorkOrderId
The Lots for Assemblies resource manages the lot that the application issued for the assembly that the rework work order uses. - WoOperationMaterialId:
- WorkOrderAssemblyComponentSerial
-
Parameters:
- WoOperationMaterialId:
$request.path.WoOperationMaterialId
- WorkOrderId:
$request.path.WorkOrderId
The Serials for Assemblies resource manages serial that the application issued for the assembly that the rework work order uses. - WoOperationMaterialId:
Examples
This example describes how to get one assembly 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/WorkOrderAssemblyComponent/WoOperationMaterialId"
For example, the following command gets assembly 300100123758219 for work order 300100123758184:
curl -u username:password "https://servername/fscmRestApi/resources/version/workOrders/300100123758184/child/WorkOrderAssemblyComponent/300100123758219"
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "OrganizationId": 207, "WorkOrderId": 300100123758184, "WoOperationId": 300100123758215, "OperationSequenceNumber": 10, "OperationName": "OP10", "WoOperationMaterialId": 300100123758219, "InventoryItemId": 300100036689383, "ItemNumber": "MFG-SER-PROD1", "Quantity": 1, "UnitOfMeasure": "Each", "SupplySubinventory": "ABCSUB01", "SupplyLocatorId": 3134, "SupplyLocator": "ABC1.1.1", "IssuedQuantity": 1, ... }