Get one material
get
/fscmRestApi/resources/11.13.18.05/processWorkOrders/{processWorkOrdersUniqID}/child/Operation/{OperationUniqID}/child/Material/{WorkOrderOperationMaterialId}
Request
Path Parameters
-
OperationUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Operations resource and used to uniquely identify an instance of Operations. The client should not generate the hash key value. Instead, the client should query on the Operations collection resource in order to navigate to a specific instance of Operations to get the hash key.
-
WorkOrderOperationMaterialId(required): integer(int64)
Value that uniquely identifies the material for the work order operation. It's a primary key that the application generates when it creates the material for the work order operation.
-
processWorkOrdersUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Process Work Orders resource and used to uniquely identify an instance of Process Work Orders. The client should not generate the hash key value. Instead, the client should query on the Process Work Orders collection resource in order to navigate to a specific instance of Process Work Orders to get the hash key.
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 : processWorkOrders-Operation-Material-item-response
Type:
Show Source
object
-
AllocatedQuantity: number
Title:
Allocated Quantity
Read Only:true
Quantity of the material already allocated. -
BasisType: string
Title:
Basis
Maximum Length:30
Value that indicates whether the material quantity is fixed; for example, quantity per lot produced, or variable; for example, quantity per item produced. A list of accepted values is defined in the lookup type EGP_BOM_BASIS_TYPE. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the process work order input. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the work order operation input. -
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 supply. The default value is true. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the item, product, or assembly in the inventory organization.
-
IssuedQuantity: number
Title:
Issued Quantity
Read Only:true
Default Value:0
Net quantity of the material that the application issued for the operation. -
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the item. -
ItemNumber: string
Maximum Length:
300
Number that identifies the item. If the material type is COMPONENT, then ItemNumber references the component to issue to the work order. If the material type is PRIMARY_PRODUCT, then ItemNumber references the assembly that's an output of the work order. -
ItemRevision: string
Read Only:
true
Maximum Length:18
Value that indicates the revision of the item. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the work order operation input. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who updated the process work order input. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaterialAttachment: array
Material Attachments
Title:
Material Attachments
The Material Attachments resource manages the attachments for input material. -
MaterialDFF: array
Flexfields for Materials
Title:
Flexfields for Materials
The Flexfields for Materials resource manages descriptive flexfields that contain details about the input materials that the work order operation processes. -
MaterialExceptionCount: array
Exception Counts
Title:
Exception Counts
The Exception Counts resource gets the count of exceptions that occurred for input materials during the operation. -
MaterialSequenceNumber: number
Title:
Sequence
Number that indicates the unique sequence of the material assigned to the work order operation. -
MaterialType: string
Read Only:
true
Maximum Length:30
Default Value:COMPONENT
Type of material either produced or consumed by the operation. For materials being consumed, a list of accepted values is defined in the lookup type ORA_WIS_WD_INPUT_MATERIAL. For materials being produced, a list of accepted values is defined in the lookup type ORA_WIS_WD_OUTPUT_MATERIAL. -
OperationName: string
Title:
Name
Read Only:true
Maximum Length:120
Name of the operation that processes the material. -
OperationSequenceNumber: number
Title:
Operation Sequence
Read Only:true
Number that indicates the sequence to use when performing the work order operations. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory organization that's enabled for manufacturing. It's a primary key of the inventory organization. -
PickedQuantity: number
Title:
Picked Quantity
Read Only:true
Quantity of the material already picked. -
ProducedQuantity: number
Read Only:
true
Quantity of the assembly that's completed into inventory. The material type for this material is PRIMARY_PRODUCT. -
Quantity: number
Title:
Required Quantity
Quantity of the required material. -
RemainingAllocatedQuantity: number
Read Only:
true
Quantity of the material remaining to be allocated. -
RequiredDate: string
(date-time)
Title:
Required Date
Date when the plant requires the materials so that it perform the operation. The required date must not occur before the operation start date, or after the operation completion date. -
ReservedQuantity: number
Title:
Reserved Quantity
Read Only:true
Material quantity that's reserved against the work order operation. -
SecondaryQuantity: number
Read Only:
true
Required material quantity in the secondary unit of measure. This attribute is read-only. This attribute is associated with a feature that requires opt in. -
SecondaryUOMCode: string
Title:
Secondary Unit of Measure
Read Only:true
Maximum Length:3
Abbreviation that identifies the secondary unit of measure of the material. This attribute is read-only. This attribute is associated with a feature that requires opt in. -
StandardOperationCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the standard operation. -
StandardOperationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the standard operation that the work order references. It's a primary key that the application generates when it creates the standard operation. -
SubstituteFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether the component is a substitute. This attribute does not have a default value. This attribute is associated with a feature that requires opt in. -
SubstituteMaterial: array
Substitute Materials
Title:
Substitute Materials
The Substitute Materials resource gets the substitute materials that the work order operation uses. -
SupplyLocator: string
Maximum Length:
255
Locator in subinventory to use, by default, when the plant draws material during assembly or an operation pull. -
SupplyLocatorId: integer
(int64)
Title:
Supply Locator
Value that uniquely identifies the locator. It's 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 draws material during assembly or an operation pull. -
SupplyType: string
Title:
Supply Type
Maximum Length:30
Value that indicates the supply type used for the work order operation material. A list of accepted values is defined in the lookup types EGP_WIP_SUP_TYPE and ORA_WIE_WO_SUPPLY_TYPE. -
SupplyTypeDescription: string
Read Only:
true
Maximum Length:80
Description of the supply type. -
UnitOfMeasure: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Unit of measure for the material quantity and can be the item's primary UOM or a UOM that can be converted. If the item is enabled with primary and secondary tracking unit of measure, the value can be the item's secondary UOM. This enhanced behavior is associated with a feature that requires opt in. -
UOMCode: string
Title:
UOM
Maximum Length:3
Abbreviation that identifies the unit of measure of the material quantity and can be the item's primary UOM code or a UOM code that can be converted. If the item is enabled with primary and secondary tracking unit of measure, the value can be the item's secondary UOM code. This enhanced behavior is associated with a feature that requires opt in. -
WorkAreaId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work area. It's 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's 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)
Read Only:
true
Value that uniquely identifies the work order. It's a primary key that the application generates when it creates the work order. -
WorkOrderOperationId: integer
(int64)
Value that uniquely identifies the work order operation. It's 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's a primary key that the application generates when it creates the material for the work order operation. -
YieldFactor: number
Title:
Item Yield
Default Value:1
Factor to use when calculating the quantity that the operation requires to accommodate component waste when it processes the item. It's recommended that you set the yield to between 0 and 1. You can set the yield to a value that's greater than 1. The application considers the yield when it calculates the required quantity according to the Include plant parameter for the component yield.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Material Attachments
Type:
array
Title:
Material Attachments
The Material Attachments resource manages the attachments for input material.
Show Source
Nested Schema : Flexfields for Materials
Type:
array
Title:
Flexfields for Materials
The Flexfields for Materials resource manages descriptive flexfields that contain details about the input materials that the work order operation processes.
Show Source
Nested Schema : Exception Counts
Type:
array
Title:
Exception Counts
The Exception Counts resource gets the count of exceptions that occurred for input materials during the operation.
Show Source
Nested Schema : Substitute Materials
Type:
array
Title:
Substitute Materials
The Substitute Materials resource gets the substitute materials that the work order operation 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 : processWorkOrders-Operation-Material-MaterialAttachment-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
An identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the attachment of a work order operation material. It's a primary key that the application generates when a document is attached to the work order operation material. -
CategoryName: string
Title:
Category
Maximum Length:30
Name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Login that the user used when creating the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attachment record. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the current version of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the contents of the attachment expire. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the user most recently updated the document that's attached to the work order. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Login of the user who most recently updated the document that's attached to the work order. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the document that's attached to the work order. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attached file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attached file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL (Uniform Resource Locator) that locates the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login that the user used when adding or modifying the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : processWorkOrders-Operation-Material-MaterialDFF-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
-
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's 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
Nested Schema : processWorkOrders-Operation-Material-MaterialExceptionCount-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
WorkOrderMaterialExceptionCount: integer
Read Only:
true
Count of all the open exceptions for this work order input item. -
WorkOrderOperationMaterialId: integer
(int64)
Read Only:
true
Value that uniquely identifies the material assigned to the operation of the work order. It's a primary key that the application generates when it creates the item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : processWorkOrders-Operation-Material-SubstituteMaterial-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the substitute material. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the substitute material. -
InventoryItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item, product, or assembly in the inventory organization. This attribute is associated with a feature that requires opt in. -
InverseQuantity: number
Title:
Inverse
Inverse of the Quantity Per Product attribute. The application uses the inverse when the Quantity Per Product for the material is a fraction but the inverse of this quantity is an integer. This attribute is associated with a feature that requires opt in. -
ItemNumber: string
Read Only:
true
Maximum Length:300
Number that identifies the item, which is an output of the work order. This attribute is associated with a feature that requires opt in. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the substitute material. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the substitute material. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationCode: string
Read Only:
true
Maximum Length:255
Abbreviation that identifies the inventory organization that's enabled for manufacturing. This attribute is associated with a feature that requires opt in. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory organization that's enabled for manufacturing. It's a primary key of the inventory organization. This attribute is associated with a feature that requires opt in. -
Priority: number
Title:
Priority
Ranking of the substitute component to use instead of the primary component. This attribute is associated with a feature that requires opt in. -
QuantityPERProduct: number
Title:
Quantity per Product
Quantity required to manufacture each unit of the substitute material. This attribute is associated with a feature that requires opt in. -
RequiredQuantity: number
Title:
Required Quantity
Required quantity of the substitute material. -
SubstituteFlag: boolean
Maximum Length:
1
Mark used indicate whether the component is a substitute or not. This attribute is associated with a feature that requires opt in. -
UnitOfMeasure: string
Read Only:
true
Maximum Length:255
Primary unit of measure for the substitute material quantity. This attribute is associated with a feature that requires opt in. -
UOMCode: string
Title:
Primary UOM
Maximum Length:3
Abbreviation that identifies the unit of measure that the substitute material uses. This attribute is associated with a feature that requires opt in. -
WorkOrderOperationMaterialId: integer
(int64)
Read Only:
true
Value that uniquely identifies the material for a work order operation. It's a primary key that the application generates when it consumes the material. This attribute is associated with a feature that requires opt in. -
WorkOrderOperationSubstituteMaterialId: integer
(int64)
Value that uniquely identifies the substitute material for a work order operation. It's a primary key that the application generates when it consumes the substitute material. This attribute is associated with a feature that requires opt in.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- MaterialAttachment
-
Parameters:
- OperationUniqID:
$request.path.OperationUniqID
- WorkOrderOperationMaterialId:
$request.path.WorkOrderOperationMaterialId
- processWorkOrdersUniqID:
$request.path.processWorkOrdersUniqID
The Material Attachments resource manages the attachments for input material. - OperationUniqID:
- MaterialDFF
-
Parameters:
- OperationUniqID:
$request.path.OperationUniqID
- WorkOrderOperationMaterialId:
$request.path.WorkOrderOperationMaterialId
- processWorkOrdersUniqID:
$request.path.processWorkOrdersUniqID
The Flexfields for Materials resource manages descriptive flexfields that contain details about the input materials that the work order operation processes. - OperationUniqID:
- MaterialExceptionCount
-
Parameters:
- OperationUniqID:
$request.path.OperationUniqID
- WorkOrderOperationMaterialId:
$request.path.WorkOrderOperationMaterialId
- processWorkOrdersUniqID:
$request.path.processWorkOrdersUniqID
The Exception Counts resource gets the count of exceptions that occurred for input materials during the operation. - OperationUniqID:
- SubstituteMaterial
-
Parameters:
- OperationUniqID:
$request.path.OperationUniqID
- WorkOrderOperationMaterialId:
$request.path.WorkOrderOperationMaterialId
- processWorkOrdersUniqID:
$request.path.processWorkOrdersUniqID
The Substitute Materials resource gets the substitute materials that the work order operation uses. - OperationUniqID:
- replaceWithSubstitute
-
Parameters:
- OperationUniqID:
$request.path.OperationUniqID
- WorkOrderOperationMaterialId:
$request.path.WorkOrderOperationMaterialId
- processWorkOrdersUniqID:
$request.path.processWorkOrdersUniqID
Replaces the operation material with a substitute. To replace the operation material, the client sends the substitute item identifier or substitute item number to uniquely identify the substitute item. The application then replaces the operation material with a substitute item. The replaced item becomes the substitute for the new operation material. - OperationUniqID: