Jump to

• Request
• Response

Update one material

patch

/fscmRestApi/resources/11.13.18.05/processWorkOrders/{processWorkOrdersUniqID}/child/Operation/{WorkOrderOperationId}/child/Material/{WorkOrderOperationMaterialId}

Request

Path Parameters

• WorkOrderOperationId(required): integer(int64)
  Value that uniquely identifies the work order operation. It's a primary key that the application generates when it creates the work order operation.
• WorkOrderOperationMaterialId(required): integer(int64)
  Value that uniquely identifies the material for the work order operation. It's a primary key that the application generates when it creates the material for the work order operation.
• processWorkOrdersUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Process Work Orders resource and used to uniquely identify an instance of Process Work Orders. The client should not generate the hash key value. Instead, the client should query on the Process Work Orders collection resource in order to navigate to a specific instance of Process Work Orders to get the hash key.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• IncludeInPlanningFlag: boolean
  Title: Include in planning

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then planning considers the material when it plans the supply. If false, then planning does not consider the material when it plans supply. The default value is true.
• MaterialAttachment: array Material Attachments
  Title: Material Attachments

  The Material Attachments resource manages the attachments for input material.
• MaterialDFF: array Flexfields for Materials
  Title: Flexfields for Materials

  The Flexfields for Materials resource manages descriptive flexfields that contain details about the input materials that the work order operation processes.
• MaterialExceptionCount: array Exception Counts
  Title: Exception Counts

  The Exception Counts resource gets the count of exceptions that occurred for input materials during the operation.
• Quantity: number
  Title: Required Quantity

  Quantity of the required material.
• RequiredDate: string (date-time)
  Title: Required Date

  Date when the plant requires the materials so that it perform the operation. The required date must not occur before the operation start date, or after the operation completion date.
• SubstituteMaterial: array Substitute Materials
  Title: Substitute Materials

  The Substitute Materials resource gets the substitute materials that the work order operation uses.
• SupplyLocator: string
  Maximum Length: 255

  Locator in subinventory to use, by default, when the plant draws material during assembly or an operation pull.
• SupplyLocatorId: integer (int64)
  Title: Supply Locator

  Value that uniquely identifies the locator. It's a primary key that the application generates when it creates the locator.
• SupplySubinventory: string
  Title: Supply Subinventory

  Maximum Length: 20

  Subinventory to use, by default, when the plant draws material during assembly or an operation pull.
• SupplyType: string
  Title: Supply Type

  Maximum Length: 30

  Value that indicates the supply type used for the work order operation material. A list of accepted values is defined in the lookup types EGP_WIP_SUP_TYPE and ORA_WIE_WO_SUPPLY_TYPE.
• YieldFactor: number
  Title: Item Yield

  Default Value: 1

  Factor to use when calculating the quantity that the operation requires to accommodate component waste when it processes the item. It's recommended that you set the yield to between 0 and 1. You can set the yield to a value that's greater than 1. The application considers the yield when it calculates the required quantity according to the Include plant parameter for the component yield.

{
    "type":"object",
    "properties":{
        "RequiredDate":{
            "title":"Required Date",
            "type":"string",
            "description":"Date when the plant requires the materials so that it perform the operation. The required date must not occur before the operation start date, or after the operation completion date.",
            "format":"date-time",
            "nullable":true
        },
        "SupplySubinventory":{
            "title":"Supply Subinventory",
            "maxLength":"20",
            "type":"string",
            "description":"Subinventory to use, by default, when the plant draws material during assembly or an operation pull.",
            "nullable":true
        },
        "MaterialExceptionCount":{
            "title":"Exception Counts",
            "type":"array",
            "description":"The Exception Counts resource gets the count of exceptions that occurred for input materials during the operation.",
            "items":{
                "$ref":"#/components/schemas/processWorkOrders-Operation-Material-MaterialExceptionCount-item-patch-request"
            }
        },
        "Quantity":{
            "title":"Required Quantity",
            "type":"number",
            "description":"Quantity of the required material.",
            "nullable":false,
            "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 supply. The default value is true.",
            "nullable":false
        },
        "SupplyLocator":{
            "maxLength":"255",
            "type":"string",
            "description":"Locator in subinventory to use, by default, when the plant draws material during assembly or an operation pull.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SubstituteMaterial":{
            "title":"Substitute Materials",
            "type":"array",
            "description":"The Substitute Materials resource gets the substitute materials that the work order operation uses.",
            "items":{
                "$ref":"#/components/schemas/processWorkOrders-Operation-Material-SubstituteMaterial-item-patch-request"
            }
        },
        "MaterialDFF":{
            "title":"Flexfields for Materials",
            "type":"array",
            "description":"The Flexfields for Materials resource manages descriptive flexfields that contain details about the input materials that the work order operation processes.",
            "items":{
                "$ref":"#/components/schemas/processWorkOrders-Operation-Material-MaterialDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "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.",
            "nullable":false
        },
        "YieldFactor":{
            "title":"Item Yield",
            "type":"number",
            "description":"Factor to use when calculating the quantity that the operation requires to accommodate component waste when it processes the item. It's recommended that you set the yield to between 0 and 1. You can set the yield to a value that's greater than 1. The application considers the yield when it calculates the required quantity according to the Include plant parameter for the component yield.",
            "nullable":false,
            "default":"1"
        },
        "SupplyLocatorId":{
            "title":"Supply Locator",
            "type":"integer",
            "description":"Value that uniquely identifies the locator. It's a primary key that the application generates when it creates the locator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "SupplyLocator"
                ]
            }
        },
        "MaterialAttachment":{
            "title":"Material Attachments",
            "type":"array",
            "description":"The Material Attachments resource manages the attachments for input material.",
            "items":{
                "$ref":"#/components/schemas/processWorkOrders-Operation-Material-MaterialAttachment-item-patch-request"
            }
        },
        "SupplyType":{
            "title":"Supply Type",
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates the supply type used for the work order operation material. A list of accepted values is defined in the lookup types EGP_WIP_SUP_TYPE and ORA_WIE_WO_SUPPLY_TYPE.",
            "nullable":false
        }
    }
}

