Get one work order material

get

/fscmRestApi/resources/11.13.18.05/maintenanceWorkOrderMaterials/{WoOperationMaterialId}

Request

Path Parameters
Query Parameters
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : maintenanceWorkOrderMaterials-item-response
Type: object
Show Source
  • Read Only: true
    Quantity of material allocated during the picking process when a movement request is created for a work order operation item.
  • Read Only: true
    Maximum Length: 255
    Indicates if the item is asset-tracked. Values are true or false.
  • Title: Automatically transact
    Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then automatically report the operation when the operation occurs on the shop floor. If false, then don't report this operation automatically. If the operation isn't significant, it's recommended that you set AutoTransactFlag to true. The Count Point attribute and the Automatically Transact attribute are mutually exclusive. You must make sure that each of these attributes do not both contain true. If the Count Point and Automatically Transact attributes each contain false, then the operation is optional. Note that the user can manually report component usage and resource usage for an optional operation. The default value is false.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Meaning for the basis type of material defined for the work order operation. Valid values are contained in the lookup EGP_BOM_BASIS_TYPE.
  • Title: Basis
    Read Only: true
    Maximum Length: 30
    Abbreviation for the basis type of material defined for the work order operation. Valid values are contained in the lookup EGP_BOM_BASIS_TYPE.
  • Title: Count Point
    Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then make this operation a count point operation. If an operation occurs on the shop floor, the user must manually report it in the application when the operation occurs. If false, then don't make this operation a count point operation. The user doesn't need to report the operation. It's recommended that you configure each work order so that it includes at least one count point operation, and to make sure that the last operation that the work order performs is a count point operation. The default value is true.
  • Read Only: true
    Maximum Length: 64
    Session login associated with the user who created the record.
  • Read Only: true
    Date when the record was created.
  • Title: Include in planning
    Read Only: true
    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.
  • Title: Item Description
    Read Only: true
    Maximum Length: 240
    Description of the item number.
  • Read Only: true
    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.
  • Title: Long Description
    Read Only: true
    Maximum Length: 4000
    Long description of the item number.
  • 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.
  • Read Only: true
    Net quantity of the material issued to the operation.
  • Read Only: true
    Date when the record was most recently updated.
  • Read Only: true
    Maximum Length: 64
    Session login associated with the user who most recently updated the record.
  • Links
  • Read Only: true
    Maximum Length: 255
    Indicates if the item is locator controlled. Values are true or false.
  • Read Only: true
    Maximum Length: 255
    Indicates if the item is lot controlled. Values are true or false.
  • Title: Sequence
    Read Only: true
    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.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Meaning for the type of material defined for the work order operation. Valid values are contained in the lookup ORA_WIE_MATERIAL_TYPE.
  • Read Only: true
    Maximum Length: 30
    Abbreviation for the type of material defined for the work order operation. Valid values are contained in the lookup ORA_WIE_MATERIAL_TYPE.
  • Title: Organization On-Hand Balance
    Read Only: true
    Available quantity of the material in the subinventory location.
  • Read Only: true
    Open quantity of the material issued to the operation.
  • Title: Organization
    Read Only: true
    Maximum Length: 18
    Abbreviation for the maintenance organization of the work order.
  • Title: Organization
    Read Only: true
    Value that uniquely identifies the maintenance organization of the work order.
  • Read Only: true
    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.
  • Read Only: true
    Quantity that the work order creates. This attribute isn't applicable to maintenance work orders.
  • Read Only: true
    Net quantity of the material issued per asset to the operation.
  • Title: Quantity per Product
    Read Only: true
    Material component quantity per asset which is required to be issued for the work order operation. The material component quantity is required to create an operation material.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    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.
  • Title: Repair Transaction Code
    Read Only: true
    Value that uniquely 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.
  • Title: Name
    Read Only: true
    Maximum Length: 240
    Meaning of the repair transaction code.
  • Title: Required Date
    Read Only: true
    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.
  • Title: Required Quantity
    Read Only: true
    Material component quantity which is required to be issued for the work order operation. The material component quantity is required to create an operation material.
  • Title: Reserved Quantity
    Read Only: true
    Quantity of material that is reserved for a work order operation item.
  • Read Only: true
    Maximum Length: 255
    Indicates if the item is serial controlled. Values are true or false.
  • 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.
  • Title: Supply Locator
    Read Only: true
    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.
  • Title: Supply Subinventory
    Read Only: true
    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.
  • Title: Supply Type
    Read Only: true
    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 isn't provided, then 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.
  • 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.
  • 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.
  • Title: UOM
    Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the unit of measure of the operation material quantity.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the operation to be performed during the work order execution. The operation description is optional to create the work order operation.
  • Read Only: true
    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.
  • Read Only: true
    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.
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name of the work order operation. The operation name is required to create an operation.
  • Title: Operation Sequence
    Read Only: true
    Number that identifies the sequence to use when performing the work order operations. The operation sequence is required to create an operation. It must be a positive integer. Its value must be unique within the work order operations. If it isn't provided, then the last operation sequence incremented by 10 is used as sequence to create an operation.
  • Read Only: true
    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.
  • Title: Work Order
    Read Only: true
    Maximum Length: 120
    Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number.
Back to Top