1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Manufacturing
  4. Work Definition Requests
  5. Work Definition Headers

Create one work definition header

post

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

Request

Path Parameters
  • 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
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Maximum Length: 30
    Value that specifies the desired action to perform on the work definition. Valid values include CREATE, UPDATE, or DELETE. This is a mandatory attribute.
  • Alternate Resources
    Title: Alternate Resources
    The Alternate Resources resource manages the alternate resources of a resource.
  • ATO Materials
    Title: ATO Materials
    The ATO Materials resource manages the materials for assemble-to-order (ATO) enabled items.
  • Batch quantity for which the work definition is defined.
  • Maximum Length: 3
    Unit of measure of the batch quantity.
  • Maximum Length: 255
    Locator into which the product completion is posted.
  • Maximum Length: 10
    Value that indicates the default subinventory where the primary product is yielded.
  • Value that indicates the costing item attribute for costing output batch size; for example, 10 units, is maintained on the item master. The default value is defined in the work definition header where it can be edited. Maintaining the costing output batch size in the work definition allows for changes from year to year, whereas, the value in the item master is static. This costing attribute is used for cost planning and simulation purposes.
  • 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.
  • Maximum Length: 255
    Names of the error messages that occurred when processing the work definition request. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma (,) separates each message name.
  • Maximum Length: 2000
    Text of the error message, if any, that occurred when processing the work definition request. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.
  • Maximum Length: 300
    Number that represents the user key to the top level, final assembly, subassembly, or model item that belongs to an organization.
  • Maximum Length: 80
    Unique name given to a specific variation of an item structure type.
  • Maximum Length: 30
    Abbreviation that identifies the user-defined maintenance work definition.
  • Maximum Length: 240
    Description of the maintenance work definition name.
  • Maximum Length: 120
    Name of the maintenance work definition.
  • Materials
    Title: Materials
    The Materials resource manages the materials of a work definition operation.
  • Operations
    Title: Operations
    The Operations resource manages the operations of a work definition.
  • Maximum Length: 30
    Value that identifies the manufacturing plant to which this work definition belongs.
  • Outputs
    Title: Outputs
    The Outputs resource manages the outputs of a work definition operation.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then one or more lot numbers can be preassigned to a product in a manufacturing work order that references this work definition. If false, then lot numbers can't be preassigned to a product in the manufacturing work order. A product is any type of production output, whether it is the primary product, co-product, or by-product in the case of a process manufacturing work definition or the assembly in the case of a discrete manufacturing work definition. If the value of the ActionCode attribute is CREATE, then the default value of this attribute is set to false. If the value of the ActionCode attribute is UPDATE, you can ignore this attribute in the request payload unless you want to flip the value of this attribute. This attribute is associated with a feature that requires opt in.
  • Maximum Length: 120
    Name of the process. This attribute is applicable only when WorkMethodCode is PROCESS_MANUFACTURING.
  • Value that indicates the relative rank of the work definition compared to other work definitions for the item. The work definition with a priority of 1 for an item is considered the primary work definition. A stacked rank of production priorities indicates alternate capacity to Oracle Planning Cloud.
  • Resources
    Title: Resources
    The Resources resource manages the resources of a work definition operation.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the end item; for example, assembly in discrete manufacturing, is tracked by serial numbers during work execution. If false, then the end assembly is not serial tracked. If the ActionCode attribute is CREATE, then the default value is set to false. If ActionCode is UPDATE, you can ignore this attribute in the request payload if you don't want to flip the value of this attribute. The default value is false.
  • Date when the work definition version is effective.
  • Maximum Length: 30
    Value that indicates the status of the work definition. Valid values are Active and Inactive. The default value is Active.
  • Maximum Length: 300
    Number that identifies the assembly item being transformed to a new assembly item on a transform work definition.
  • Maximum Length: 10
    Number that indicates the version of the work definition.
  • Maximum Length: 30
    Value that indicates the user-defined work definition code.
  • Value that uniquely identifies the work definition. Its value is an application generated.
  • Maximum Length: 30
    Value that represents the user key to the work method.
  • Maximum Length: 30
    Subtype of default work order used during work order creation.
  • Maximum Length: 30
    Type of default work order used during work order creation.