Nested Schema : Material Attachments

Type: array

Title: Material Attachments

The Material Attachments resource manages the attachments for input material.

Show Source

• Array of: object processWorkOrders-Operation-Material-MaterialAttachment-item-patch-request

{
    "title":"Material Attachments",
    "type":"array",
    "description":"The Material Attachments resource manages the attachments for input material.",
    "items":{
        "$ref":"#/components/schemas/processWorkOrders-Operation-Material-MaterialAttachment-item-patch-request"
    }
}

Nested Schema : Flexfields for Materials

Type: array

Title: Flexfields for Materials

The Flexfields for Materials resource manages descriptive flexfields that contain details about the input materials that the work order operation processes.

Show Source

• Array of: object processWorkOrders-Operation-Material-MaterialDFF-item-patch-request

{
    "title":"Flexfields for Materials",
    "type":"array",
    "description":"The Flexfields for Materials resource manages descriptive flexfields that contain details about the input materials that the work order operation processes.",
    "items":{
        "$ref":"#/components/schemas/processWorkOrders-Operation-Material-MaterialDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : Exception Counts

Type: array

Title: Exception Counts

The Exception Counts resource gets the count of exceptions that occurred for input materials during the operation.

Show Source

• Array of: object processWorkOrders-Operation-Material-MaterialExceptionCount-item-patch-request

{
    "title":"Exception Counts",
    "type":"array",
    "description":"The Exception Counts resource gets the count of exceptions that occurred for input materials during the operation.",
    "items":{
        "$ref":"#/components/schemas/processWorkOrders-Operation-Material-MaterialExceptionCount-item-patch-request"
    }
}

Nested Schema : Substitute Materials

Type: array

Title: Substitute Materials

The Substitute Materials resource gets the substitute materials that the work order operation uses.

Show Source

• Array of: object processWorkOrders-Operation-Material-SubstituteMaterial-item-patch-request

{
    "title":"Substitute Materials",
    "type":"array",
    "description":"The Substitute Materials resource gets the substitute materials that the work order operation uses.",
    "items":{
        "$ref":"#/components/schemas/processWorkOrders-Operation-Material-SubstituteMaterial-item-patch-request"
    }
}

Nested Schema : processWorkOrders-Operation-Material-MaterialAttachment-item-patch-request

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  Name of the category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment is not shared. The default value is false.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Abbreviation that identifies the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Value that uniquely identifies the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  Number that identifies the current version of the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Abbreviation that identifies the error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Text of the error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Date when the contents of the attachment expire.
• FileContents: string (byte)
  Title: File Contents

  Contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  File name of the attachment.
• FileUrl: string
  Title: File Url

  URL (Uniform Resource Locator) of the attachment.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  Length of the attached file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the attached file.
• UploadedText: string
  Title: Uploaded Text

  Text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI (Uniform Resource Identifier) that identifies the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL (Uniform Resource Locator) that locates the attachment.

{
    "type":"object",
    "properties":{
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Text of the error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"URI (Uniform Resource Identifier) that identifies the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"URL (Uniform Resource Locator) that locates the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment is not shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the contents of the attachment expire.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that identifies the error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"Folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Length of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the current version of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : processWorkOrders-Operation-Material-MaterialDFF-item-patch-request

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
• WoOperationMaterialId: integer (int64)
  Value that uniquely identifies the material for the work order operation. It's a primary key that the application generates when it creates the material for the work order operation.

{
    "type":"object",
    "properties":{
        "WoOperationMaterialId":{
            "type":"integer",
            "description":"Value that uniquely identifies the material for the work order operation. It's a primary key that the application generates when it creates the material for the work order operation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "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"
                }
            }
        },
        "__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"
                }
            }
        }
    }
}

