Jump to

• Request
• Response

Get all work order materials

get

/fscmRestApi/resources/11.13.18.05/maintenanceWorkOrderMaterials

Request

Query Parameters

• 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.
  • WorkOrderMaterialsByAsset: Finds work order materials according to the provided asset and work order identifiers.
    Finder Variables:
    • BindAssetId; integer; Value that uniquely identifies the asset.
    • BindWorkOrderId; integer; Value that uniquely identifies the work order.
• 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.
  • AutoTransactFlag; boolean; 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.
  • BasisType; string; Meaning for the basis type of material defined for the work order operation. Valid values are contained in the lookup EGP_BOM_BASIS_TYPE.
  • BasisTypeCode; string; Abbreviation for the basis type of material defined for the work order operation. Valid values are contained in the lookup EGP_BOM_BASIS_TYPE.
  • CountPointOperationFlag; boolean; 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.
  • CreatedBy; string; Session login associated with the user who created the record.
  • CreationDate; string; Date when the record was created.
  • 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.
  • InventoryItemDescription; string; Description of the item number.
  • 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.
  • InventoryItemLongDescription; string; Long description of the item number.
  • InventoryItemNumber; 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.
  • LastUpdateDate; string; Date when the record was most recently updated.
  • LastUpdatedBy; string; Session login associated with the user who most recently updated the record.
  • LotControlFlag; boolean; Indicates if the item is lot controlled. Values are true or false.
  • 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.
  • MaterialType; string; Meaning for the type of material defined for the work order operation. Valid values are contained in the lookup ORA_WIE_MATERIAL_TYPE.
  • MaterialTypeCode; string; Abbreviation for the type of material defined for the work order operation. Valid values are contained in the lookup ORA_WIE_MATERIAL_TYPE.
  • OpenQuantity; number; Open quantity of the material issued to the operation.
  • OrganizationCode; string; Abbreviation for the maintenance organization of the work order.
  • OrganizationId; integer; Value that uniquely identifies the maintenance organization of the work order.
  • 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 isn't applicable to maintenance work orders.
  • QuantityPerAsset; number; 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.
  • RepairTransactionCode; string; 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.
  • RepairTransactionCodeId; integer; 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.
  • 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; 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.
  • SerialControlFlag; boolean; Indicates if the item is serial controlled. Values are true or false.
  • SupplyLocator; string; 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; 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 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.
  • SupplyTypeDescription; string; Description of the operation material supply type. This attribute is read-only. The value of this attribute is derived from the supply type code.
  • UOMCode; string; Abbreviation that identifies the unit of measure 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.
  • WoOperationDescription; string; Description of the operation to be performed during the work order execution. The operation description is optional to create the work order operation.
  • WoOperationId; integer; Value that uniquely identifies the work order operation. This attribute is read-only. The value of this attribute is generated when the application creates the work order operation.
  • WoOperationMaterialId; 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.
  • WoOperationName; string; Name of the work order operation. The operation name is required to create an operation.
  • WoOperationSequenceNumber; number; 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.
  • WorkOrderId; integer; 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.
  • WorkOrderNumber; string; 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.
• 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 : maintenanceWorkOrderMaterials

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/maintenanceWorkOrderMaterials-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"Maintenance",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object maintenanceWorkOrderMaterials-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/maintenanceWorkOrderMaterials-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 : maintenanceWorkOrderMaterials-item-response

Type: object

Show Source

• AllocatedQuantity: number
  Read Only: true

  Quantity of material allocated during the picking process when a movement request is created for a work order operation item.
• AssetTrackedFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates if the item is asset-tracked. Values are true or false.
• AutoTransactFlag: boolean
  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.
• BasisType: string
  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.
• BasisTypeCode: string
  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.
• CountPointOperationFlag: boolean
  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.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Session login associated with the user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date when the record was created.
• IncludeInPlanningFlag: boolean
  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.
• InventoryItemDescription: string
  Title: Item Description

  Read Only: true

  Maximum Length: 240

  Description of the item number.
• InventoryItemId: integer (int64)
  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.
• InventoryItemLongDescription: string
  Title: Long Description

  Read Only: true

  Maximum Length: 4000

  Long description of the item number.
• InventoryItemNumber: 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.
• IssuedQuantity: number
  Read Only: true

  Net quantity of the material issued to the operation.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the record was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Session login associated with the user who most recently updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocatorControlFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates if the item is locator controlled. Values are true or false.
• LotControlFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates if the item is lot controlled. Values are true or false.
• MaterialSequenceNumber: number
  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.
• MaterialType: string
  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.
• MaterialTypeCode: string
  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.
• OnHandQuantity: number
  Title: Organization On-Hand Balance

  Read Only: true

  Available quantity of the material in the subinventory location.
• OpenQuantity: number
  Read Only: true

  Open quantity of the material issued to the operation.
• OrganizationCode: string
  Title: Organization

  Read Only: true

  Maximum Length: 18

  Abbreviation for the maintenance organization of the work order.
• OrganizationId: integer (int64)
  Title: Organization

  Read Only: true

  Value that uniquely identifies the maintenance organization of the work order.