Nested Schema : Alternate Resources
Type: array
Title: Alternate Resources
The Alternate Resources resource manages the alternate resources of a resource.
Show Source
Nested Schema : ATO Materials
Type: array
Title: ATO Materials
The ATO Materials resource manages the materials for assemble-to-order (ATO) enabled items.
Show Source
Nested Schema : Materials
Type: array
Title: Materials
The Materials resource manages the materials of a work definition operation.
Show Source
Nested Schema : Operations
Type: array
Title: Operations
The Operations resource manages the operations of a work definition.
Show Source
Nested Schema : Outputs
Type: array
Title: Outputs
The Outputs resource manages the outputs of a work definition operation.
Show Source
Nested Schema : Resources
Type: array
Title: Resources
The Resources resource manages the resources of a work definition operation.
Show Source
Nested Schema : workDefinitionRequests-workDefinitionHeaders-alternateResources-item-post-request
Type: object
Show Source
  • Maximum Length: 30
    Value that specifies the desired action to perform on the alternate resource of a work definition operation resource. Valid values are CREATE, UPDATE, or DELETE. This is a mandatory attribute.
  • Maximum Length: 30
    Value that indicates the alternate resource.
  • Maximum Length: 30
    Value that indicates whether the resource usage is fixed, such as usage per lot produced, or variable, such as usage per item produced. Valid values are: 1 (VARIABLE), 2 (FIXED). If the value is not specified during the CREATE action, the default value is 1.
  • Value that uniquely identifies the parametric data and inspection characteristics stored in the equipment parameters flat file associated with the work definition operation alternate resource.
  • Maximum Length: 512
    Name of the equipment parameters flat file associated with the work definition operation alternate resource.
  • Maximum Length: 225
    Names of the error messages that occurred when processing the alternate resources of a work definition operation resource. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma (,) separates each message name.
  • Maximum Length: 2000
    Text of the error message, if any, that occurred when processing the alternate resources of a work definition operation resource. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.
  • Value that indicates the inverse alternate resource usage rate.
  • Number that indicates the execution sequence of the operation. A valid value must be a positive whole number.
  • Value that indicates the order of priority. Oracle Planning Cloud uses this information to select the appropriate alternate resource. A valid value must be a positive whole number.
  • Maximum Length: 300
    The name of the program file to be associated with an automation equipment resource in the work definition. This program file name must be associated with the automation equipment resource in the resource definition.
  • Maximum Length: 30
    Value that represents the resource code of the resource for which this alternate resource is applicable.
  • Number that defines the sequence of the resource used in the operation. A valid value must be a positive whole number.
  • Value that indicates the number of alternate resources assigned to this operation. A valid value must be a positive whole number. The default value is from the primary resource.
  • The alternate resource usage rate to yield one unit of product. The default value is from the primary resource.
Nested Schema : schema
Type: object
Show Source
  • Maximum Length: 30
    Value that specifies the desired action to perform on the alternate resource of a work definition assemble-to-order (ATO) materials. Valid values are CREATE, UPDATE, or DELETE. This is a mandatory attribute.
  • Maximum Length: 4000
    Value that indicates the hierarchy in the item structure at which the material is assigned.
  • Maximum Length: 255
    Names of the error messages that occurred when processing the work definition assemble-to-order (ATO) material. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma (,) separates each message name.
  • Maximum Length: 2000
    Text of the error messages that occurred when processing the work definition assemble-to-order (ATO) material. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.
  • Unique identifier of a component that appears more than once in an item structure.
  • Maximum Length: 300
    Number that identifies the item.
  • Number that indicates the unique sequence of the component assigned to the work definition operation.
  • Number that indicates the execution sequence of the operation. A valid value must be a positive whole number.
  • Date when the material assignment begins.
  • Maximum Length: 255
    Locator in subinventory to use, by default, when the plant uses material during assembly or an operation pull.
  • Maximum Length: 10
    Value that indicates the subinventory from which this material is consumed.
  • Maximum Length: 30
    Value that indicates the supply type. Valid values are 1 (Push), 2 (Assembly Pull), 3 (Operation Pull), 4 (Bulk), 5 (Supplier), and 6 (Phantom). If a value is not specified in the request payload, then the default value in the item structure for item structure components is used. for ad hoc items, the default value in the item master is used.
