Jump to

• Request
• Response

Get all materials

get

/fscmRestApi/resources/11.13.18.05/maintenanceWorkOrders/{WorkOrderId}/child/WorkOrderOperation/{WoOperationId}/child/WorkOrderOperationMaterial

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.
• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds resources according to the primary key.
    Finder Variables:
    • WoOperationMaterialId; integer; Value that uniquely identifies the material for the work order operation.
  • RowFinder: Finds resources according to the row finder.
    Finder Variables:
    • WoOperationMaterialId; integer; Value that uniquely identifies the material for the work order operation.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AllocatedQuantity; number; Quantity of material allocated during the picking process when a movement request is created for a work order operation item.
  • BasisType; string; 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. The default value is variable.
  • IncludeInPlanningFlag; boolean; 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; 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; 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; Net quantity of the material issued to the operation.
  • ItemNumber; string; 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.
  • MaterialSequenceNumber; number; 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.
  • OperationSequenceNumber; number; 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; 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; 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.
  • RepairTransactionName; string; Meaning of the repair transaction code.
  • RequiredDate; string; 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.
  • RequiredQuantity; number; Required component quantity. The value ia derived based on the value of Basis Type and Quantity attributes. This attribute is read-only.
  • StandardOperationCode; string; 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; 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.
  • SupplyLocatorId; integer; 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; 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; 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.
  • UOMCode; string; Abbreviation that identifies the unit of measure (UOM) of the operation material quantity.
  • UnitOfMeasure; string; 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.
  • WoOperationMaterialId; integer; 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; 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; 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; 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; 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; 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.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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 Top

Response

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.

Body ()

Root Schema : maintenanceWorkOrders-WorkOrderOperation-WorkOrderOperationMaterial

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/maintenanceWorkOrders-WorkOrderOperation-WorkOrderOperationMaterial-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object maintenanceWorkOrders-WorkOrderOperation-WorkOrderOperationMaterial-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/maintenanceWorkOrders-WorkOrderOperation-WorkOrderOperationMaterial-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : maintenanceWorkOrders-WorkOrderOperation-WorkOrderOperationMaterial-item-response

Type: object

Show Source

• 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.
• 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. The default value is variable.
• 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: Quantity per Product

  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.
• RequiredQuantity: number
  Title: Required Quantity

  Read Only: true

  Required component quantity. The value ia derived based on the value of Basis Type and Quantity attributes. This attribute is read-only.
• 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: 120

  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.

{
    "type":"object",
    "properties":{
        "SupplySubinventory":{
            "title":"Supply Subinventory",
            "maxLength":"20",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WoOperationMaterialId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PickedQuantity":{
            "title":"Picked Quantity",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "StandardOperationId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SupplyLocator":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IssuedQuantity":{
            "title":"Issued Quantity",
            "type":"number",
            "description":"Net quantity of the material issued to the operation.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "WorkOrderOperationMaterialDFF":{
            "title":"Flexfields for Operation Materials",
            "type":"array",
            "description":"The Flexfields for Operation Materials resource manages descriptive flexfields that contain details about the materials that the work order operation processes.",
            "items":{
                "$ref":"#/components/schemas/maintenanceWorkOrders-WorkOrderOperation-WorkOrderOperationMaterial-WorkOrderOperationMaterialDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "RequiredQuantity":{
            "title":"Required Quantity",
            "type":"number",
            "description":"Required component quantity. The value ia derived based on the value of Basis Type and Quantity attributes. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplyLocatorId":{
            "title":"Supply Locator",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkAreaName":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaterialSequenceNumber":{
            "title":"Sequence",
            "type":"number",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "SupplyType":{
            "title":"Supply Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WorkAreaId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure (UOM) of the operation material quantity.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "InventoryItemNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkCenterName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StandardOperationCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequiredDate":{
            "title":"Required Date",
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RepairTransactionCode":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":"25",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "OperationName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AllocatedQuantity":{
            "title":"Allocated Quantity",
            "type":"number",
            "description":"Quantity of material allocated during the picking process when a movement request is created for a work order operation item.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity per Product",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ReservedQuantity":{
            "title":"Reserved Quantity",
            "type":"number",
            "description":"Quantity of material that is reserved for a work order operation item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "IncludeInPlanningFlag":{
            "title":"Include in planning",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SupplyTypeDescription":{
            "maxLength":"80",
            "type":"string",
            "description":"Description of the operation material supply type. This attribute is read-only. The value of this attribute is derived from the supply type code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ProducedQuantity":{
            "type":"number",
            "description":"Quantity that the work order creates. This attribute is not applicable to maintenance work orders.",
            "nullable":true,
            "x-queryable":true
        },
        "BasisType":{
            "title":"Basis",
            "maxLength":"30",
            "type":"string",
            "description":"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. The default value is variable.",
            "nullable":false,
            "x-queryable":true
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OperationSequenceNumber":{
            "title":"Operation Sequence",
            "type":"number",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RepairTransactionName":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Meaning of the repair transaction code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object maintenanceWorkOrders-WorkOrderOperation-WorkOrderOperationMaterial-WorkOrderOperationMaterialDFF-item-response

{
    "title":"Flexfields for Operation Materials",
    "type":"array",
    "description":"The Flexfields for Operation Materials resource manages descriptive flexfields that contain details about the materials that the work order operation processes.",
    "items":{
        "$ref":"#/components/schemas/maintenanceWorkOrders-WorkOrderOperation-WorkOrderOperationMaterial-WorkOrderOperationMaterialDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : maintenanceWorkOrders-WorkOrderOperation-WorkOrderOperationMaterial-WorkOrderOperationMaterialDFF-item-response

Type: object

Show Source

• __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.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WoOperationMaterialId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Descriptive flexfield context display value for work order operation materials.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"80",
            "type":"string",
            "description":"Descriptive flexfield context name for work order operation materials.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Back to Top