1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Manufacturing
  4. Discrete Work Orders
  5. Work Order Operations
  6. Outputs for Operations

Get all outputs

get

/fscmRestApi/resources/11.13.18.05/workOrders/{WorkOrderId}/child/WorkOrderOperation/{WorkOrderOperationId}/child/WorkOrderOperationOutput

Request

Path Parameters
  • Value that uniquely identifies the work order. It is a primary key that the application generates when it creates the work order.
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

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

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • ComplLocatorId; integer; Default completion subinventory locator.
    • ComplSubinventoryCode; string; Default completion subinventory code.
    • CompletedQuantity; number; Quantity completed and moved to inventory.
    • CompletionLocator; string; Default completion subinventory locator.
    • CompletionType; string; Value that indicates the 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.
    • CostAllocationPercentage; number; Percent of cost allocation for the output item. The total cost allocation percentage for all of the output items assigned to an operation cannot exceed 100%.
    • CreatedBy; string; User who created the discrete work order output.
    • CreationDate; string; Date when the user created the work order operation output.
    • InventoryItemId; integer; Value that uniquely identifies the output item.
    • ItemDescription; string; Description of the output item.
    • ItemNumber; string; Number that identifies the item, which is an output of the work order.
    • LastUpdateDate; string; Date when the user most recently updated the work order operation output.
    • LastUpdatedBy; string; User who most recently updated the discrete work order output.
    • OperationDescription; string; Description of the operation.
    • OperationName; string; Name of the operation.
    • OperationSequenceNumber; number; Number that indicates the sequence to use when performing the work order operations.
    • OrganizationId; integer; Value that uniquely identifies the inventory organization that's enabled for manufacturing. It's a primary key of the inventory organization.
    • OutputQuantity; number; Expected output quantity for this operation.
    • OutputSequenceNumber; number; Number that indicates the output item sequence. The expected format for the field is a whole number.
    • OutputType; string; Value that indicates the 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; 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.
    • SecondaryUOMCode; string; 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.
    • UOMCode; string; Abbreviation that identifies the unit of measure of the output. It 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.
    • UnitOfMeasure; string; Unit of measure of the quantity for the output. It 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.
    • WorkAreaCode; string; Abbreviation that identifies the work area.
    • WorkAreaDescription; string; Description of the work area.
    • WorkAreaId; integer; Value that uniquely identifies the work area. It's a primary key that the application generates when it creates the work area.
    • WorkAreaName; string; Name of the work area.
    • WorkCenterCode; string; Abbreviation that identifies the work center.
    • WorkCenterDescription; string; Description of the work center.
    • WorkCenterId; integer; Value that uniquely identifies the work center. It's a primary key that the application generates when it creates the work center.
    • WorkCenterName; string; Name of the work center.
    • WorkOrderOperationId; integer; 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; 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.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : workOrders-WorkOrderOperation-WorkOrderOperationOutput
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : workOrders-WorkOrderOperation-WorkOrderOperationOutput-item-response
Type: object
Show Source
  • Title: Actual Completion Quantity
    Read Only: true
    Quantity completed and moved to inventory.
  • Maximum Length: 255
    Default completion subinventory locator.
  • Title: Completion Type
    Maximum Length: 30
    Default Value: MANUAL
    Value that indicates the 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.
  • Title: Completion Locator
    Default completion subinventory locator.
  • Title: Completion Subinventory
    Maximum Length: 10
    Default completion subinventory code.
  • Title: Basis
    Read Only: true
    Basis of allocating the cost.
  • Title: Percentage
    Percent of cost allocation for the output item. The total cost allocation percentage for all of the output items assigned to an operation cannot exceed 100%.
  • Read Only: true
    Maximum Length: 64
    User who created the discrete work order output.
  • Read Only: true
    Date when the user created the work order operation output.
  • Value that uniquely identifies the output item.
  • Title: Item Description
    Read Only: true
    Maximum Length: 240
    Description of the output item.
  • Maximum Length: 300
    Number that identifies the item, which is an output of the work order.
  • Read Only: true
    Date when the user most recently updated the work order operation output.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the discrete work order output.
  • Links
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the operation.
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name of the operation.
  • Title: Sequence
    Read Only: true
    Number that indicates the sequence to use when performing the work order operations.
  • Read Only: true
    Value that uniquely identifies the inventory organization that's enabled for manufacturing. It's a primary key of the inventory organization.
  • Attachments for Outputs
    Title: Attachments for Outputs
    The Attachments for Outputs resource manages the attachments for an output of a work order operation.
  • Flexfields for Outputs
    Title: Flexfields for Outputs
    The Flexfields for Outputs resource manages descriptive flexfields that contain details about the output materials that the work order operation processes.
  • Output Lot Numbers
    Title: Output Lot Numbers
    The Output Lot Numbers resource manages the lot numbers for an output of a work order operation.
  • Title: Quantity
    Expected output quantity for this operation.
  • Title: Sequence
    Number that indicates the output item sequence. The expected format for the field is a whole number.
  • Title: Output Type
    Maximum Length: 30
    Default Value: PRODUCT
    Value that indicates the 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.
  • 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.
  • 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.
  • 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.
  • Title: UOM Name
    Read Only: true
    Maximum Length: 25
    Unit of measure of the quantity for the output. It 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.
  • Title: UOM
    Maximum Length: 3
    Abbreviation that identifies the unit of measure of the output. It 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.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the work area.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the work area.
  • 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.
  • Title: Name
    Read Only: true
    Maximum Length: 80
    Name of the work area.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the work center.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the work center.
  • 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.
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name of the work center.
  • Value that uniquely identifies the work order operation. It's a primary key that the application generates when it creates the work order operation.
  • 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.