Nested Schema : workDefinitionRequests-workDefinitionHeaders-materials-item-post-request
Type: object
Show Source
  • Maximum Length: 30
    Value that specifies the desired action to perform on the material of a work definition operation. Valid values include CREATE, UPDATE, or DELETE. This is a mandatory attribute.
  • Maximum Length: 1
    Contains one of the following values: true or false. If false, then the material line is based on the item structure. If true, then the material line isn't based on the item structure. This attribute doesn't have a default value. This is a mandatory attribute when ActionCode is CREATE.
  • Maximum Length: 30
    Contains one of the following values: 1 or 2. If 1, then the application does not consider the quantity of the work order when it sets the component quantity that it requires for the parent assembly. If 2, then the application varies the component quantity that it requires for the parent assembly according to the quantity of the work order. For item structure components, the default value is the value in the item structure. For ad hoc items, the default value is 1.
  • Maximum Length: 255
    Names of the error messages that occurred when processing the work definition operation material. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma (,) separates each message name.
  • Maximum Length: 2000
    Text of the error message, if any, that occurred when processing the work definition operation material. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.
  • Unique identifier of a component that appears more than once in an item structure.
  • Inverse of the Quantity Per Product. The application uses the inverse when the Quantity Per Product for the material is a fraction, but the inverse of this quantity is an integer. Don't specify this attribute if a value is specified for the Quantity attribute in the request payload.
  • Maximum Length: 300
    Number that identifies the item.
  • Number that defines the unique sequence of the component assigned to the work definition operation.
  • Number that indicates the execution sequence of the operation. A valid value must be a positive whole number.
  • Quantity required to make each unit of the item. The quantity is required when the unit of measure is provided.
  • Date when the structure component is effective. This must be specified only if the item appears multiple times in the item structure with different effective dates.
  • Locator in subinventory to use, by default, when the plant uses material during assembly or an operation pull.
  • Maximum Length: 10
    Value that indicates the subinventory from which this material is consumed.
  • Maximum Length: 30
    Value that indicates the supply type code. Valid values are 1 (Push), 2 (Assembly Pull), 3 (Operation Pull), 4 (Bulk), 5 (Supplier), and 6 (Phantom). If a value is not specified in the request payload, then for item structure components, the default value is the value in the item structure; for ad hoc items, the default value is the value in the item master.
  • Maximum Length: 3
    Abbreviation that identifies the unit of measure that the material uses 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.
  • Factor to use when calculating the quantity that the operation requires to accommodate component waste when it processes the item. It is recommended that you set the yield to between 0 and 1. You can set the yield to a value that is greater than 1. The application considers the yield when it calculates the required quantity according to the Include plant parameter for the component yield.
Nested Schema : schema
Type: object
Show Source
  • Maximum Length: 30
    Value that specifies the desired action to perform on the work definition operation. Valid values include CREATE, UPDATE, or DELETE. This is a mandatory attribute.
  • Maximum Length: 30
    Name that identifies a list of values that control whether a production operator can issue more than the required quantity while manually reporting material issues. You can allow issuing more than the required quantity without any hindrance, or prevent the material issue in case of additional material issue.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then both resources and materials are automatically charged based on the supply type or the charge type setups for the operation. If the supply type is Operation Pull, the component-level issue transactions will occur when the operation is completed. If the supply type is Assembly Pull, the component level issue transactions will happen at the assembly completion event. The resource transactions are automatically done when the quantity is moved outside the operation. If false, then both resources and materials are not automatically charged. The default value is false.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the operation is a count-point operation. If an operation is a count-point operation, then you have to manually complete it. Any operations in between the count points are automatically completed; for example, backflushed, and so on. If false, then the operation is not a count-point operation. The default value is true. The last operation should always be a count-point operation.
  • Maximum Length: 255
    Names of the error messages that occurred when processing the work definition operation. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma (,) separates each message name.
  • Maximum Length: 2000
    Text of the error message, if any, that occurred when processing the work definition operation. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.
  • Fixed lead time used to calculate the operation's start and end date for the supplier operation.
  • Percent lead time computed by the manufacturing lead time calculation program and used in the cumulative lead time calculation.
  • Maximum Length: 25
    Unit of measure for the fixed or variable lead time values on the supplier operation.
  • Maximum Length: 30
    Name that identifies a list of values that control whether operation completion should be allowed when open exceptions exist for an operation. You can allow operation completion without any hindrance, allow with a warning, or prevent the operation completion.
  • Maximum Length: 30
    Name that identifies a list of values that control whether operation completion should be allowed when less than the required quantity of material is issued. You can allow operation completion without any hindrance, allow with a warning, or prevent the operation completion.
  • Maximum Length: 240
    Value that indicates the description of the work definition operation.
  • Maximum Length: 120
    Value that indicates the name of the work definition operation.
  • Number that defines the sequence of operation execution. A valid value must be a positive whole number.
  • Maximum Length: 30
    Value that specifies the type of the operation. A list of accepted values is defined in the lookup type ORA_WIS_OPERATION_TYPE.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the operation is dependent on one or more optional components. If false, then the operation is not dependent on optional components. The default value is false. This attribute applies only to an assemble-to-order (ATO) model work definition.
  • Maximum Length: 300
    Item number that represents the value added service in a supplier operation. This is also commonly known as a partially finished assembly.
  • Percent that is used by planning for resources forecast explosion. This applies to an assemble-to-order (ATO) model work definition only.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the operation references a standard operation. If false, then the operation doesn't reference a standard operation. The default value is false. If the value is true, then a valid value must be specified for the attribute StandardOperationCode.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the work order has resequence operations. If false, then the work order doesn't have resequence operations. This attribute is associated with a feature that requires opt in.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the product is tracked by serial number while running the operation. If false, then the product is not tracked by serial number. The default value is false.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then create shipping documents for the outside processing (OSP) operation. If false, then do not create shipping documents. If the request payload doesn't specify this attribute, then the default value is from the Shippable attribute in the item master. The default value is false.
  • Maximum Length: 30
    Value that represents the user key to the standard operation.
  • Maximum Length: 360
    Name of the suggested supplier for a supplier operation.
  • Maximum Length: 15
    Value that identifies the suggested supplier site for a supplier operation.
  • Variable lead time used to calculate the operation's start and end date based on the operation quantity for the supplier operation.
  • Maximum Length: 30
    Value that indicates the user key of the work center where this operation is executed.
