Get one output
get
/fscmRestApi/resources/11.13.18.05/workDefinitions/{WorkDefinitionId}/child/WorkDefinitionOutput/{OutputId}
Request
Path Parameters
-
OutputId(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=
-
WorkDefinitionId(required): integer(int64)
Value that uniquely identifies the work definition. It's a primary key that the application generates when it creates the work definition.
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: 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 : workDefinitions-WorkDefinitionOutput-item-response
Type:
Show Source
object-
BasisType: number
Title:
BasisRead Only:trueIndicates whether the output quantity is fixed or variable. Valid values are contained in the lookup EGP_BOM_BASIS_TYPE. -
BasisTypeMeaning: string
Read Only:
trueMaximum Length:255Meaning for the basis type for the output defined in the work order operation, with valid values available in the lookup EGP_BOM_BASIS_TYPE -
CompletionLocator: string
Read Only:
trueMaximum Length:255Locator into which this output line is produced. -
CompletionSubinventory: string
Title:
Completion SubinventoryRead Only:trueMaximum Length:10Subinventory into which this output line is produced. -
CompletionType: string
Title:
Completion TypeRead Only:trueMaximum Length:30Indicates the completion type code. A list of accepted values is defined in the lookup type ORA_WIS_OUTPUT_COMPL_TYPE. -
CompletionTypeDescription: string
Read Only:
trueMaximum Length:255Description of the completion type code. -
ComponentSequenceId: integer
(int64)
Read Only:
trueReference to the item structure formula output (EGP_COMPONENTS_B) assigned to this operation. -
CostAllocationPercentage: number
Title:
Cost Allocation PercentageRead Only:trueCost percentage share of this output across all outputs. This attribute is null for manually entered costs. -
CostingPriority: number
Title:
Costing PriorityRead Only:truePriority to use when determining which work definition to use when calculating the standard cost by using rolling up costs during costing. Upon exploding the bill of materials, the child work definitions are threaded using the priority number selected at the top. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created this record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the record was created. -
EndDate: string
(date-time)
Title:
End DateRead Only:trueDate when the work definition operation output is disabled. -
FindNumber: number
Title:
Find NumberRead Only:trueUnique identifier of an output that appears more than once in a formula. -
LastUpdateDate: string
(date-time)
Read Only:
trueUser who most recently updated the record. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Date when the record was most recently updated. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OperationName: string
Title:
NameRead Only:trueMaximum Length:120Name of the work definition operation. -
OperationSequenceNumber: number
Title:
SequenceRead Only:trueNumber that indicates the sequence of running the operation. -
Output: string
Read Only:
trueMaximum Length:300Number that identifies the output item of an operation. -
OutputDescription: string
Title:
Item DescriptionRead Only:trueMaximum Length:240Description of the item of the output. -
OutputId: integer
(int64)
Read Only:
trueValue that uniquely identifies the work definition operation output. The application generates this value. -
OutputSequence: number
Title:
SequenceRead Only:trueNumber that indicates the sequence of this output line within this operation. -
OutputType: string
Title:
Output TypeRead Only:trueMaximum Length:30Type of output produced by the operation. A list of accepted values is defined in the lookup type ORA_WIS_WD_OUTPUT_MATERIAL. -
ProductYield: number
Title:
YieldRead Only:trueFactor used to calculate the output quantity produced by the operation. This attribute is currently not in use. -
Quantity: number
Title:
QuantityRead Only:trueQuantity of output expected to be produced by this operation. -
SecondaryQuantity: number
Title:
Secondary QuantityRead Only:trueOutput quantity expected to be produced by this operation in the secondary unit of measure. This attribute is associated with a feature that requires opt-in. -
SecondaryUnitOfMeasure: string
Title:
Secondary UOMRead Only:trueSecondary unit of measure of the output. This attribute is associated with a feature that requires opt-in. -
SecondaryUOMCode: string
Title:
Secondary UOM CodeRead Only:trueAbbreviation that identifies the secondary unit of measure of the output. This attribute is associated with a feature that requires opt-in. -
StandardOperationCode: string
Title:
CodeRead Only:trueMaximum Length:30Abbreviation that identifies the user key to the standard operation. -
StandardOperationId: integer
(int64)
Read Only:
trueValue that uniquely identifies the standard operation. The application generates this value. -
StartDate: string
(date-time)
Title:
Start DateRead Only:trueDate when the work definition operation output is effective. -
UnitOfMeasure: string
Title:
UOM NameRead Only:trueMaximum Length:25Unit of measure of the output. -
UOMCode: string
Title:
UOMRead Only:trueMaximum Length:3Abbreviation that identifies the unit of measure of the output. -
WorkAreaCode: string
Title:
CodeRead Only:trueMaximum Length:30Abbreviation that identifies the work area. This attribute uniquely identifies a work area within a manufacturing plant. -
WorkAreaDescription: string
Title:
DescriptionRead Only:trueMaximum Length:240Description of the work area. -
WorkAreaId: integer
(int64)
Read Only:
trueValue that uniquely identifies the work area. The application generates this value. -
WorkAreaName: string
Title:
NameRead Only:trueMaximum Length:80Name of the work area. -
WorkCenterCode: string
Title:
CodeRead Only:trueMaximum Length:30Abbreviation that identifies the user key to the work center. -
WorkCenterDescription: string
Title:
DescriptionRead Only:trueMaximum Length:240Description of the work center. -
WorkCenterId: integer
(int64)
Read Only:
trueValue that uniquely identifies the work center. The application generates this value. -
WorkCenterName: string
Title:
NameRead Only:trueMaximum Length:120Name of the work center. -
WorkDefinitionId: integer
(int64)
Read Only:
trueValue that uniquely identifies the work definition. This is used to enforce uniqueness of an output item across the work definition operations. -
WorkDefinitionOperationId: integer
(int64)
Read Only:
trueValue that uniquely identifies the operation to which this operation output item is assigned. -
WorkDefinitionOperationOutputAttachment: array
Attachments for Outputs
Title:
Attachments for OutputsThe Attachments for Outputs resource gets the attachments that contain details about the output. -
WorkDefinitionOperationOutputDFF: array
Flexfields for Outputs
Title:
Flexfields for OutputsThe Flexfields for Outputs resource gets the descriptive flexfields that contain details about the output.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Attachments for Outputs
Type:
arrayTitle:
Attachments for OutputsThe Attachments for Outputs resource gets the attachments that contain details about the output.
Show Source
Nested Schema : Flexfields for Outputs
Type:
arrayTitle:
Flexfields for OutputsThe Flexfields for Outputs resource gets the descriptive flexfields that contain details about the output.
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 : workDefinitions-WorkDefinitionOutput-WorkDefinitionOperationOutputAttachment-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdValue that uniquely identifies the attachment of a work definition operation output. It's a primary key that the application generates when a document is attached to the work definition operation output. -
CategoryName: string
Title:
CategoryMaximum Length:30Category 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 in the attachment are no longer available. -
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) that locates 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 is attached to the work definition operation output. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255Login of the user who updated the document that is attached to the work definition operation output. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueLogin that the user used when updating the document that is attached to the work definition. -
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 attachment file. -
UploadedFileName: string
Title:
Uploaded File NameName of the attachment 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 : workDefinitions-WorkDefinitionOutput-WorkDefinitionOperationOutputDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:80Descriptive flexfield context name for work definition operation output. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentDescriptive flexfield context display value for work definition operation output. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
WdOperationOutputId: integer
(int64)
Value that uniquely identifies the work definition operation output. The application generates this value.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- WorkDefinitionOperationOutputAttachment
-
Parameters:
- OutputId2:
$request.path.OutputId2 - WorkDefinitionId:
$request.path.WorkDefinitionId
The Attachments for Outputs resource gets the attachments that contain details about the output. - OutputId2:
- WorkDefinitionOperationOutputDFF
-
Parameters:
- OutputId2:
$request.path.OutputId2 - WorkDefinitionId:
$request.path.WorkDefinitionId
The Flexfields for Outputs resource gets the descriptive flexfields that contain details about the output. - OutputId2:
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/workDefinitions/WorkDefinitionId/child/WorkDefinitionOutput/OutputId"
For example, the following command gets one output:
curl -u username:password "https://servername/fscmRestApi/resources/version/workDefinitions/300100546045347/child/WorkDefinitionOutput/300100546045449"
Example Response Body
The following shows an example of the response body in JSON format.
{
"WorkDefinitionOperationId": 300100546045411,
"WorkDefinitionId": 300100546045347,
"OperationSequenceNumber": 20,
"OperationName": "Packing",
"StandardOperationId": null,
"StandardOperationCode": null,
"WorkAreaId": 300100071642832,
"WorkAreaCode": "MFGASSYWA1",
"WorkAreaName": "MFGASSYWA1",
"WorkAreaDescription": "Assembly Work Area1",
"WorkCenterId": 300100073217939,
"WorkCenterCode": "MFGPACKING1",
"WorkCenterName": "MFGPACKING1",
"WorkCenterDescription": "Work Center for Packing",
"OutputSequence": 20,
"OutputId": 300100546045449,
"Output": "MFG_Oranges",
"OutputDescription": "MFG Oranges",
"OutputType": "PRODUCT",
"PrimaryOutputFlag": false,
"Quantity": 1000,
"UnitOfMeasure": "Each",
"UOMCode": "Ea",
"SecondaryQuantity": null,
"SecondaryUnitOfMeasure": null,
"SecondaryUOMCode": null,
"CompletionType": "MANUAL",
"CompletionTypeDescription": "Manual",
"CompletionSubinventory": "Stores",
"CompletionLocator": null,
"CostAllocationPercentage": 98.5,
"CostingPriority": null,
"CreatedBy": "MFG_QA",
"CreationDate": "2021-02-25T22:41:44.724+00:00",
"LastUpdatedBy": "MFG_QA",
"LastUpdateDate": "2021-02-25T22:47:39.857+00:00",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/workDefinitions/300100546045347/child/WorkDefinitionOutput/300100546045449",
"name": "WorkDefinitionOutput",
"kind": "item"
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/workDefinitions/300100546045347/child/WorkDefinitionOutput/300100546045449",
"name": "WorkDefinitionOutput",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/workDefinitions/300100546045347",
"name": "workDefinitions",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/workDefinitions/300100546045347/child/WorkDefinitionOutput/300100546045449/child/WorkDefinitionOperationOutputAttachment",
"name": "WorkDefinitionOperationOutputAttachment",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/workDefinitions/300100546045347/child/WorkDefinitionOutput/300100546045449/child/WorkDefinitionOperationOutputDFF",
"name": "WorkDefinitionOperationOutputDFF",
"kind": "collection"
}
]
}