Nested Schema : processWorkOrders-Operation-Material-MaterialExceptionCount-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : processWorkOrders-Operation-Material-SubstituteMaterial-item-patch-request

Type: object

Show Source

• InverseQuantity: number
  Title: Inverse

  Inverse of the Quantity Per Product attribute. The application uses the inverse when the Quantity Per Product for the material is a fraction but the inverse of this quantity is an integer. This attribute is associated with a feature that requires opt in.
• Priority: number
  Title: Priority

  Ranking of the substitute component to use instead of the primary component. This attribute is associated with a feature that requires opt in.
• QuantityPERProduct: number
  Title: Quantity per Product

  Quantity required to manufacture each unit of the substitute material. This attribute is associated with a feature that requires opt in.
• RequiredQuantity: number
  Title: Required Quantity

  Required quantity of the substitute material.
• SubstituteFlag: boolean
  Maximum Length: 1

  Mark used indicate whether the component is a substitute or not. This attribute is associated with a feature that requires opt in.
• UOMCode: string
  Title: Primary UOM

  Maximum Length: 3

  Abbreviation that identifies the unit of measure that the substitute material uses. This attribute is associated with a feature that requires opt in.

{
    "type":"object",
    "properties":{
        "SubstituteFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Mark used indicate whether the component is a substitute or not. This attribute is associated with a feature that requires opt in.",
            "nullable":false
        },
        "RequiredQuantity":{
            "title":"Required Quantity",
            "type":"number",
            "description":"Required quantity of the substitute material.",
            "nullable":true
        },
        "QuantityPERProduct":{
            "title":"Quantity per Product",
            "type":"number",
            "description":"Quantity required to manufacture each unit of the substitute material. This attribute is associated with a feature that requires opt in.",
            "nullable":false
        },
        "Priority":{
            "title":"Priority",
            "type":"number",
            "description":"Ranking of the substitute component to use instead of the primary component. This attribute is associated with a feature that requires opt in.",
            "nullable":true
        },
        "InverseQuantity":{
            "title":"Inverse",
            "type":"number",
            "description":"Inverse of the Quantity Per Product attribute. The application uses the inverse when the Quantity Per Product for the material is a fraction but the inverse of this quantity is an integer. This attribute is associated with a feature that requires opt in.",
            "nullable":true
        },
        "UOMCode":{
            "title":"Primary UOM",
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure that the substitute material uses. This attribute is associated with a feature that requires opt in.",
            "nullable":false
        }
    }
}

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 : processWorkOrders-Operation-Material-item-response

Type: object

Show Source

• AllocatedQuantity: number
  Title: Allocated Quantity

  Read Only: true

  Quantity of the material already allocated.
• BasisType: string
  Title: Basis

  Maximum Length: 30

  Value that indicates whether the material quantity is fixed; for example, quantity per lot produced, or variable; for example, quantity per item produced. A list of accepted values is defined in the lookup type EGP_BOM_BASIS_TYPE.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the process work order input.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the work order operation input.
• IncludeInPlanningFlag: boolean
  Title: Include in planning

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then planning considers the material when it plans the supply. If false, then planning does not consider the material when it plans supply. The default value is true.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the item, product, or assembly in the inventory organization.
• IssuedQuantity: number
  Title: Issued Quantity

  Read Only: true

  Default Value: 0

  Net quantity of the material that the application issued for the operation.
• ItemDescription: string
  Title: Item Description

  Read Only: true

  Maximum Length: 240

  Description of the item.
• ItemNumber: string
  Maximum Length: 300

  Number that identifies the item. If the material type is COMPONENT, then ItemNumber references the component to issue to the work order. If the material type is PRIMARY_PRODUCT, then ItemNumber references the assembly that's an output of the work order.
• ItemRevision: string
  Read Only: true

  Maximum Length: 18

  Value that indicates the revision of the item.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the work order operation input.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who updated the process work order input.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaterialAttachment: array Material Attachments
  Title: Material Attachments

  The Material Attachments resource manages the attachments for input material.
• MaterialDFF: array Flexfields for Materials
  Title: Flexfields for Materials

  The Flexfields for Materials resource manages descriptive flexfields that contain details about the input materials that the work order operation processes.
• MaterialExceptionCount: array Exception Counts
  Title: Exception Counts

  The Exception Counts resource gets the count of exceptions that occurred for input materials during the operation.
• MaterialSequenceNumber: number
  Title: Sequence

  Number that indicates the unique sequence of the material assigned to the work order operation.