Nested Schema : schema
Type: object
Show Source
  • 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.
  • Maximum Length: 255
    Locator into which this output line is produced.
  • Maximum Length: 10
    Subinventory into which this output line is produced.
  • 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.
  • Percent cost share of this output across all outputs. This attribute is null for manually entered costs.
  • 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.
  • 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.
  • 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.
  • Number that indicates the sequence of running the operation.
  • Maximum Length: 300
    Number that identifies the output item of an operation.
  • Number that indicates the sequence of this output line within this operation.
  • 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 of output expected to be produced by this operation. The quantity is required when the unit of measure is provided.
  • 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.
Nested Schema : schema
Type: object
Show Source
  • Maximum Length: 30
    Value that specifies the desired action to perform on the resource of a work definition operation. Valid values include CREATE, UPDATE, or DELETE. This is a mandatory attribute.
  • Value that indicates the number of resources assigned to this operation. A valid value must be a positive whole number. The default value is 1 if a value is not specified during the CREATE action.
  • Maximum Length: 30
    Value that indicates whether the resource usage is fixed, such as usage per lot produced, or variable, such as usage per item produced. Valid values are: 1 (VARIABLE) or 2 (FIXED). The default value is 1 if a value is not specified during the CREATE action.
  • Maximum Length: 30
    Default Value: AUTOMATIC
    Contains one of the following values: AUTOMATIC and MANUAL. If AUTOMATIC, then the resource is charged automatically during work execution. If MANUAL, then the resource is charged manually during work execution. The default value is AUTOMATIC.
  • Value that uniquely identifies the parametric data and inspection characteristics stored in the equipment parameters flat file associated with the work definition operation resource.
  • Maximum Length: 512
    Name of the equipment parameters flat file associated with the work definition operation resource.
  • Maximum Length: 30
    Abbreviation that identifies the equipment profile associated with the work definition operation resource. This attribute is associated with a feature that requires opt in.
  • Maximum Length: 255
    Names of the error messages that occurred when processing the work definition operation resource. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma (,) separates each message name.
  • Maximum Length: 2000
    Text of the error messages, if any, that occurred when processing the work definition operation resource. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.
  • Value that indicates the inverse resource usage rate. Don't specify this attribute if a value is specified for the UsageRate attribute.
  • Number that defines the sequence of operation execution. A valid value must be a positive whole number.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the resource is the principal resource among the group of simultaneous resources. When two or more resources are running in parallel; for example, simultaneous resources that have the same sequence number, only one of them must be marked as the principal or the primary resource. Planning will error if the principal resource is not available when checking for capacity. If false, then this resource is not the principal resource. The default value is false.
  • Maximum Length: 30
    Abbreviation that identifies the job profile associated with the work definition operation resource. This attribute is associated with a feature that requires opt in.
  • Maximum Length: 300
    The name of the program file to be associated with an automation equipment resource in the work definition. This program file name must be associated to the automation equipment resource in the resource definition.
  • Maximum Length: 30
    Value that indicates the activity this production resource is going to perform at this operation. Valid values include ORA_RUN, ORA_SETUP, and ORA_TEAR_DOWN. A list of accepted values is defined in the lookup type ORA_WIS_RESOURCE_ACTIVITY. The default value is ORA_RUN.
  • Maximum Length: 30
    Value that indicates the resource assigned to the operation.
  • Number that defines the sequence of the resource used in the operation. A valid value must be a positive whole number.
  • Maximum Length: 30
    Default Value: NO
    Contains one of the following values: YES and NO. If YES, then resource is scheduled. If NO, then resource is not scheduled. The default value is NO if no value is specified during the CREATE action.
  • Resource usage rate to yield one unit of product. The default value is 1 if a value is not specified during the CREATE action.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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-item-response