• PickedQuantity: number
  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.
• ProducedQuantity: number
  Read Only: true

  Quantity that the work order creates. This attribute isn't applicable to maintenance work orders.
• QuantityIssuedPerAsset: number
  Read Only: true

  Net quantity of the material issued per asset to the operation.
• QuantityPerAsset: number
  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.
• RepairTransactionCode: string
  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.
• RepairTransactionCodeId: integer (int64)
  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.
• RepairTransactionName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Meaning of the repair transaction code.
• RequiredDate: string (date-time)
  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.
• RequiredQuantity: number
  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.
• ReservedQuantity: number
  Title: Reserved Quantity

  Read Only: true

  Quantity of material that is reserved for a work order operation item.
• SerialControlFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates if the item is serial controlled. Values are true or false.
• 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

  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.
• SupplySubinventory: string
  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.
• SupplyType: string
  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.
• 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

  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure of the operation material quantity.
• WoOperationDescription: string
  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.
• WoOperationId: integer (int64)
  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.
• WoOperationMaterialId: integer (int64)
  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.
• WoOperationName: string
  Title: Name

  Read Only: true

  Maximum Length: 120

  Name of the work order operation. The operation name is required to create an operation.
• WoOperationSequenceNumber: number
  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.
• WorkOrderId: integer (int64)
  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.
• WorkOrderNumber: string
  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.

{
    "type":"object",
    "properties":{
        "LocatorControlFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates if the item is locator controlled. Values are true or false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PickedQuantity":{
            "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,
            "readOnly":true,
            "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":true
        },
        "MaterialType":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning for the type of material defined for the work order operation. Valid values are contained in the lookup ORA_WIE_MATERIAL_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OpenQuantity":{
            "type":"number",
            "description":"Open quantity of the material issued to the operation.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "AssetId",
                    "BasisTypeCode",
                    "IssuedQuantity",
                    "QuantityIssuedPerAsset",
                    "QuantityPerAsset",
                    "RequiredQuantity"
                ]
            },
            "x-queryable":true
        },
        "IssuedQuantity":{
            "type":"number",
            "description":"Net quantity of the material issued to the operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CountPointOperationFlag":{
            "title":"Count Point",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "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 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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InventoryItemLongDescription":{
            "title":"Long Description",
            "maxLength":"4000",
            "type":"string",
            "description":"Long description of the item number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure of the operation material quantity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Session login associated with the user who most recently updated the record.",
            "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,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetTrackedFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates if the item is asset-tracked. Values are true or false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Session login associated with the user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "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,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QuantityPerAsset":{
            "title":"Quantity per Product",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AllocatedQuantity":{
            "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,
            "readOnly":true,
            "x-queryable":true
        },
        "WoOperationName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the work order operation. The operation name is required to create an operation.",
            "nullable":false,
            "readOnly":true,
            "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":true
        },
        "AutoTransactFlag":{
            "title":"Automatically transact",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderNumber":{
            "title":"Work Order",
            "maxLength":"120",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LotControlFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates if the item is lot controlled. Values are true or false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BasisTypeCode":{
            "title":"Basis",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation for the basis type of material defined for the work order operation. Valid values are contained in the lookup EGP_BOM_BASIS_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RepairTransactionCodeId":{
            "title":"Repair Transaction Code",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RepairTransactionName":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Meaning of the repair transaction code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SerialControlFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates if the item is serial controlled. Values are true or false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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,
            "readOnly":true,
            "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,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Organization",
            "type":"integer",
            "description":"Value that uniquely identifies the maintenance organization of the work order.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WoOperationDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the operation to be performed during the work order execution. The operation description is optional to create the work order operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OnHandQuantity":{
            "title":"Organization On-Hand Balance",
            "type":"number",
            "description":"Available quantity of the material in the subinventory location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId"
                ]
            }
        },
        "InventoryItemDescription":{
            "title":"Item Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the item number.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequiredQuantity":{
            "title":"Required Quantity",
            "type":"number",
            "description":"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.",
            "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,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QuantityIssuedPerAsset":{
            "type":"number",
            "description":"Net quantity of the material issued per asset to the operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "title":"Organization",
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation for the maintenance organization of the work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WoOperationSequenceNumber":{
            "title":"Operation Sequence",
            "type":"number",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemNumber":{
            "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
        },
        "RepairTransactionCode":{
            "title":"Code",
            "maxLength":"30",
            "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":false,
            "readOnly":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,
            "readOnly":true,
            "x-queryable":false
        },
        "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,
            "readOnly":true,
            "x-queryable":true
        },
        "ProducedQuantity":{
            "type":"number",
            "description":"Quantity that the work order creates. This attribute isn't applicable to maintenance work orders.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BasisType":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning for the basis type of material defined for the work order operation. Valid values are contained in the lookup EGP_BOM_BASIS_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WoOperationId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MaterialTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation for the type of material defined for the work order operation. Valid values are contained in the lookup ORA_WIE_MATERIAL_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the record was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "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 : 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."
        }
    }
}

Back to Top