Get all outputs
get
/fscmRestApi/resources/11.13.18.05/processWorkOrders/{processWorkOrdersUniqID}/child/ProcessWorkOrderOutput
Request
Path Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds output of a work order operation.
Finder Variables:- WorkOrderOperationOutputId; integer; Value that uniquely identifies an output for a work order operation. It's a primary key that the application generates when it creates the output for a work order operation.
- PrimaryKey: Finds output of a work order operation.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- BasisType; string; Indicates if the output quantity is fixed or variable. Valid values are found in the lookup with lookup type = EGP_BOM_BASIS_TYPE.
- BasisTypeMeaning; string; Meaning of the Basis Type of the work order operation output. Valid values exist in the lookup with lookup type = EGP_BOM_BASIS_TYPE.
- 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; 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 the output items assigned to an operation cannot exceed 100%.
- CreatedBy; string; User who created the process 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 updated the process 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 sequence of the output item. The expected format for the attribute is a whole number.
- OutputType; string; 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.
- ProductYield; number; Factor used to calculate the output quantity produced by the operation. This attribute isn't currently used.
- 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 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.
- UnitOfMeasure; string; 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.
- 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.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context: string
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: string
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 : processWorkOrders-ProcessWorkOrderOutput
Type:
Show Source
object-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : processWorkOrders-ProcessWorkOrderOutput-item-response
Type:
Show Source
object-
BasisType: string
Title:
BasisMaximum Length:30Indicates if the output quantity is fixed or variable. Valid values are found in the lookup with lookup type = EGP_BOM_BASIS_TYPE. -
BasisTypeMeaning: string
Title:
BasisRead Only:trueMaximum Length:255Meaning of the Basis Type of the work order operation output. Valid values exist in the lookup with lookup type = EGP_BOM_BASIS_TYPE. -
CompletedQuantity: number
Title:
Actual Completion QuantityRead Only:trueQuantity completed and moved to inventory. -
CompletionLocator: string
Maximum Length:
255Default completion subinventory locator. -
CompletionType: string
Title:
Completion TypeMaximum Length:30Default Value:MANUALType 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 LocatorDefault completion subinventory locator. -
ComplSubinventoryCode: string
Title:
Completion SubinventoryMaximum Length:10Default completion subinventory code. -
CostAllocationBasis: string
Title:
BasisRead Only:trueBasis of allocating the cost. -
CostAllocationPercentage: number
Title:
PercentagePercent 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:
trueMaximum Length:64User who created the process work order output. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the work order operation output. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the output item.
-
ItemDescription: string
Title:
Item DescriptionRead Only:trueMaximum Length:240Description of the output item. -
ItemNumber: string
Maximum Length:
300Number that identifies the item, which is an output of the work order. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the work order operation output. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who updated the process work order output. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OperationDescription: string
Title:
DescriptionRead Only:trueMaximum Length:240Description of the operation. -
OperationName: string
Title:
NameRead Only:trueMaximum Length:120Name of the operation. -
OperationSequenceNumber: number
Title:
SequenceRead Only:trueNumber that indicates the sequence to use when performing the work order operations. -
OrganizationId: integer
(int64)
Read Only:
trueValue 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 AttachmentsThe Output Attachments resource manages the attachments for an output of a work order operation. -
OutputDFF: array
Flexfields for Operation Outputs
Title:
Flexfields for Operation OutputsThe Flexfields for Operation Outputs resource manages descriptive flexfields that contain details about the output materials that the work order operation processes. -
OutputQuantity: number
Title:
QuantityExpected output quantity for this operation. -
OutputSequenceNumber: number
Title:
SequenceNumber that indicates the sequence of the output item. The expected format for the attribute is a whole number. -
OutputType: string
Title:
Output TypeMaximum Length:30Default Value:PRODUCTType 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 OutputRead Only:trueMaximum Length:1Default Value:falseContains 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. -
ProductYield: number
Title:
Product YieldFactor used to calculate the output quantity produced by the operation. This attribute isn't currently used. -
SecondaryQuantity: number
Read Only:
trueExpected 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 MeasureRead Only:trueMaximum Length:3Abbreviation 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 NameRead Only:trueMaximum Length:25Unit 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:
UOMMaximum Length:3Abbreviation 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:
CodeRead Only:trueMaximum Length:30Abbreviation that identifies the work area. -
WorkAreaDescription: string
Title:
DescriptionRead Only:trueMaximum Length:240Description of the work area. -
WorkAreaId: integer
(int64)
Read Only:
trueValue that uniquely identifies the work area. It's a primary key that the application generates when it creates the work area. -
WorkAreaName: string
Title:
NameRead Only:trueMaximum Length:80Name of the work area. -
WorkCenterCode: string
Title:
CodeRead Only:trueMaximum Length:30Abbreviation that identifies the work center. -
WorkCenterDescription: string
Title:
DescriptionRead Only:trueMaximum Length:240Description of the work center. -
WorkCenterId: integer
(int64)
Title:
Work CenterRead Only:trueValue that uniquely identifies the work center. It's a primary key that the application generates when it creates the work center. -
WorkCenterName: string
Title:
NameRead Only:trueMaximum Length:120Name 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:
trueValue 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Output Attachments
Type:
arrayTitle:
Output AttachmentsThe Output Attachments resource manages the attachments for an output of a work order operation.
Show Source
Nested Schema : Flexfields for Operation Outputs
Type:
arrayTitle:
Flexfields for Operation OutputsThe Flexfields for Operation 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 referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 : processWorkOrders-ProcessWorkOrderOutput-OutputAttachment-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAn identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdValue 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:
CategoryMaximum Length:30Name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who created the attachment. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueLogin that the user used when creating the attachment. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the user created the attachment record. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAbbreviation that identifies the data type. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment. -
DmDocumentId: string
Maximum Length:
255Value that uniquely identifies the attachment. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255Number that identifies the current version of the attachment. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeAbbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageText of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateDate when the contents of the attachment expire. -
FileContents: string
(byte)
Title:
File ContentsContents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048File name of the attachment. -
FileUrl: string
Title:
File UrlURL (Uniform Resource Locator) of the attachment. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate and time when the user most recently updated the document that's attached to the work order. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255Login of the user who most recently updated the document that's attached to the work order. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueLogin that the user used when updating the document that's attached to the work order. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the attachment. -
UploadedFileLength: integer
Title:
File SizeLength of the attached file. -
UploadedFileName: string
Title:
Uploaded File NameName of the attached file. -
UploadedText: string
Title:
Uploaded TextText of the attachment. -
Uri: string
Title:
UriMaximum Length:4000URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
UrlMaximum Length:4000URL (Uniform Resource Locator) that locates the attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255Login that the user used when adding or modifying the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : processWorkOrders-ProcessWorkOrderOutput-OutputDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:80Descriptive flexfield context name for work order operation outputs. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentDescriptive flexfield context display value for work order operation outputs. -
links: array
Links
Title:
LinksThe 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source