Nested Schema : Attachments for Outputs
Type: array
Title: Attachments for Outputs
The Attachments for Outputs resource manages the attachments for an output of a work order operation.
Show Source
Nested Schema : Flexfields for Outputs
Type: array
Title: Flexfields for Outputs
The Flexfields for Outputs resource manages descriptive flexfields that contain details about the output materials that the work order operation processes.
Show Source
Nested Schema : Output Lot Numbers
Type: array
Title: Output Lot Numbers
The Output Lot Numbers resource manages the lot numbers for an output of a work order operation.
Show Source
Nested Schema : workOrders-WorkOrderOperation-WorkOrderOperationOutput-OutputAttachment-item-response
Type: object
Show Source
Nested Schema : workOrders-WorkOrderOperation-WorkOrderOperationOutput-OutputDFF-item-response
Type: object
Show Source
Nested Schema : workOrders-WorkOrderOperation-WorkOrderOperationOutput-OutputLotNumber-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all outputs.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/workOrders/WorkOrderId/child/WorkOrderOperation/WorkOrderOperationId/child/WorkOrderOperationOutput"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/workOrders/1042/child/WorkOrderOperation/1062/child/WorkOrderOperationOutput"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "items": [
        {
            "OrganizationId": 207,
            "WorkOrderOperationId": 1062,
            "OperationSequenceNumber": 10,
            "OperationName": "OP10",
            "OperationDescription": null,
            "WorkAreaId": 300100071643112,
            "WorkAreaName": "DOSWA-M1",
            "WorkAreaCode": "DOSWA-M1",
            "WorkAreaDescription": "Work Area for SCO BATs M1",
            "WorkCenterId": 300100071643140,
            "WorkCenterCode": "DOSWC-M1",
            "WorkCenterName": "DOSWC-M1",
            "WorkCenterDescription": "Work Centre for SCO BATs M1",
            "OutputSequenceNumber": 10,
            "WorkOrderOperationOutputId": 17004,
            "InventoryItemId": 300100036689383,
            "ItemNumber": "MFG-SER-PROD1",
            "ItemDescription": "Predefined serial Product with Supply Type of Push",
            "OutputType": "BY_PRODUCT",
            "PrimaryFlag": false,
            "OutputQuantity": 0,
            "CompletedQuantity": 1,
            "UOMCode": "Ea",
            "UnitOfMeasure": "Each",
            "CompletionType": "MANUAL",
            "ComplSubinventoryCode": "ABCSUB01",
            "ComplLocatorId": 3134,
            "CompletionLocator": "ABC1.1.1",
            "CostAllocationBasis": "FIXED",
            "CostAllocationPercentage": null,
            "CreatedBy": "MFG_QA",
            "CreationDate": "2024-01-29T17:54:32.451+00:00",
            "LastUpdateDate": "2024-01-29T17:54:32.451+00:00",
            "LastUpdatedBy": "MFG_QA",
            "SecondaryQuantity": null,
            "SecondaryUOMCode": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/workOrders/1042/child/WorkOrderOperation/1062/child/WorkOrderOperationOutput/17004",
                    "name": "WorkOrderOperationOutput",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/workOrders/1042/child/WorkOrderOperation/1062/child/WorkOrderOperationOutput/17004",
                    "name": "WorkOrderOperationOutput",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/workOrders/1042/child/WorkOrderOperation/1062",
                    "name": "WorkOrderOperation",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/workOrders/1042/child/WorkOrderOperation/1062/child/WorkOrderOperationOutput/17004/child/OutputAttachment",
                    "name": "OutputAttachment",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/workOrders/1042/child/WorkOrderOperation/1062/child/WorkOrderOperationOutput/17004/child/OutputDFF",
                    "name": "OutputDFF",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/workOrders/1042/child/WorkOrderOperation/1062/child/WorkOrderOperationOutput",
            "name": "WorkOrderOperationOutput",
            "kind": "collection"
        }
    ]
}
Back to Top