Get one substitute material
get
/fscmRestApi/resources/11.13.18.05/processWorkOrders/{processWorkOrdersUniqID}/child/Operation/{WorkOrderOperationId}/child/Material/{WorkOrderOperationMaterialId}/child/SubstituteMaterial/{WorkOrderOperationSubstituteMaterialId}
Request
Path Parameters
-
WorkOrderOperationId(required): 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(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.
-
WorkOrderOperationSubstituteMaterialId(required): 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.
-
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-SubstituteMaterial-item-response
Type:
Show Source
object
-
AvailableToTransact: number
Read Only:
true
Quantity available to transact for the substitute material. -
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. -
Description: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of 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. -
OnhandQuantity: number
Title:
Organization On-Hand Balance
Read Only:true
On-hand quantity of the substitute material. -
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
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.