Get one output
get
/fscmRestApi/resources/11.13.18.05/workOrders/{WorkOrderId}/child/WorkOrderOperation/{WorkOrderOperationId}/child/WorkOrderOperationOutput/{WorkOrderOperationOutputId}
Request
Path Parameters
-
WorkOrderId(required): integer(int64)
Value that uniquely identifies the work order. It is a primary key that the application generates when it creates the work order.
-
WorkOrderOperationId(required): integer(int64)
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=
-
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.
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 TopResponse
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.
Root Schema : workOrders-WorkOrderOperation-WorkOrderOperationOutput-item-response
Type:
Show Source
object
-
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
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. -
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 of the output items assigned to an operation cannot exceed 100%. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the discrete 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 most recently updated the discrete 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
Attachments for Outputs
Title:
Attachments for Outputs
The Attachments for Outputs resource manages the attachments for an output of a work order operation. -
OutputDFF: array
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. -
OutputQuantity: number
Title:
Quantity
Expected output quantity for this operation. -
OutputSequenceNumber: number
Title:
Sequence
Number that indicates the output item sequence. The expected format for the field is a whole number. -
OutputType: string
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. -
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 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. -
UOMCode: string
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. -
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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 : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : workOrders-WorkOrderOperation-WorkOrderOperationOutput-OutputAttachment-item-response
Type:
Show Source
object
-
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 material attachment of a work order operation. It is 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
Category of the attachment. - ContentRepositoryFileShared: boolean
-
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 application 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 to 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 in the attachment expires. -
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) that locates 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 material. -
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 material for the work order operation. -
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 operation material. -
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 attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attachment 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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workOrders-WorkOrderOperation-WorkOrderOperationOutput-OutputDFF-item-response
Type:
Show Source
object
-
__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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- OutputAttachment
-
Parameters:
- WorkOrderId:
$request.path.WorkOrderId
- WorkOrderOperationId2:
$request.path.WorkOrderOperationId2
- WorkOrderOperationOutputId:
$request.path.WorkOrderOperationOutputId
The Attachments for Outputs resource manages the attachments for an output of a work order operation. - WorkOrderId:
- OutputDFF
-
Parameters:
- WorkOrderId:
$request.path.WorkOrderId
- WorkOrderOperationId2:
$request.path.WorkOrderOperationId2
- WorkOrderOperationOutputId:
$request.path.WorkOrderOperationOutputId
The Flexfields for Outputs resource manages descriptive flexfields that contain details about the output materials that the work order operation processes. - WorkOrderId:
Examples
This example describes how to get one output.
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/WorkOrderOperationOutputId"
For example:
curl -u username:password "https://servername/fscmRestApi/resources/version/workOrders/1042/child/WorkOrderOperation/1062/child/WorkOrderOperationOutput/17004"
Example Response Body
The following example includes the contents of the response body
in JSON format:
{ "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" } ] }