Jump to

• Request
• Response

Get one output

get

/fscmRestApi/resources/11.13.18.05/processWorkOrders/{processWorkOrdersUniqID}/child/Operation/{OperationUniqID}/child/Output/{WorkOrderOperationOutputId}

Request

Path Parameters

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

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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-Output-item-response

Type: object

Show Source

• CompletedQuantity: number
  Title: Actual Completion Quantity

  Read Only: true

  Quantity completed and moved to inventory.
• CompletionLocator: string
  Maximum Length: 255

  Default completion subinventory locator.
• CompletionType: string
  Title: Completion Type

  Maximum Length: 30

  Default Value: MANUAL

  Type of output completion. Valid values are AUTOMATIC and MANUAL. A list of accepted values is defined in the lookup type ORA_WIS_OUTPUT_COMPL_TYPE.
• ComplLocatorId: integer (int64)
  Title: Completion Locator

  Default completion subinventory locator.
• ComplSubinventoryCode: string
  Title: Completion Subinventory

  Maximum Length: 10

  Default completion subinventory code.
• CostAllocationBasis: string
  Title: Basis

  Read Only: true

  Basis of allocating the cost.
• CostAllocationPercentage: number
  Title: Percentage

  Percent of cost allocation for the output item. The total cost allocation percentage for all the output items assigned to an operation cannot exceed 100%.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date when the user created the work order operation output.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the output item.
• ItemDescription: string
  Title: Item Description

  Read Only: true

  Maximum Length: 240

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

  Number that identifies the item, which is an output of the work order.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

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

  Read Only: true

  Maximum Length: 240

  Description of the operation.
• OperationName: string
  Title: Name

  Read Only: true

  Maximum Length: 120

  Name of the operation.
• OperationSequenceNumber: number
  Title: 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.
• OutputAttachment: array Output Attachments
  Title: Output Attachments

  The Output Attachments resource manages the attachments for an output of a work order operation.
• OutputDFF: array Flexfields for Operation Outputs
  Title: Flexfields for Operation Outputs

  The Flexfields for Operation Outputs resource manages descriptive flexfields that contain details about the output materials that the work order operation processes.
• OutputLotNumber: array Output Lot Numbers
  Title: Output Lot Numbers

  The Output Lot Numbers resource manages the product lots for an output of a work order operation. A product is any type of production output, whether it's the primary product, co-product, or by-product in a process manufacturing work order. This resource is associated with a feature that requires opt in.
• OutputQuantity: number
  Title: Quantity

  Expected output quantity for this operation.
• OutputSequenceNumber: number
  Title: Sequence

  Number that indicates the sequence of the output item. The expected format for the attribute is a whole number.
• OutputType: string
  Title: Output Type

  Maximum Length: 30

  Default Value: PRODUCT

  Type of output item. Valid values are PRODUCT or BY-PRODUCT. A list of accepted values is defined in the lookup type ORA_WIS_WD_OUTPUT_MATERIAL.
• PrimaryFlag: boolean
  Title: Primary Output

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then the output item is a primary output item. If false, then the output item is not a primary output item. The default value is false.
• SecondaryQuantity: number
  Read Only: true

  Expected output quantity for this operation 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 output. This attribute is read-only. This attribute is associated with a feature that requires opt in.
• UnitOfMeasure: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  Unit of measure that the quantity uses for the output 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 output 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.
• WorkAreaCode: string
  Title: Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the work area.
• WorkAreaDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Description of the work area.
• 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.
• WorkCenterCode: string
  Title: Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the work center.
• WorkCenterDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Description of the work center.
• WorkCenterId: integer (int64)
  Title: Work Center

  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: 80

  Name of the work center.