Type: object
Show Source
  • Maximum Length: 30
    Value that specifies the desired action to perform on the work definition. Valid values include CREATE, UPDATE, or DELETE. This is a mandatory attribute.
  • Alternate Resources
    Title: Alternate Resources
    The Alternate Resources resource manages the alternate resources of a resource.
  • ATO Materials
    Title: ATO Materials
    The ATO Materials resource manages the materials for assemble-to-order (ATO) enabled items.
  • Batch quantity for which the work definition is defined.
  • Maximum Length: 3
    Unit of measure of the batch quantity.
  • Maximum Length: 255
    Locator into which the product completion is posted.
  • Maximum Length: 10
    Value that indicates the default subinventory where the primary product is yielded.
  • Value that indicates the costing item attribute for costing output batch size; for example, 10 units, is maintained on the item master. The default value is defined in the work definition header where it can be edited. Maintaining the costing output batch size in the work definition allows for changes from year to year, whereas, the value in the item master is static. This costing attribute is used for cost planning and simulation purposes.
  • 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.
  • Maximum Length: 255
    Names of the error messages that occurred when processing the work definition request. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma (,) separates each message name.
  • Maximum Length: 2000
    Text of the error message, if any, that occurred when processing the work definition request. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.
  • Maximum Length: 300
    Number that represents the user key to the top level, final assembly, subassembly, or model item that belongs to an organization.
  • Maximum Length: 80
    Unique name given to a specific variation of an item structure type.
  • Links
  • Maximum Length: 30
    Abbreviation that identifies the user-defined maintenance work definition.
  • Maximum Length: 240
    Description of the maintenance work definition name.
  • Maximum Length: 120
    Name of the maintenance work definition.
  • Materials
    Title: Materials
    The Materials resource manages the materials of a work definition operation.
  • Operations
    Title: Operations
    The Operations resource manages the operations of a work definition.
  • Maximum Length: 30
    Value that identifies the manufacturing plant to which this work definition belongs.
  • Outputs
    Title: Outputs
    The Outputs resource manages the outputs of a work definition operation.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then one or more lot numbers can be preassigned to a product in a manufacturing work order that references this work definition. If false, then lot numbers can't be preassigned to a product in the manufacturing work order. A product is any type of production output, whether it is the primary product, co-product, or by-product in the case of a process manufacturing work definition or the assembly in the case of a discrete manufacturing work definition. If the value of the ActionCode attribute is CREATE, then the default value of this attribute is set to false. If the value of the ActionCode attribute is UPDATE, you can ignore this attribute in the request payload unless you want to flip the value of this attribute. This attribute is associated with a feature that requires opt in.
  • Maximum Length: 120
    Name of the process. This attribute is applicable only when WorkMethodCode is PROCESS_MANUFACTURING.
  • Value that indicates the relative rank of the work definition compared to other work definitions for the item. The work definition with a priority of 1 for an item is considered the primary work definition. A stacked rank of production priorities indicates alternate capacity to Oracle Planning Cloud.
  • Resources
    Title: Resources
    The Resources resource manages the resources of a work definition operation.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the end item; for example, assembly in discrete manufacturing, is tracked by serial numbers during work execution. If false, then the end assembly is not serial tracked. If the ActionCode attribute is CREATE, then the default value is set to false. If ActionCode is UPDATE, you can ignore this attribute in the request payload if you don't want to flip the value of this attribute. The default value is false.
  • Date when the work definition version is effective.
  • Maximum Length: 30
    Value that indicates the status of the work definition. Valid values are Active and Inactive. The default value is Active.
  • Maximum Length: 300
    Number that identifies the assembly item being transformed to a new assembly item on a transform work definition.
  • Maximum Length: 10
    Number that indicates the version of the work definition.
  • Maximum Length: 30
    Value that indicates the user-defined work definition code.
  • Value that uniquely identifies the work definition. Its value is an application generated.
  • Maximum Length: 30
    Value that represents the user key to the work method.
  • Maximum Length: 30
    Subtype of default work order used during work order creation.
  • Maximum Length: 30
    Type of default work order used during work order creation.
Nested Schema : Alternate Resources
Type: array
Title: Alternate Resources
The Alternate Resources resource manages the alternate resources of a resource.
Show Source
Nested Schema : ATO Materials
Type: array
Title: ATO Materials
The ATO Materials resource manages the materials for assemble-to-order (ATO) enabled items.
Show Source
Nested Schema : Materials
Type: array
Title: Materials
The Materials resource manages the materials of a work definition operation.
Show Source
Nested Schema : Operations
Type: array
Title: Operations
The Operations resource manages the operations of a work definition.
Show Source
Nested Schema : Outputs
Type: array
Title: Outputs
The Outputs resource manages the outputs of a work definition operation.
Show Source
Nested Schema : Resources
Type: array
Title: Resources
The Resources resource manages the resources of a work definition operation.
Show Source
Nested Schema : workDefinitionRequests-workDefinitionHeaders-alternateResources-item-response
Type: object
Show Source
  • Maximum Length: 30
    Value that specifies the desired action to perform on the alternate resource of a work definition operation resource. Valid values are CREATE, UPDATE, or DELETE. This is a mandatory attribute.
  • Maximum Length: 30
    Value that indicates the alternate resource.
  • Maximum Length: 30
    Value that indicates whether the resource usage is fixed, such as usage per lot produced, or variable, such as usage per item produced. Valid values are: 1 (VARIABLE), 2 (FIXED). If the value is not specified during the CREATE action, the default value is 1.
  • Value that uniquely identifies the parametric data and inspection characteristics stored in the equipment parameters flat file associated with the work definition operation alternate resource.
  • Maximum Length: 512
    Name of the equipment parameters flat file associated with the work definition operation alternate resource.
  • Maximum Length: 225
    Names of the error messages that occurred when processing the alternate resources of a work definition operation resource. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma (,) separates each message name.
  • Maximum Length: 2000
    Text of the error message, if any, that occurred when processing the alternate resources of a work definition operation resource. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.
  • Value that indicates the inverse alternate resource usage rate.
  • Links
  • Number that indicates the execution sequence of the operation. A valid value must be a positive whole number.
  • Value that indicates the order of priority. Oracle Planning Cloud uses this information to select the appropriate alternate resource. A valid value must be a positive whole number.
  • Maximum Length: 300
    The name of the program file to be associated with an automation equipment resource in the work definition. This program file name must be associated with the automation equipment resource in the resource definition.
  • Maximum Length: 30
    Value that represents the resource code of the resource for which this alternate resource is applicable.
  • Number that defines the sequence of the resource used in the operation. A valid value must be a positive whole number.
  • Value that indicates the number of alternate resources assigned to this operation. A valid value must be a positive whole number. The default value is from the primary resource.
  • The alternate resource usage rate to yield one unit of product. The default value is from the primary resource.
