Jump to

• Request
• Response

Create one output

post

/fscmRestApi/resources/11.13.18.05/workDefinitionRequests/{workDefinitionRequestsUniqID}/child/workDefinitionHeaders/{workDefinitionHeadersUniqID}/child/outputs

Request

Path Parameters

• workDefinitionHeadersUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Work Definition Headers resource and used to uniquely identify an instance of Work Definition Headers. The client should not generate the hash key value. Instead, the client should query on the Work Definition Headers collection resource in order to navigate to a specific instance of Work Definition Headers to get the hash key.
• workDefinitionRequestsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Work Definition Requests resource and used to uniquely identify an instance of Work Definition Requests. The client should not generate the hash key value. Instead, the client should query on the Work Definition Requests collection resource in order to navigate to a specific instance of Work Definition Requests to get the hash key.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActionCode: string
  Maximum Length: 30

  Value that specifies the desired action to perform on the output of a work definition operation. Valid values include CREATE, UPDATE, or DELETE. This is a mandatory attribute.
• CompletionLocator: string
  Maximum Length: 255

  Locator into which this output line is produced.
• CompletionSubinventoryCode: string
  Maximum Length: 10

  Subinventory into which this output line is produced.
• CompletionType: string
  Maximum Length: 30

  Value that indicates the completion type. A list of accepted values is defined in the lookup type ORA_WIS_OUTPUT_COMPL_TYPE.
• CostAllocationPercentage: number
  Percent cost share of this output across all outputs. This attribute is null for manually entered costs.
• CostingPriority: number
  Priority to use when determining which work definition to use when calculating the standard cost by using rolling up costs during costing. In the bill of materials, the child work definitions are threaded using the priority number selected at the top.
• ErrorMessageNames: string
  Maximum Length: 255

  Names of the error messages that occurred when processing the work definition operation output. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma (,) separates each message name.
• ErrorMessages: string
  Maximum Length: 2000

  Text of the error messages, if any, that occurred when processing the work definition operation output. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.
• OperationSequenceNumber: number
  Number that indicates the sequence of running the operation.
• OutputItemNumber: string
  Maximum Length: 300

  Number that identifies the output item of an operation.
• OutputSequenceNumber: number
  Number that indicates the sequence of this output line within this operation.
• OutputType: string
  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.
• Quantity: number
  Quantity of output expected to be produced by this operation. The quantity is required when the unit of measure is provided.
• UOMCode: string
  Maximum Length: 3

  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.

{
    "type":"object",
    "properties":{
        "CostingPriority":{
            "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. In the bill of materials, the child work definitions are threaded using the priority number selected at the top.",
            "nullable":true
        },
        "CompletionLocator":{
            "maxLength":"255",
            "type":"string",
            "description":"Locator into which this output line is produced.",
            "nullable":true
        },
        "OutputItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Number that identifies the output item of an operation.",
            "nullable":true
        },
        "ActionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that specifies the desired action to perform on the output of a work definition operation. Valid values include CREATE, UPDATE, or DELETE. This is a mandatory attribute.",
            "nullable":false
        },
        "ErrorMessageNames":{
            "maxLength":"255",
            "type":"string",
            "description":"Names of the error messages that occurred when processing the work definition operation output. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma (,) separates each message name.",
            "nullable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of output expected to be produced by this operation. The quantity is required when the unit of measure is provided.",
            "nullable":true
        },
        "CompletionType":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates the completion type. A list of accepted values is defined in the lookup type ORA_WIS_OUTPUT_COMPL_TYPE.",
            "nullable":true
        },
        "CompletionSubinventoryCode":{
            "maxLength":"10",
            "type":"string",
            "description":"Subinventory into which this output line is produced.",
            "nullable":true
        },
        "CostAllocationPercentage":{
            "type":"number",
            "description":"Percent cost share of this output across all outputs. This attribute is null for manually entered costs.",
            "nullable":true
        },
        "OutputSequenceNumber":{
            "type":"number",
            "description":"Number that indicates the sequence of this output line within this operation.",
            "nullable":true
        },
        "ErrorMessages":{
            "maxLength":"2000",
            "type":"string",
            "description":"Text of the error messages, if any, that occurred when processing the work definition operation output. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.",
            "nullable":true
        },
        "OperationSequenceNumber":{
            "type":"number",
            "description":"Number that indicates the sequence of running the operation.",
            "nullable":true
        },
        "UOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "OutputType":{
            "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":true
        }
    }
}

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 : workDefinitionRequests-workDefinitionHeaders-outputs-item-response