• MaterialType: string
  Read Only: true

  Maximum Length: 30

  Default Value: COMPONENT

  Type of material either produced or consumed by the operation. For materials being consumed, a list of accepted values is defined in the lookup type ORA_WIS_WD_INPUT_MATERIAL. For materials being produced, a list of accepted values is defined in the lookup type ORA_WIS_WD_OUTPUT_MATERIAL.
• OperationName: string
  Title: Name

  Read Only: true

  Maximum Length: 120

  Name of the operation that processes the material.
• OperationSequenceNumber: number
  Title: Operation Sequence

  Read Only: true

  Number that indicates the sequence to use when performing the work order operations.
• OrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the inventory organization that's enabled for manufacturing. It's a primary key of the inventory organization.
• PickedQuantity: number
  Title: Picked Quantity

  Read Only: true

  Quantity of the material already picked.
• ProducedQuantity: number
  Read Only: true

  Quantity of the assembly that's completed into inventory. The material type for this material is PRIMARY_PRODUCT.
• Quantity: number
  Title: Required Quantity

  Quantity of the required material.
• RemainingAllocatedQuantity: number
  Read Only: true

  Quantity of the material remaining to be allocated.
• RequiredDate: string (date-time)
  Title: Required Date

  Date when the plant requires the materials so that it perform the operation. The required date must not occur before the operation start date, or after the operation completion date.
• ReservedQuantity: number
  Title: Reserved Quantity

  Read Only: true

  Material quantity that's reserved against the work order operation.
• SecondaryQuantity: number
  Read Only: true

  Required material quantity in the secondary unit of measure. This attribute is read-only. This attribute is associated with a feature that requires opt in.
• SecondaryUOMCode: string
  Title: Secondary Unit of Measure

  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the secondary unit of measure of the material. This attribute is read-only. This attribute is associated with a feature that requires opt in.
• StandardOperationCode: string
  Title: Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the standard operation.
• StandardOperationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the standard operation that the work order references. It's a primary key that the application generates when it creates the standard operation.
• SubstituteFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the component is a substitute. This attribute does not have a default value. This attribute is associated with a feature that requires opt in.
• SubstituteMaterial: array Substitute Materials
  Title: Substitute Materials

  The Substitute Materials resource gets the substitute materials that the work order operation uses.
• SupplyLocator: string
  Maximum Length: 255

  Locator in subinventory to use, by default, when the plant draws material during assembly or an operation pull.
• SupplyLocatorId: integer (int64)
  Title: Supply Locator

  Value that uniquely identifies the locator. It's a primary key that the application generates when it creates the locator.
• SupplySubinventory: string
  Title: Supply Subinventory

  Maximum Length: 20

  Subinventory to use, by default, when the plant draws material during assembly or an operation pull.
• SupplyType: string
  Title: Supply Type

  Maximum Length: 30

  Value that indicates the supply type used for the work order operation material. A list of accepted values is defined in the lookup types EGP_WIP_SUP_TYPE and ORA_WIE_WO_SUPPLY_TYPE.
• SupplyTypeDescription: string
  Read Only: true

  Maximum Length: 80

  Description of the supply type.
• UnitOfMeasure: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  Unit of measure for the material quantity and can be the item's primary UOM or a UOM that can be converted. If the item is enabled with primary and secondary tracking unit of measure, the value can be the item's secondary UOM. This enhanced behavior is associated with a feature that requires opt in.
• UOMCode: string
  Title: UOM

  Maximum Length: 3

  Abbreviation that identifies the unit of measure of the material quantity and can be the item's primary UOM code or a UOM code that can be converted. If the item is enabled with primary and secondary tracking unit of measure, the value can be the item's secondary UOM code. This enhanced behavior is associated with a feature that requires opt in.
• WorkAreaId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work area. It's a primary key that the application generates when it creates the work area.
• WorkAreaName: string
  Title: Name

  Read Only: true

  Maximum Length: 80

  Name of the work area.
• WorkCenterId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work center. It's a primary key that the application generates when it creates the work center.
• WorkCenterName: string
  Title: Name

  Read Only: true

  Maximum Length: 120

  Name of the work center.
• WorkOrderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work order. It's a primary key that the application generates when it creates the work order.
• WorkOrderOperationId: integer (int64)
  Value that uniquely identifies the work order operation. It's a primary key that the application generates when it creates the work order operation.
• WorkOrderOperationMaterialId: integer (int64)
  Read Only: true

  Value that uniquely identifies the material for the work order operation. It's a primary key that the application generates when it creates the material for the work order operation.
• YieldFactor: number
  Title: Item Yield

  Default Value: 1

  Factor to use when calculating the quantity that the operation requires to accommodate component waste when it processes the item. It's recommended that you set the yield to between 0 and 1. You can set the yield to a value that's greater than 1. The application considers the yield when it calculates the required quantity according to the Include plant parameter for the component yield.