Nested Schema : workDefinitionRequests-workDefinitionHeaders-ATOMaterials-item-response
Type: object
Show Source
  • Maximum Length: 30
    Value that specifies the desired action to perform on the alternate resource of a work definition assemble-to-order (ATO) materials. Valid values are CREATE, UPDATE, or DELETE. This is a mandatory attribute.
  • Maximum Length: 4000
    Value that indicates the hierarchy in the item structure at which the material is assigned.
  • Maximum Length: 255
    Names of the error messages that occurred when processing the work definition assemble-to-order (ATO) material. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma (,) separates each message name.
  • Maximum Length: 2000
    Text of the error messages that occurred when processing the work definition assemble-to-order (ATO) material. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.
  • Unique identifier of a component that appears more than once in an item structure.
  • Maximum Length: 300
    Number that identifies the item.
  • Links
  • Number that indicates the unique sequence of the component assigned to the work definition operation.
  • Number that indicates the execution sequence of the operation. A valid value must be a positive whole number.
  • Date when the material assignment begins.
  • Maximum Length: 255
    Locator in subinventory to use, by default, when the plant uses material during assembly or an operation pull.
  • Maximum Length: 10
    Value that indicates the subinventory from which this material is consumed.
  • Maximum Length: 30
    Value that indicates the supply type. Valid values are 1 (Push), 2 (Assembly Pull), 3 (Operation Pull), 4 (Bulk), 5 (Supplier), and 6 (Phantom). If a value is not specified in the request payload, then the default value in the item structure for item structure components is used. for ad hoc items, the default value in the item master is used.
Nested Schema : workDefinitionRequests-workDefinitionHeaders-materials-item-response
Type: object
Show Source
  • Maximum Length: 30
    Value that specifies the desired action to perform on the material of a work definition operation. Valid values include CREATE, UPDATE, or DELETE. This is a mandatory attribute.
  • Maximum Length: 1
    Contains one of the following values: true or false. If false, then the material line is based on the item structure. If true, then the material line isn't based on the item structure. This attribute doesn't have a default value. This is a mandatory attribute when ActionCode is CREATE.
  • Maximum Length: 30
    Contains one of the following values: 1 or 2. If 1, then the application does not consider the quantity of the work order when it sets the component quantity that it requires for the parent assembly. If 2, then the application varies the component quantity that it requires for the parent assembly according to the quantity of the work order. For item structure components, the default value is the value in the item structure. For ad hoc items, the default value is 1.
  • Maximum Length: 255
    Names of the error messages that occurred when processing the work definition operation material. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma (,) separates each message name.
  • Maximum Length: 2000
    Text of the error message, if any, that occurred when processing the work definition operation material. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.
  • Unique identifier of a component that appears more than once in an item structure.
  • Inverse of the Quantity Per Product. The application uses the inverse when the Quantity Per Product for the material is a fraction, but the inverse of this quantity is an integer. Don't specify this attribute if a value is specified for the Quantity attribute in the request payload.
  • Maximum Length: 300
    Number that identifies the item.
  • Links
  • Number that defines the unique sequence of the component assigned to the work definition operation.
  • Number that indicates the execution sequence of the operation. A valid value must be a positive whole number.
  • Quantity required to make each unit of the item. The quantity is required when the unit of measure is provided.
  • Date when the structure component is effective. This must be specified only if the item appears multiple times in the item structure with different effective dates.
  • Locator in subinventory to use, by default, when the plant uses material during assembly or an operation pull.
  • Maximum Length: 10
    Value that indicates the subinventory from which this material is consumed.
  • Maximum Length: 30
    Value that indicates the supply type code. Valid values are 1 (Push), 2 (Assembly Pull), 3 (Operation Pull), 4 (Bulk), 5 (Supplier), and 6 (Phantom). If a value is not specified in the request payload, then for item structure components, the default value is the value in the item structure; for ad hoc items, the default value is the value in the item master.
  • Maximum Length: 3
    Abbreviation that identifies the unit of measure that the material uses 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.
  • Factor to use when calculating the quantity that the operation requires to accommodate component waste when it processes the item. It is recommended that you set the yield to between 0 and 1. You can set the yield to a value that is greater than 1. The application considers the yield when it calculates the required quantity according to the Include plant parameter for the component yield.