Type: object

Show Source

• ActionCode: string
  Maximum Length: 30

  Value that specifies the desired action to perform on the output of a work definition operation. Valid values include CREATE, UPDATE, or DELETE. This is a mandatory attribute.
• CompletionLocator: string
  Maximum Length: 255

  Locator into which this output line is produced.
• CompletionSubinventoryCode: string
  Maximum Length: 10

  Subinventory into which this output line is produced.
• CompletionType: string
  Maximum Length: 30

  Value that indicates the completion type. A list of accepted values is defined in the lookup type ORA_WIS_OUTPUT_COMPL_TYPE.
• CostAllocationPercentage: number
  Percent cost share of this output across all outputs. This attribute is null for manually entered costs.
• CostingPriority: number
  Priority to use when determining which work definition to use when calculating the standard cost by using rolling up costs during costing. In the bill of materials, the child work definitions are threaded using the priority number selected at the top.
• ErrorMessageNames: string
  Maximum Length: 255

  Names of the error messages that occurred when processing the work definition operation output. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma (,) separates each message name.
• ErrorMessages: string
  Maximum Length: 2000

  Text of the error messages, if any, that occurred when processing the work definition operation output. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OperationSequenceNumber: number
  Number that indicates the sequence of running the operation.
• OutputItemNumber: string
  Maximum Length: 300

  Number that identifies the output item of an operation.
• OutputSequenceNumber: number
  Number that indicates the sequence of this output line within this operation.
• OutputType: string
  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.
• Quantity: number
  Quantity of output expected to be produced by this operation. The quantity is required when the unit of measure is provided.
• UOMCode: string
  Maximum Length: 3

  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.

{
    "type":"object",
    "properties":{
        "CostingPriority":{
            "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. In the bill of materials, the child work definitions are threaded using the priority number selected at the top.",
            "nullable":true,
            "x-queryable":true
        },
        "CompletionLocator":{
            "maxLength":"255",
            "type":"string",
            "description":"Locator into which this output line is produced.",
            "nullable":true,
            "x-queryable":true
        },
        "OutputItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Number that identifies the output item of an operation.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that specifies the desired action to perform on the output of a work definition operation. Valid values include CREATE, UPDATE, or DELETE. This is a mandatory attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "ErrorMessageNames":{
            "maxLength":"255",
            "type":"string",
            "description":"Names of the error messages that occurred when processing the work definition operation output. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma (,) separates each message name.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of output expected to be produced by this operation. The quantity is required when the unit of measure is provided.",
            "nullable":true,
            "x-queryable":true
        },
        "CompletionType":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates the completion type. A list of accepted values is defined in the lookup type ORA_WIS_OUTPUT_COMPL_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "CompletionSubinventoryCode":{
            "maxLength":"10",
            "type":"string",
            "description":"Subinventory into which this output line is produced.",
            "nullable":true,
            "x-queryable":true
        },
        "CostAllocationPercentage":{
            "type":"number",
            "description":"Percent cost share of this output across all outputs. This attribute is null for manually entered costs.",
            "nullable":true,
            "x-queryable":true
        },
        "OutputSequenceNumber":{
            "type":"number",
            "description":"Number that indicates the sequence of this output line within this operation.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMessages":{
            "maxLength":"2000",
            "type":"string",
            "description":"Text of the error messages, if any, that occurred when processing the work definition operation output. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.",
            "nullable":true,
            "x-queryable":true
        },
        "OperationSequenceNumber":{
            "type":"number",
            "description":"Number that indicates the sequence of running the operation.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "OutputType":{
            "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":true,
            "x-queryable":true
        }
    }
}

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 : 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."
        }
    }
}

Back to Top