• 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.
• WorkOrderOperationOutputId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work order operation output. It's a primary key that the application generates when it creates the work order operation output.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the work order operation output.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterId":{
            "title":"Work Center",
            "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
        },
        "WorkCenterDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the work center.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary Output",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the output item is a primary output item. If false, then the output item is not a primary output item. The default value is false.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "CompletedQuantity":{
            "title":"Actual Completion Quantity",
            "type":"number",
            "description":"Quantity completed and moved to inventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CompletionType":{
            "title":"Completion Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of output completion. Valid values are AUTOMATIC and MANUAL. A list of accepted values is defined in the lookup type ORA_WIS_OUTPUT_COMPL_TYPE.",
            "nullable":false,
            "default":"MANUAL",
            "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
        },
        "CostAllocationPercentage":{
            "title":"Percentage",
            "type":"number",
            "description":"Percent of cost allocation for the output item. The total cost allocation percentage for all the output items assigned to an operation cannot exceed 100%.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the output item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OutputSequenceNumber":{
            "title":"Sequence",
            "type":"number",
            "description":"Number that indicates the sequence of the output item. The expected format for the attribute is a whole number.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that identifies the item, which is an output of the work order.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "WorkAreaName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the work area.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ComplLocatorId":{
            "title":"Completion Locator",
            "type":"integer",
            "description":"Default completion subinventory locator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "CompletionLocator"
                ]
            },
            "x-queryable":true
        },
        "SecondaryUOMCode":{
            "title":"Secondary Unit of Measure",
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the secondary unit of measure of the output. This attribute is read-only. This attribute is associated with a feature that requires opt in.",
            "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"
            }
        },
        "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
        },
        "OutputAttachment":{
            "title":"Output Attachments",
            "type":"array",
            "description":"The Output Attachments resource manages the attachments for an output of a work order operation.",
            "items":{
                "$ref":"#/components/schemas/processWorkOrders-Operation-Output-OutputAttachment-item-response"
            }
        },
        "OutputDFF":{
            "title":"Flexfields for Operation Outputs",
            "type":"array",
            "description":"The Flexfields for Operation Outputs resource manages descriptive flexfields that contain details about the output materials that the work order operation processes.",
            "items":{
                "$ref":"#/components/schemas/processWorkOrders-Operation-Output-OutputDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "WorkCenterCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the work center.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure of the output 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
        },
        "CostAllocationBasis":{
            "title":"Basis",
            "type":"string",
            "description":"Basis of allocating the cost.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OutputType":{
            "title":"Output Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of output item. Valid values are PRODUCT or BY-PRODUCT. A list of accepted values is defined in the lookup type ORA_WIS_WD_OUTPUT_MATERIAL.",
            "nullable":false,
            "default":"PRODUCT",
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who updated the process work order output.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkAreaDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the work area.",
            "nullable":true,
            "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":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkCenterName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the work center.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CompletionLocator":{
            "maxLength":255,
            "type":"string",
            "description":"Default completion subinventory locator.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OutputLotNumber":{
            "title":"Output Lot Numbers",
            "type":"array",
            "description":"The Output Lot Numbers resource manages the product lots for an output of a work order operation. A product is any type of production output, whether it's the primary product, co-product, or by-product in a process manufacturing work order. This resource is associated with a feature that requires opt in.",
            "items":{
                "$ref":"#/components/schemas/processWorkOrders-Operation-Output-OutputLotNumber-item-response"
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the process work order output.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure that the quantity uses for the output 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-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "ComplSubinventoryCode":{
            "title":"Completion Subinventory",
            "maxLength":10,
            "type":"string",
            "description":"Default completion subinventory code.",
            "nullable":true,
            "x-queryable":true
        },
        "OperationName":{
            "title":"Name",
            "maxLength":120,
            "type":"string",
            "description":"Name of the operation.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the output item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ItemNumber"
                ]
            },
            "x-queryable":true
        },
        "WorkOrderOperationOutputId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order operation output. It's a primary key that the application generates when it creates the work order operation output.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "OperationDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the operation.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "WorkAreaCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the work area.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryQuantity":{
            "type":"number",
            "description":"Expected output quantity for this operation 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
        },
        "OperationSequenceNumber":{
            "title":"Sequence",
            "type":"number",
            "description":"Number that indicates the sequence to use when performing the work order operations.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OutputQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Expected output quantity for this operation.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the work order operation output.",
            "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 : Output Attachments

Type: array

Title: Output Attachments

The Output Attachments resource manages the attachments for an output of a work order operation.

Show Source

• Array of: object processWorkOrders-Operation-Output-OutputAttachment-item-response

{
    "title":"Output Attachments",
    "type":"array",
    "description":"The Output Attachments resource manages the attachments for an output of a work order operation.",
    "items":{
        "$ref":"#/components/schemas/processWorkOrders-Operation-Output-OutputAttachment-item-response"
    }
}

Nested Schema : Flexfields for Operation Outputs

Type: array

Title: Flexfields for Operation Outputs

The Flexfields for Operation Outputs resource manages descriptive flexfields that contain details about the output materials that the work order operation processes.

Show Source

• Array of: object processWorkOrders-Operation-Output-OutputDFF-item-response

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

Nested Schema : Output Lot Numbers

Type: array

Title: Output Lot Numbers

The Output Lot Numbers resource manages the product lots for an output of a work order operation. A product is any type of production output, whether it's the primary product, co-product, or by-product in a process manufacturing work order. This resource is associated with a feature that requires opt in.

Show Source

• Array of: object processWorkOrders-Operation-Output-OutputLotNumber-item-response

{
    "title":"Output Lot Numbers",
    "type":"array",
    "description":"The Output Lot Numbers resource manages the product lots for an output of a work order operation. A product is any type of production output, whether it's the primary product, co-product, or by-product in a process manufacturing work order. This resource is associated with a feature that requires opt in.",
    "items":{
        "$ref":"#/components/schemas/processWorkOrders-Operation-Output-OutputLotNumber-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-Output-OutputAttachment-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.
• 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
        },
        "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-Output-OutputDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 80

  Descriptive flexfield context name for work order operation outputs.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Descriptive flexfield context display value for work order operation outputs.
• links: array Links
  Title: Links

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

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Descriptive flexfield context display value for work order operation outputs.",
            "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
        },
        "WoOperationOutputId":{
            "type":"integer",
            "description":"Value that uniquely identifies an output of a work order operation. It's a primary key that the application generates when it creates the work order operation output.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":80,
            "type":"string",
            "description":"Descriptive flexfield context name for work order operation outputs.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":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-Output-OutputLotNumber-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the lot association with the operation output. This attribute is associated with a feature that requires opt in.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the lot association with the operation output. This attribute is associated with a feature that requires opt in.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the lot association with the operation output. This attribute is associated with a feature that requires opt in.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the lot association with the operation output. This attribute is associated with a feature that requires opt in.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LotExpirationDate: string (date)
  Title: Lot Expiration Date

  Date and time when the output lot expires. This attribute is associated with a feature that requires opt in.
• LotNumber: string
  Title: Lot Number

  Maximum Length: 80

  Number that identifies the lot used for the operation output. This attribute is associated with a feature that requires opt in.
• ParentLotNumber: string
  Title: Parent Lot Number

  Number that identifies the parent lot of the lot number used for the operation output. This attribute is applicable if the output is lot controlled. This attribute is associated with a feature that requires opt in.
• WorkOrderProductLotId: integer (int64)
  Read Only: true

  Value that uniquely identifies the output lot for the operation output. It's a primary key that the application generates when it creates the lot association for the work order operation output. This attribute is associated with a feature that requires opt in.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the lot association with the operation output. This attribute is associated with a feature that requires opt in.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the lot association with the operation output. This attribute is associated with a feature that requires opt in.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the lot association with the operation output. This attribute is associated with a feature that requires opt in.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ParentLotNumber":{
            "title":"Parent Lot Number",
            "type":"string",
            "description":"Number that identifies the parent lot of the lot number used for the operation output. This attribute is applicable if the output is lot controlled. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WorkOrderProductLotId":{
            "type":"integer",
            "description":"Value that uniquely identifies the output lot for the operation output. It's a primary key that the application generates when it creates the lot association for the work order operation output. This attribute is associated with a feature that requires opt in.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LotExpirationDate":{
            "title":"Lot Expiration Date",
            "type":"string",
            "description":"Date and time when the output lot expires. This attribute is associated with a feature that requires opt in.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LotNumber":{
            "title":"Lot Number",
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the lot used for the operation output. This attribute is associated with a feature that requires opt in.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the lot association with the operation output. This attribute is associated with a feature that requires opt in.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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

OutputAttachment

Operation: /fscmRestApi/resources/11.13.18.05/processWorkOrders/{processWorkOrdersUniqID}/child/Operation/{OperationUniqID}/child/Output/{WorkOrderOperationOutputId}/child/OutputAttachment

Parameters:

• OperationUniqID: $request.path.OperationUniqID
• WorkOrderOperationOutputId: $request.path.WorkOrderOperationOutputId
• processWorkOrdersUniqID: $request.path.processWorkOrdersUniqID

The Output Attachments resource manages the attachments for an output of a work order operation.

OutputDFF

Operation: /fscmRestApi/resources/11.13.18.05/processWorkOrders/{processWorkOrdersUniqID}/child/Operation/{OperationUniqID}/child/Output/{WorkOrderOperationOutputId}/child/OutputDFF

Parameters:

• OperationUniqID: $request.path.OperationUniqID
• WorkOrderOperationOutputId: $request.path.WorkOrderOperationOutputId
• processWorkOrdersUniqID: $request.path.processWorkOrdersUniqID

The Flexfields for Operation Outputs resource manages descriptive flexfields that contain details about the output materials that the work order operation processes.

OutputLotNumber

Operation: /fscmRestApi/resources/11.13.18.05/processWorkOrders/{processWorkOrdersUniqID}/child/Operation/{OperationUniqID}/child/Output/{WorkOrderOperationOutputId}/child/OutputLotNumber

Parameters:

• OperationUniqID: $request.path.OperationUniqID
• WorkOrderOperationOutputId: $request.path.WorkOrderOperationOutputId
• processWorkOrdersUniqID: $request.path.processWorkOrdersUniqID

The Output Lot Numbers resource manages the product lots for an output of a work order operation. A product is any type of production output, whether it's the primary product, co-product, or by-product in a process manufacturing work order. This resource is associated with a feature that requires opt in.

Back to Top