Nested Schema : workDefinitionRequests-workDefinitionHeaders-operations-item-response
Type: object
Show Source
  • Maximum Length: 30
    Value that specifies the desired action to perform on the work definition operation. Valid values include CREATE, UPDATE, or DELETE. This is a mandatory attribute.
  • Maximum Length: 30
    Name that identifies a list of values that control whether a production operator can issue more than the required quantity while manually reporting material issues. You can allow issuing more than the required quantity without any hindrance, or prevent the material issue in case of additional material issue.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then both resources and materials are automatically charged based on the supply type or the charge type setups for the operation. If the supply type is Operation Pull, the component-level issue transactions will occur when the operation is completed. If the supply type is Assembly Pull, the component level issue transactions will happen at the assembly completion event. The resource transactions are automatically done when the quantity is moved outside the operation. If false, then both resources and materials are not automatically charged. The default value is false.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the operation is a count-point operation. If an operation is a count-point operation, then you have to manually complete it. Any operations in between the count points are automatically completed; for example, backflushed, and so on. If false, then the operation is not a count-point operation. The default value is true. The last operation should always be a count-point operation.
  • Maximum Length: 255
    Names of the error messages that occurred when processing the work definition operation. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma (,) separates each message name.
  • Maximum Length: 2000
    Text of the error message, if any, that occurred when processing the work definition operation. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.
  • Fixed lead time used to calculate the operation's start and end date for the supplier operation.
  • Percent lead time computed by the manufacturing lead time calculation program and used in the cumulative lead time calculation.
  • Maximum Length: 25
    Unit of measure for the fixed or variable lead time values on the supplier operation.
  • Links
  • Maximum Length: 30
    Name that identifies a list of values that control whether operation completion should be allowed when open exceptions exist for an operation. You can allow operation completion without any hindrance, allow with a warning, or prevent the operation completion.
  • Maximum Length: 30
    Name that identifies a list of values that control whether operation completion should be allowed when less than the required quantity of material is issued. You can allow operation completion without any hindrance, allow with a warning, or prevent the operation completion.
  • Maximum Length: 240
    Value that indicates the description of the work definition operation.
  • Maximum Length: 120
    Value that indicates the name of the work definition operation.
  • Number that defines the sequence of operation execution. A valid value must be a positive whole number.
  • Maximum Length: 30
    Value that specifies the type of the operation. A list of accepted values is defined in the lookup type ORA_WIS_OPERATION_TYPE.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the operation is dependent on one or more optional components. If false, then the operation is not dependent on optional components. The default value is false. This attribute applies only to an assemble-to-order (ATO) model work definition.
  • Maximum Length: 300
    Item number that represents the value added service in a supplier operation. This is also commonly known as a partially finished assembly.
  • Percent that is used by planning for resources forecast explosion. This applies to an assemble-to-order (ATO) model work definition only.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the operation references a standard operation. If false, then the operation doesn't reference a standard operation. The default value is false. If the value is true, then a valid value must be specified for the attribute StandardOperationCode.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the work order has resequence operations. If false, then the work order doesn't have resequence operations. This attribute is associated with a feature that requires opt in.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the product is tracked by serial number while running the operation. If false, then the product is not tracked by serial number. The default value is false.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then create shipping documents for the outside processing (OSP) operation. If false, then do not create shipping documents. If the request payload doesn't specify this attribute, then the default value is from the Shippable attribute in the item master. The default value is false.
  • Maximum Length: 30
    Value that represents the user key to the standard operation.
  • Maximum Length: 360
    Name of the suggested supplier for a supplier operation.
  • Maximum Length: 15
    Value that identifies the suggested supplier site for a supplier operation.
  • Variable lead time used to calculate the operation's start and end date based on the operation quantity for the supplier operation.
  • Maximum Length: 30
    Value that indicates the user key of the work center where this operation is executed.
Nested Schema : workDefinitionRequests-workDefinitionHeaders-outputs-item-response
Type: object
Show Source
  • 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.
  • Maximum Length: 255
    Locator into which this output line is produced.
  • Maximum Length: 10
    Subinventory into which this output line is produced.
  • 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.
  • Percent cost share of this output across all outputs. This attribute is null for manually entered costs.
  • 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.
  • 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.
  • 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
  • Number that indicates the sequence of running the operation.
  • Maximum Length: 300
    Number that identifies the output item of an operation.
  • Number that indicates the sequence of this output line within this operation.
  • 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 of output expected to be produced by this operation. The quantity is required when the unit of measure is provided.
  • 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.
