Get one material
get
/fscmRestApi/resources/11.13.18.05/maintenanceWorkOrders/{WorkOrderId}/child/WorkOrderOperation/{WoOperationId}/child/WorkOrderOperationMaterial/{WoOperationMaterialId}
Request
Path Parameters
-
WoOperationId(required): integer(int64)
Value that uniquely identifies the work order operation. This attribute is read-only. The value of this attribute is generated when the application creates the work order operation.
-
WoOperationMaterialId(required): integer(int64)
Value that uniquely identifies the material for work order operation. This attribute is read-only. The value of this attribute is generated when the application creates the operation material.
-
WorkOrderId(required): integer(int64)
Value that uniquely identifies the work order. This attribute is read-only. The value of this attribute is derived from the work order number when the application 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 : maintenanceWorkOrders-WorkOrderOperation-WorkOrderOperationMaterial-item-response
Type:
Show Source
object
-
AllocatedQuantity: number
Title:
Allocated Quantity
Quantity of material allocated during the picking process when a movement request is created for a work order operation item. -
IncludeInPlanningFlag: boolean
Title:
Include in planning
Maximum Length:1
Contains one of the following values: true or false. If true, then planning considers the material when it plans the supply. If false, then planning does not consider the material when it plans the supply. The default value is true. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the material component item to issue to the work order. You must provide either the item number or the item identifier to create a work order operation material.
-
InventoryItemNumber: string
Maximum Length:
255
Number that uniquely identifies the material component item to issue to the work order. You must provide either the item number or the item identifier to create a work order operation material. -
IssuedQuantity: number
Title:
Issued Quantity
Net quantity of the material issued to the operation. -
ItemNumber: string
Read Only:
true
Maximum Length:300
Number that identifies the material component item to issue to the work order. You must provide either the item number or the item identifier to create a work order operation material. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaterialSequenceNumber: number
Title:
Sequence
Number that identifies the sequence of the material component assigned to the work order operation. The sequence is required to create an operation material. The last operation material sequence incremented by 10 is used as sequence to create an operation material. -
OperationName: string
Title:
Name
Read Only:true
Maximum Length:120
Name of the operation to which the operation material belongs. This attribute is read-only. The value of this attribute is derived from the work order operation. -
OperationSequenceNumber: number
Title:
Operation Sequence
Read Only:true
Number that identifies the sequence to use when performing the work order operations to which the operation material belongs. This attribute is read-only. The value of this attribute is derived from the work order operation. -
PickedQuantity: number
Title:
Picked Quantity
Quantity of material picked when the pick slip is confirmed and is issued either directly to the work order or is moved to the supply subinventory for a work order operation item. -
ProducedQuantity: number
Quantity that the work order creates. This attribute is not applicable to maintenance work orders.
-
Quantity: number
Title:
Required Quantity
Material component quantity required to complete the work order operation per asset. It's a required attribute to create an operation material. The value of the RequiredQuantity attribute is calculated based on this value and the option chosen for basis type. -
RepairTransactionCode: string
Maximum Length:
255
Abbreviation that identifies the reason for repair of the maintenance work order operation material. This attribute is read-only. The list of values comes from the user-defined condition event codes with the transaction type Reason for repair. -
RepairTransactionName: string
Title:
Name
Read Only:true
Maximum Length:240
Meaning of the repair transaction code. -
RequiredDate: string
(date-time)
Title:
Required Date
Date when the plant requires the materials so it can perform the operation. This attribute is required. The default value is the operation start date. The required date must not occur before the operation start date, or after the operation completion date. -
ReservedQuantity: number
Title:
Reserved Quantity
Quantity of material that is reserved for a work order operation item. -
StandardOperationCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the standard operation the operation is referring to. This attribute is read-only. The value of this attribute is derived from the operation. -
StandardOperationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the standard operation the operation is referring to. This attribute is read-only. The value of this attribute is derived from the operation. -
SupplyLocator: string
Read Only:
true
Maximum Length:255
Name of the supply locator from where the material component item is issued. This attribute is read-only. The value of this attribute is derived from the supply locator identifier. -
SupplyLocatorId: integer
(int64)
Title:
Supply Locator
Value that uniquely identifies the supply subinventory locator from where the material is issued during an assembly or operation pull. The default value is the component item definition or the plant parameters. -
SupplySubinventory: string
Title:
Supply Subinventory
Maximum Length:20
Supply subinventory from where the material is issued during an assembly or operation pull. The default value is the component item definition or the plant parameters. -
SupplyType: string
Title:
Supply Type
Maximum Length:30
Type of consumption of the material component. Valid values include 1: Push, 2: Assembly pull, 3: Operation pull, 4: Bulk, and 5: Supplier. This attribute is required to create an operation material. If the supply type is not provided the default value is material component item. If the work order was created with a work definition then the default value is based on the work definition. -
SupplyTypeDescription: string
Read Only:
true
Maximum Length:80
Description of the operation material supply type. This attribute is read-only. The value of this attribute is derived from the supply type code. -
UnitOfMeasure: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Unit of measure of the material component quantity to be issued. It is the primary unit of measure of the item. This attribute is read-only. The value of this attribute is derived from the material component item. -
UOMCode: string
Title:
UOM
Maximum Length:3
Abbreviation that identifies the unit of measure (UOM) of the operation material quantity. -
WoOperationMaterialId: integer
(int64)
Value that uniquely identifies the material for work order operation. This attribute is read-only. The value of this attribute is generated when the application creates the operation material.
-
WorkAreaId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work area in which the operation is performed. This attribute is read-only. The value of this attribute is derived from the operation work center. -
WorkAreaName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the work area in which the operation is performed. This attribute is read-only. The value of this attribute is derived from the operation work center. -
WorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work center in which the operation is performed. This attribute is read-only. The value of this attribute is derived from the operation. -
WorkCenterName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the work center in which the operation is performed. This attribute is read-only. The value of this attribute is derived from the operation. -
WorkOrderId: integer
(int64)
Value that uniquely identifies the work order to which the operation material belongs. This attribute is read-only. The value of this attribute is derived from the work order.
-
WorkOrderOperationMaterialDFF: array
Flexfields for Operation Materials
Title:
Flexfields for Operation Materials
The Flexfields for Operation Materials resource manages descriptive flexfields that contain details about the materials that the work order operation processes.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Operation Materials
Type:
array
Title:
Flexfields for Operation Materials
The Flexfields for Operation Materials resource manages descriptive flexfields that contain details about the materials that the work order operation processes.
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 : maintenanceWorkOrders-WorkOrderOperation-WorkOrderOperationMaterial-WorkOrderOperationMaterialDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:80
Descriptive flexfield context name for work order operation materials. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for work order operation materials. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
WoOperationMaterialId: integer
(int64)
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- WorkOrderOperationMaterialDFF
-
Parameters:
- WoOperationId:
$request.path.WoOperationId
- WoOperationMaterialId:
$request.path.WoOperationMaterialId
- WorkOrderId:
$request.path.WorkOrderId
The Flexfields for Operation Materials resource manages descriptive flexfields that contain details about the materials that the work order operation processes. - WoOperationId: