Jump to

• Request
• Response
• Examples

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 Top

Response

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.

Body ()

Root Schema : workDefinitions-WorkDefinitionOutput-item-response

Type: object

Show Source

• BasisType: number
  Title: Basis

  Read Only: true

  Indicates whether the output quantity is fixed or variable. Valid values are contained in the lookup EGP_BOM_BASIS_TYPE.
• BasisTypeMeaning: string
  Read Only: true

  Maximum Length: 255

  Meaning 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: true

  Maximum Length: 255

  Locator into which this output line is produced.
• CompletionSubinventory: string
  Title: Completion Subinventory

  Read Only: true

  Maximum Length: 10

  Subinventory into which this output line is produced.
• CompletionType: string
  Title: Completion Type

  Read Only: true

  Maximum Length: 30

  Indicates the completion type code. A list of accepted values is defined in the lookup type ORA_WIS_OUTPUT_COMPL_TYPE.
• CompletionTypeDescription: string
  Read Only: true

  Maximum Length: 255

  Description of the completion type code.
• ComponentSequenceId: integer (int64)
  Read Only: true

  Reference to the item structure formula output (EGP_COMPONENTS_B) assigned to this operation.
• CostAllocationPercentage: number
  Title: Cost Allocation Percentage

  Read Only: true

  Cost percentage share of this output across all outputs. This attribute is null for manually entered costs.
• CostingPriority: number
  Title: Costing Priority

  Read Only: true

  Priority 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: true

  Maximum Length: 64

  User who created this record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the record was created.
• EndDate: string (date-time)
  Title: End Date

  Read Only: true

  Date when the work definition operation output is disabled.
• FindNumber: number
  Title: Find Number

  Read Only: true

  Unique identifier of an output that appears more than once in a formula.
• LastUpdateDate: string (date-time)
  Read Only: true

  User who most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Date when the record was most recently updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OperationName: string
  Title: Name

  Read Only: true

  Maximum Length: 120

  Name of the work definition operation.
• OperationSequenceNumber: number
  Title: Sequence

  Read Only: true

  Number that indicates the sequence of running the operation.
• Output: string
  Read Only: true

  Maximum Length: 300

  Number that identifies the output item of an operation.
• OutputDescription: string
  Title: Item Description

  Read Only: true

  Maximum Length: 240

  Description of the item of the output.
• OutputId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work definition operation output. The application generates this value.
• OutputSequence: number
  Title: Sequence

  Read Only: true

  Number that indicates the sequence of this output line within this operation.
• OutputType: string
  Title: Output Type

  Read Only: true

  Maximum Length: 30

  Type 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: Yield

  Read Only: true

  Factor used to calculate the output quantity produced by the operation. This attribute is currently not in use.
• Quantity: number
  Title: Quantity

  Read Only: true

  Quantity of output expected to be produced by this operation.
• SecondaryQuantity: number
  Title: Secondary Quantity

  Read Only: true

  Output 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 UOM

  Read Only: true

  Secondary unit of measure of the output. This attribute is associated with a feature that requires opt-in.
• SecondaryUOMCode: string
  Title: Secondary UOM Code

  Read Only: true

  Abbreviation that identifies the secondary unit of measure of the output. This attribute is associated with a feature that requires opt-in.
• StandardOperationCode: string
  Title: Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the user key to the standard operation.
• StandardOperationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the standard operation. The application generates this value.
• StartDate: string (date-time)
  Title: Start Date

  Read Only: true

  Date when the work definition operation output is effective.
• UnitOfMeasure: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  Unit of measure of the output.
• UOMCode: string
  Title: UOM

  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure of the output.
• WorkAreaCode: string
  Title: Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the work area. This attribute uniquely identifies a work area within a manufacturing plant.
• 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. The application generates this value.
• 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 user key to the work center.
• WorkCenterDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Description of the work center.
• WorkCenterId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work center. The application generates this value.
• WorkCenterName: string
  Title: Name

  Read Only: true

  Maximum Length: 120

  Name of the work center.
• WorkDefinitionId: integer (int64)
  Read Only: true

  Value 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: true

  Value that uniquely identifies the operation to which this operation output item is assigned.