Nested Schema : workDefinitionRequests-workDefinitionHeaders-resources-item-response
Type: object
Show Source
  • Maximum Length: 30
    Value that specifies the desired action to perform on the resource of a work definition operation. Valid values include CREATE, UPDATE, or DELETE. This is a mandatory attribute.
  • Value that indicates the number of resources assigned to this operation. A valid value must be a positive whole number. The default value is 1 if a value is not specified during the CREATE action.
  • Maximum Length: 30
    Value that indicates whether the resource usage is fixed, such as usage per lot produced, or variable, such as usage per item produced. Valid values are: 1 (VARIABLE) or 2 (FIXED). The default value is 1 if a value is not specified during the CREATE action.
  • Maximum Length: 30
    Default Value: AUTOMATIC
    Contains one of the following values: AUTOMATIC and MANUAL. If AUTOMATIC, then the resource is charged automatically during work execution. If MANUAL, then the resource is charged manually during work execution. The default value is AUTOMATIC.
  • Value that uniquely identifies the parametric data and inspection characteristics stored in the equipment parameters flat file associated with the work definition operation resource.
  • Maximum Length: 512
    Name of the equipment parameters flat file associated with the work definition operation resource.
  • Maximum Length: 30
    Abbreviation that identifies the equipment profile associated with the work definition operation resource. This attribute is associated with a feature that requires opt in.
  • Maximum Length: 255
    Names of the error messages that occurred when processing the work definition operation resource. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma (,) separates each message name.
  • Maximum Length: 2000
    Text of the error messages, if any, that occurred when processing the work definition operation resource. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.
  • Value that indicates the inverse resource usage rate. Don't specify this attribute if a value is specified for the UsageRate attribute.
  • Links
  • Number that defines the sequence of operation execution. A valid value must be a positive whole number.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the resource is the principal resource among the group of simultaneous resources. When two or more resources are running in parallel; for example, simultaneous resources that have the same sequence number, only one of them must be marked as the principal or the primary resource. Planning will error if the principal resource is not available when checking for capacity. If false, then this resource is not the principal resource. The default value is false.
  • Maximum Length: 30
    Abbreviation that identifies the job profile associated with the work definition operation resource. This attribute is associated with a feature that requires opt in.
  • Maximum Length: 300
    The name of the program file to be associated with an automation equipment resource in the work definition. This program file name must be associated to the automation equipment resource in the resource definition.
  • Maximum Length: 30
    Value that indicates the activity this production resource is going to perform at this operation. Valid values include ORA_RUN, ORA_SETUP, and ORA_TEAR_DOWN. A list of accepted values is defined in the lookup type ORA_WIS_RESOURCE_ACTIVITY. The default value is ORA_RUN.
  • Maximum Length: 30
    Value that indicates the resource assigned to the operation.
  • Number that defines the sequence of the resource used in the operation. A valid value must be a positive whole number.
  • Maximum Length: 30
    Default Value: NO
    Contains one of the following values: YES and NO. If YES, then resource is scheduled. If NO, then resource is not scheduled. The default value is NO if no value is specified during the CREATE action.
  • Resource usage rate to yield one unit of product. The default value is 1 if a value is not specified during the CREATE action.
Links
ATOMaterials
Parameters:
  • workDefinitionHeadersUniqID: $request.path.workDefinitionHeadersUniqID
  • workDefinitionRequestsUniqID: $request.path.workDefinitionRequestsUniqID
The ATO Materials resource manages the materials for assemble-to-order (ATO) enabled items.
alternateResources
Parameters:
  • workDefinitionHeadersUniqID: $request.path.workDefinitionHeadersUniqID
  • workDefinitionRequestsUniqID: $request.path.workDefinitionRequestsUniqID
The Alternate Resources resource manages the alternate resources of a resource.
materials
Parameters:
  • workDefinitionHeadersUniqID: $request.path.workDefinitionHeadersUniqID
  • workDefinitionRequestsUniqID: $request.path.workDefinitionRequestsUniqID
The Materials resource manages the materials of a work definition operation.
operations
Parameters:
  • workDefinitionHeadersUniqID: $request.path.workDefinitionHeadersUniqID
  • workDefinitionRequestsUniqID: $request.path.workDefinitionRequestsUniqID
The Operations resource manages the operations of a work definition.
outputs
Parameters:
  • workDefinitionHeadersUniqID: $request.path.workDefinitionHeadersUniqID
  • workDefinitionRequestsUniqID: $request.path.workDefinitionRequestsUniqID
The Outputs resource manages the outputs of a work definition operation.
resources
Parameters:
  • workDefinitionHeadersUniqID: $request.path.workDefinitionHeadersUniqID
  • workDefinitionRequestsUniqID: $request.path.workDefinitionRequestsUniqID
The Resources resource manages the resources of a work definition operation.
Back to Top