{
    "type":"object",
    "properties":{
        "WorkOrderOperationMaterialId":{
            "type":"integer",
            "description":"Value that uniquely identifies the material for the work order operation. It's a primary key that the application generates when it creates the material for the work order operation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the work order operation input.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplySubinventory":{
            "title":"Supply Subinventory",
            "maxLength":"20",
            "type":"string",
            "description":"Subinventory to use, by default, when the plant draws material during assembly or an operation pull.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center. It's a primary key that the application generates when it creates the work center.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SubstituteFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the component is a substitute. This attribute does not have a default value. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PickedQuantity":{
            "title":"Picked Quantity",
            "type":"number",
            "description":"Quantity of the material already picked.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StandardOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the standard operation that the work order references. It's a primary key that the application generates when it creates the standard operation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RemainingAllocatedQuantity":{
            "type":"number",
            "description":"Quantity of the material remaining to be allocated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that's enabled for manufacturing. It's a primary key of the inventory organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SupplyLocator":{
            "maxLength":"255",
            "type":"string",
            "description":"Locator in subinventory to use, by default, when the plant draws material during assembly or an operation pull.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SubstituteMaterial":{
            "title":"Substitute Materials",
            "type":"array",
            "description":"The Substitute Materials resource gets the substitute materials that the work order operation uses.",
            "items":{
                "$ref":"#/components/schemas/processWorkOrders-Operation-Material-SubstituteMaterial-item-response"
            }
        },
        "MaterialType":{
            "maxLength":"30",
            "type":"string",
            "description":"Type of material either produced or consumed by the operation. For materials being consumed, a list of accepted values is defined in the lookup type ORA_WIS_WD_INPUT_MATERIAL. For materials being produced, a list of accepted values is defined in the lookup type ORA_WIS_WD_OUTPUT_MATERIAL.",
            "nullable":false,
            "readOnly":true,
            "default":"COMPONENT",
            "x-queryable":true
        },
        "IssuedQuantity":{
            "title":"Issued Quantity",
            "type":"number",
            "description":"Net quantity of the material that the application issued for the operation.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Number that identifies the item. If the material type is COMPONENT, then ItemNumber references the component to issue to the work order. If the material type is PRIMARY_PRODUCT, then ItemNumber references the assembly that's an output of the work order.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "YieldFactor":{
            "title":"Item Yield",
            "type":"number",
            "description":"Factor to use when calculating the quantity that the operation requires to accommodate component waste when it processes the item. It's recommended that you set the yield to between 0 and 1. You can set the yield to a value that's greater than 1. The application considers the yield when it calculates the required quantity according to the Include plant parameter for the component yield.",
            "nullable":false,
            "default":"1",
            "x-queryable":true
        },
        "SupplyLocatorId":{
            "title":"Supply Locator",
            "type":"integer",
            "description":"Value that uniquely identifies the locator. It's a primary key that the application generates when it creates the locator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "SupplyLocator"
                ]
            },
            "x-queryable":true
        },
        "WorkAreaName":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the work area.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "MaterialSequenceNumber":{
            "title":"Sequence",
            "type":"number",
            "description":"Number that indicates the unique sequence of the material assigned to the work order operation.",
            "nullable":false,
            "x-queryable":true
        },
        "SecondaryUOMCode":{
            "title":"Secondary Unit of Measure",
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the secondary unit of measure of the material. This attribute is read-only. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SupplyType":{
            "title":"Supply Type",
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates the supply type used for the work order operation material. A list of accepted values is defined in the lookup types EGP_WIP_SUP_TYPE and ORA_WIE_WO_SUPPLY_TYPE.",
            "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. It's a primary key that the application generates when it creates the work area.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ItemRevision":{
            "maxLength":"18",
            "type":"string",
            "description":"Value that indicates the revision of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure of the material quantity and can be the item's primary UOM code or a UOM code that can be converted. If the item is enabled with primary and secondary tracking unit of measure, the value can be the item's secondary UOM code. This enhanced behavior is associated with a feature that requires opt in.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who updated the process work order input.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order operation. It's a primary key that the application generates when it creates the work order operation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StandardOperationCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the standard operation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the work center.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "RequiredDate":{
            "title":"Required Date",
            "type":"string",
            "description":"Date when the plant requires the materials so that it perform the operation. The required date must not occur before the operation start date, or after the operation completion date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the process work order input.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":"25",
            "type":"string",
            "description":"Unit of measure for the material quantity and can be the item's primary UOM or a UOM that can be converted. If the item is enabled with primary and secondary tracking unit of measure, the value can be the item's secondary UOM. This enhanced behavior is associated with a feature that requires opt in.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"edit"
            }
        },
        "OperationName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the operation that processes the material.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item, product, or assembly in the inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "ItemNumber"
                ]
            },
            "x-queryable":true
        },
        "MaterialExceptionCount":{
            "title":"Exception Counts",
            "type":"array",
            "description":"The Exception Counts resource gets the count of exceptions that occurred for input materials during the operation.",
            "items":{
                "$ref":"#/components/schemas/processWorkOrders-Operation-Material-MaterialExceptionCount-item-response"
            }
        },
        "AllocatedQuantity":{
            "title":"Allocated Quantity",
            "type":"number",
            "description":"Quantity of the material already allocated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReservedQuantity":{
            "title":"Reserved Quantity",
            "type":"number",
            "description":"Material quantity that's reserved against the work order operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Quantity":{
            "title":"Required Quantity",
            "type":"number",
            "description":"Quantity of the required material.",
            "nullable":false,
            "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 supply. The default value is true.",
            "nullable":false,
            "x-queryable":true
        },
        "MaterialDFF":{
            "title":"Flexfields for Materials",
            "type":"array",
            "description":"The Flexfields for Materials resource manages descriptive flexfields that contain details about the input materials that the work order operation processes.",
            "items":{
                "$ref":"#/components/schemas/processWorkOrders-Operation-Material-MaterialDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "SupplyTypeDescription":{
            "maxLength":"80",
            "type":"string",
            "description":"Description of the supply type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ProducedQuantity":{
            "type":"number",
            "description":"Quantity of the assembly that's completed into inventory. The material type for this material is PRIMARY_PRODUCT.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryQuantity":{
            "type":"number",
            "description":"Required material quantity in the secondary unit of measure. This attribute is read-only. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "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.",
            "nullable":false,
            "x-queryable":true
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order. It's a primary key that the application generates when it creates the work order.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MaterialAttachment":{
            "title":"Material Attachments",
            "type":"array",
            "description":"The Material Attachments resource manages the attachments for input material.",
            "items":{
                "$ref":"#/components/schemas/processWorkOrders-Operation-Material-MaterialAttachment-item-response"
            }
        },
        "OperationSequenceNumber":{
            "title":"Operation Sequence",
            "type":"number",
            "description":"Number that indicates the sequence to use when performing the work order operations.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the work order operation input.",
            "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 : Material Attachments

Type: array

Title: Material Attachments

The Material Attachments resource manages the attachments for input material.

Show Source

• Array of: object processWorkOrders-Operation-Material-MaterialAttachment-item-response

{
    "title":"Material Attachments",
    "type":"array",
    "description":"The Material Attachments resource manages the attachments for input material.",
    "items":{
        "$ref":"#/components/schemas/processWorkOrders-Operation-Material-MaterialAttachment-item-response"
    }
}

Nested Schema : Flexfields for Materials

Type: array

Title: Flexfields for Materials

The Flexfields for Materials resource manages descriptive flexfields that contain details about the input materials that the work order operation processes.

Show Source

• Array of: object processWorkOrders-Operation-Material-MaterialDFF-item-response

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

Nested Schema : Exception Counts

Type: array

Title: Exception Counts

The Exception Counts resource gets the count of exceptions that occurred for input materials during the operation.

Show Source

• Array of: object processWorkOrders-Operation-Material-MaterialExceptionCount-item-response

{
    "title":"Exception Counts",
    "type":"array",
    "description":"The Exception Counts resource gets the count of exceptions that occurred for input materials during the operation.",
    "items":{
        "$ref":"#/components/schemas/processWorkOrders-Operation-Material-MaterialExceptionCount-item-response"
    }
}

Nested Schema : Substitute Materials

Type: array

Title: Substitute Materials

The Substitute Materials resource gets the substitute materials that the work order operation uses.

Show Source

• Array of: object processWorkOrders-Operation-Material-SubstituteMaterial-item-response

{
    "title":"Substitute Materials",
    "type":"array",
    "description":"The Substitute Materials resource gets the substitute materials that the work order operation uses.",
    "items":{
        "$ref":"#/components/schemas/processWorkOrders-Operation-Material-SubstituteMaterial-item-response"
    }
}

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 : processWorkOrders-Operation-Material-MaterialAttachment-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  An identifier used for tracking the uploaded files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Value that uniquely identifies the attachment of a work order operation material. It's a primary key that the application generates when a document is attached to the work order operation material.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Name of the category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment is not shared. The default value is false.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  User who created the attachment.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  Login that the user used when creating the attachment.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the user created the attachment record.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Abbreviation that identifies the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Value that uniquely identifies the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  Number that identifies the current version of the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Abbreviation that identifies the error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Text of the error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Date when the contents of the attachment expire.
• FileContents: string (byte)
  Title: File Contents

  Contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  File name of the attachment.
• FileUrl: string
  Title: File Url

  URL (Uniform Resource Locator) of the attachment.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date and time when the user most recently updated the document that's attached to the work order.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  Login of the user who most recently updated the document that's attached to the work order.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  Login that the user used when updating the document that's attached to the work order.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  Length of the attached file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the attached file.
• UploadedText: string
  Title: Uploaded Text

  Text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI (Uniform Resource Identifier) that identifies the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL (Uniform Resource Locator) that locates the attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  Login that the user used when adding or modifying the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the attachment record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"URI (Uniform Resource Identifier) that identifies the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"URL (Uniform Resource Locator) that locates the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Value that uniquely identifies the attachment of a work order operation material. It's a primary key that the application generates when a document is attached to the work order operation material.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"Login that the user used when creating the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Length of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the current version of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"Login of the user who most recently updated the document that's attached to the work order.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Text of the error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"Login that the user used when adding or modifying the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Login that the user used when updating the document that's attached to the work order.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment is not shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the contents of the attachment expire.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that identifies the error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"Folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the document that's attached to the work order.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"An identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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 : processWorkOrders-Operation-Material-MaterialDFF-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
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• WoOperationMaterialId: integer (int64)
  Value that uniquely identifies the material for the work order operation. It's a primary key that the application generates when it creates the material for the work order operation.

{
    "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's 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",
            "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"
    }
}

Nested Schema : processWorkOrders-Operation-Material-MaterialExceptionCount-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• WorkOrderMaterialExceptionCount: integer
  Read Only: true

  Count of all the open exceptions for this work order input item.
• WorkOrderOperationMaterialId: integer (int64)
  Read Only: true

  Value that uniquely identifies the material assigned to the operation of the work order. It's a primary key that the application generates when it creates the item.

{
    "type":"object",
    "properties":{
        "WorkOrderOperationMaterialId":{
            "type":"integer",
            "description":"Value that uniquely identifies the material assigned to the operation of the work order. It's a primary key that the application generates when it creates the item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkOrderMaterialExceptionCount":{
            "type":"integer",
            "description":"Count of all the open exceptions for this work order input item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : processWorkOrders-Operation-Material-SubstituteMaterial-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the substitute material.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the substitute material.
• InventoryItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the item, product, or assembly in the inventory organization. This attribute is associated with a feature that requires opt in.
• InverseQuantity: number
  Title: Inverse

  Inverse of the Quantity Per Product attribute. The application uses the inverse when the Quantity Per Product for the material is a fraction but the inverse of this quantity is an integer. This attribute is associated with a feature that requires opt in.
• ItemNumber: string
  Read Only: true

  Maximum Length: 300

  Number that identifies the item, which is an output of the work order. This attribute is associated with a feature that requires opt in.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the substitute material.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the substitute material.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationCode: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the inventory organization that's enabled for manufacturing. This attribute is associated with a feature that requires opt in.
• OrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the inventory organization that's enabled for manufacturing. It's a primary key of the inventory organization. This attribute is associated with a feature that requires opt in.
• Priority: number
  Title: Priority

  Ranking of the substitute component to use instead of the primary component. This attribute is associated with a feature that requires opt in.
• QuantityPERProduct: number
  Title: Quantity per Product

  Quantity required to manufacture each unit of the substitute material. This attribute is associated with a feature that requires opt in.
• RequiredQuantity: number
  Title: Required Quantity

  Required quantity of the substitute material.
• SubstituteFlag: boolean
  Maximum Length: 1

  Mark used indicate whether the component is a substitute or not. This attribute is associated with a feature that requires opt in.
• UnitOfMeasure: string
  Read Only: true

  Maximum Length: 255

  Primary unit of measure for the substitute material quantity. This attribute is associated with a feature that requires opt in.
• UOMCode: string
  Title: Primary UOM

  Maximum Length: 3

  Abbreviation that identifies the unit of measure that the substitute material uses. This attribute is associated with a feature that requires opt in.
• WorkOrderOperationMaterialId: integer (int64)
  Read Only: true

  Value that uniquely identifies the material for a work order operation. It's a primary key that the application generates when it consumes the material. This attribute is associated with a feature that requires opt in.
• WorkOrderOperationSubstituteMaterialId: integer (int64)
  Value that uniquely identifies the substitute material for a work order operation. It's a primary key that the application generates when it consumes the substitute material. This attribute is associated with a feature that requires opt in.

{
    "type":"object",
    "properties":{
        "WorkOrderOperationMaterialId":{
            "type":"integer",
            "description":"Value that uniquely identifies the material for a work order operation. It's a primary key that the application generates when it consumes the material. This attribute is associated with a feature that requires opt in.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the substitute material.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the substitute material.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the substitute material.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubstituteFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Mark used indicate whether the component is a substitute or not. This attribute is associated with a feature that requires opt in.",
            "nullable":false,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "maxLength":"255",
            "type":"string",
            "description":"Primary unit of measure for the substitute material quantity. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "QuantityPERProduct":{
            "title":"Quantity per Product",
            "type":"number",
            "description":"Quantity required to manufacture each unit of the substitute material. This attribute is associated with a feature that requires opt in.",
            "nullable":false,
            "x-queryable":true
        },
        "Priority":{
            "title":"Priority",
            "type":"number",
            "description":"Ranking of the substitute component to use instead of the primary component. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item, product, or assembly in the inventory organization. This attribute is associated with a feature that requires opt in.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InverseQuantity":{
            "title":"Inverse",
            "type":"number",
            "description":"Inverse of the Quantity Per Product attribute. The application uses the inverse when the Quantity Per Product for the material is a fraction but the inverse of this quantity is an integer. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that's enabled for manufacturing. It's a primary key of the inventory organization. This attribute is associated with a feature that requires opt in.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkOrderOperationSubstituteMaterialId":{
            "type":"integer",
            "description":"Value that uniquely identifies the substitute material for a work order operation. It's a primary key that the application generates when it consumes the substitute material. This attribute is associated with a feature that requires opt in.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Number that identifies the item, which is an output of the work order. This attribute is associated with a feature that requires opt in.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequiredQuantity":{
            "title":"Required Quantity",
            "type":"number",
            "description":"Required quantity of the substitute material.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization that's enabled for manufacturing. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UOMCode":{
            "title":"Primary UOM",
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure that the substitute material uses. This attribute is associated with a feature that requires opt in.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the substitute material.",
            "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"
    }
}

Links

MaterialAttachment

Operation: /fscmRestApi/resources/11.13.18.05/processWorkOrders/{processWorkOrdersUniqID}/child/Operation/{WorkOrderOperationId}/child/Material/{WorkOrderOperationMaterialId}/child/MaterialAttachment

Parameters:

• WorkOrderOperationId: $request.path.WorkOrderOperationId
• WorkOrderOperationMaterialId: $request.path.WorkOrderOperationMaterialId
• processWorkOrdersUniqID: $request.path.processWorkOrdersUniqID

The Material Attachments resource manages the attachments for input material.

MaterialDFF

Operation: /fscmRestApi/resources/11.13.18.05/processWorkOrders/{processWorkOrdersUniqID}/child/Operation/{WorkOrderOperationId}/child/Material/{WorkOrderOperationMaterialId}/child/MaterialDFF

Parameters:

• WorkOrderOperationId: $request.path.WorkOrderOperationId
• WorkOrderOperationMaterialId: $request.path.WorkOrderOperationMaterialId
• processWorkOrdersUniqID: $request.path.processWorkOrdersUniqID

The Flexfields for Materials resource manages descriptive flexfields that contain details about the input materials that the work order operation processes.

MaterialExceptionCount

Operation: /fscmRestApi/resources/11.13.18.05/processWorkOrders/{processWorkOrdersUniqID}/child/Operation/{WorkOrderOperationId}/child/Material/{WorkOrderOperationMaterialId}/child/MaterialExceptionCount

Parameters:

• WorkOrderOperationId: $request.path.WorkOrderOperationId
• WorkOrderOperationMaterialId: $request.path.WorkOrderOperationMaterialId
• processWorkOrdersUniqID: $request.path.processWorkOrdersUniqID

The Exception Counts resource gets the count of exceptions that occurred for input materials during the operation.

SubstituteMaterial

Operation: /fscmRestApi/resources/11.13.18.05/processWorkOrders/{processWorkOrdersUniqID}/child/Operation/{WorkOrderOperationId}/child/Material/{WorkOrderOperationMaterialId}/child/SubstituteMaterial

Parameters:

• WorkOrderOperationId: $request.path.WorkOrderOperationId
• WorkOrderOperationMaterialId: $request.path.WorkOrderOperationMaterialId
• processWorkOrdersUniqID: $request.path.processWorkOrdersUniqID

The Substitute Materials resource gets the substitute materials that the work order operation uses.

replaceWithSubstitute

Operation: /fscmRestApi/resources/11.13.18.05/processWorkOrders/{processWorkOrdersUniqID}/child/Operation/{WorkOrderOperationId}/child/Material/{WorkOrderOperationMaterialId}/action/replaceWithSubstitute

Parameters:

• WorkOrderOperationId: $request.path.WorkOrderOperationId
• WorkOrderOperationMaterialId: $request.path.WorkOrderOperationMaterialId
• processWorkOrdersUniqID: $request.path.processWorkOrdersUniqID

Replaces the operation material with a substitute. To replace the operation material, the client sends the substitute item identifier or substitute item number to uniquely identify the substitute item. The application then replaces the operation material with a substitute item. The replaced item becomes the substitute for the new operation material.

Back to Top