• WorkDefinitionOperationOutputAttachment: array Attachments for Outputs
  Title: Attachments for Outputs

  The Attachments for Outputs resource gets the attachments that contain details about the output.
• WorkDefinitionOperationOutputDFF: array Flexfields for Outputs
  Title: Flexfields for Outputs

  The Flexfields for Outputs resource gets the descriptive flexfields that contain details about the output.

{
    "type":"object",
    "properties":{
        "BasisType":{
            "title":"Basis",
            "type":"number",
            "description":"Indicates whether the output quantity is fixed or variable. Valid values are contained in the lookup EGP_BOM_BASIS_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BasisTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Meaning for the basis type for the output defined in the work order operation, with valid values available in the lookup EGP_BOM_BASIS_TYPE",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CompletionLocator":{
            "maxLength":255,
            "type":"string",
            "description":"Locator into which this output line is produced.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CompletionSubinventory":{
            "title":"Completion Subinventory",
            "maxLength":10,
            "type":"string",
            "description":"Subinventory into which this output line is produced.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CompletionType":{
            "title":"Completion Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the completion type code. A list of accepted values is defined in the lookup type ORA_WIS_OUTPUT_COMPL_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CompletionTypeDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the completion type code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ComponentSequenceId":{
            "type":"integer",
            "description":"Reference to the item structure formula output (EGP_COMPONENTS_B) assigned to this operation.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CostAllocationPercentage":{
            "title":"Cost Allocation Percentage",
            "type":"number",
            "description":"Cost percentage share of this output across all outputs. This attribute is null for manually entered costs.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostingPriority":{
            "title":"Costing Priority",
            "type":"number",
            "description":"Priority 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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created this record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the work definition operation output is disabled.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FindNumber":{
            "title":"Find Number",
            "type":"number",
            "description":"Unique identifier of an output that appears more than once in a formula.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"User who most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Date when the record was most recently updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OperationName":{
            "title":"Name",
            "maxLength":120,
            "type":"string",
            "description":"Name of the work definition operation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OperationSequenceNumber":{
            "title":"Sequence",
            "type":"number",
            "description":"Number that indicates the sequence of running the operation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Output":{
            "maxLength":300,
            "type":"string",
            "description":"Number that identifies the output item of an operation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OutputDescription":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the item of the output.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OutputId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work definition operation output. The application generates this value.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "OutputSequence":{
            "title":"Sequence",
            "type":"number",
            "description":"Number that indicates the sequence of this output line within this operation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OutputType":{
            "title":"Output Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of output produced by the operation. A list of accepted values is defined in the lookup type ORA_WIS_WD_OUTPUT_MATERIAL.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductYield":{
            "title":"Yield",
            "type":"number",
            "description":"Factor used to calculate the output quantity produced by the operation. This attribute is currently not in use.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity of output expected to be produced by this operation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryQuantity":{
            "title":"Secondary Quantity",
            "type":"number",
            "description":"Output 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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryUOMCode":{
            "title":"Secondary UOM Code",
            "type":"string",
            "description":"Abbreviation that identifies the secondary unit of measure of the output. This attribute is associated with a feature that requires opt-in.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryUnitOfMeasure":{
            "title":"Secondary UOM",
            "type":"string",
            "description":"Secondary unit of measure of the output. This attribute is associated with a feature that requires opt-in.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StandardOperationCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the user key to the standard operation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StandardOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the standard operation. The application generates this value.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the work definition operation output is effective.",
            "format":"date-time",
            "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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure of the output.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "WorkAreaCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the work area. This attribute uniquely identifies a work area within a manufacturing plant.",
            "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
        },
        "WorkAreaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work area. The application generates this value.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkAreaName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the work area.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the user key to the work center.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the work center.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center. The application generates this value.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkCenterName":{
            "title":"Name",
            "maxLength":120,
            "type":"string",
            "description":"Name of the work center.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkDefinitionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work definition. This is used to enforce uniqueness of an output item across the work definition operations.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkDefinitionOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the operation to which this operation output item is assigned.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkDefinitionOperationOutputAttachment":{
            "title":"Attachments for Outputs",
            "type":"array",
            "description":"The Attachments for Outputs resource gets the attachments that contain details about the output.",
            "items":{
                "$ref":"#/components/schemas/workDefinitions-WorkDefinitionOutput-WorkDefinitionOperationOutputAttachment-item-response"
            }
        },
        "WorkDefinitionOperationOutputDFF":{
            "title":"Flexfields for Outputs",
            "type":"array",
            "description":"The Flexfields for Outputs resource gets the descriptive flexfields that contain details about the output.",
            "items":{
                "$ref":"#/components/schemas/workDefinitions-WorkDefinitionOutput-WorkDefinitionOperationOutputDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : Attachments for Outputs

Type: array

Title: Attachments for Outputs

The Attachments for Outputs resource gets the attachments that contain details about the output.

Show Source

• Array of: object workDefinitions-WorkDefinitionOutput-WorkDefinitionOperationOutputAttachment-item-response

{
    "title":"Attachments for Outputs",
    "type":"array",
    "description":"The Attachments for Outputs resource gets the attachments that contain details about the output.",
    "items":{
        "$ref":"#/components/schemas/workDefinitions-WorkDefinitionOutput-WorkDefinitionOperationOutputAttachment-item-response"
    }
}

Nested Schema : Flexfields for Outputs

Type: array

Title: Flexfields for Outputs

The Flexfields for Outputs resource gets the descriptive flexfields that contain details about the output.

Show Source

• Array of: object workDefinitions-WorkDefinitionOutput-WorkDefinitionOperationOutputDFF-item-response

{
    "title":"Flexfields for Outputs",
    "type":"array",
    "description":"The Flexfields for Outputs resource gets the descriptive flexfields that contain details about the output.",
    "items":{
        "$ref":"#/components/schemas/workDefinitions-WorkDefinitionOutput-WorkDefinitionOperationOutputDFF-item-response"
    },
    "x-cardinality":"1"
}

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 : workDefinitions-WorkDefinitionOutput-WorkDefinitionOperationOutputAttachment-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Value 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: Category

  Maximum Length: 30

  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 isn't shared. This attribute doesn't have a default value.
• 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 in the attachment are no longer available.
• 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 is attached to the work definition operation output.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  Login of the user who updated the document that is attached to the work definition operation output.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  Login that the user used when updating the document that is attached to the work definition.
• 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.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Value 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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "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 isn't shared. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "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
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the contents in the attachment are no longer available.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "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
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL (Uniform Resource Locator) that locates the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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":{
                "help":{
                    "instruction":"The base64 encoded image of the file displayed in .png format if the source is a convertible image."
                },
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the document that is attached to the work definition operation output.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"Login of the user who updated the document that is attached to the work definition operation output.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Login that the user used when updating the document that is attached to the work definition.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Length of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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"
            }
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : workDefinitions-WorkDefinitionOutput-WorkDefinitionOperationOutputDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 80

  Descriptive flexfield context name for work definition operation output.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Descriptive flexfield context display value for work definition operation output.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• WdOperationOutputId: integer (int64)
  Value that uniquely identifies the work definition operation output. The application generates this value.

{
    "type":"object",
    "properties":{
        "WdOperationOutputId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work definition operation output. The application generates this value.",
            "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 definition operation output.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Segment"
                },
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"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
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Descriptive flexfield context display value for work definition operation output.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Segment"
                },
                "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

WorkDefinitionOperationOutputAttachment

Operation: /fscmRestApi/resources/11.13.18.05/workDefinitions/{WorkDefinitionId}/child/WorkDefinitionOutput/{OutputId}/child/WorkDefinitionOperationOutputAttachment

Parameters:

• OutputId2: $request.path.OutputId2
• WorkDefinitionId: $request.path.WorkDefinitionId

The Attachments for Outputs resource gets the attachments that contain details about the output.

WorkDefinitionOperationOutputDFF

Operation: /fscmRestApi/resources/11.13.18.05/workDefinitions/{WorkDefinitionId}/child/WorkDefinitionOutput/{OutputId}/child/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.

Back to Top

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"
	}
	]
}

Back to Top