Jump to

• Request
• Response

GET action not supported

get

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

Request

Path Parameters

• 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.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey
    Finder Variables:
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ActionCode; string; Value that specifies the desired action to perform on the work definition. Valid values include CREATE, UPDATE, or DELETE. This is a mandatory attribute.
  • BatchQuantity; number; Batch quantity for which the work definition is defined.
  • BatchUOMCode; string; Unit of measure of the batch quantity.
  • CompletionLocator; string; Locator into which the product completion is posted.
  • CompletionSubinventoryCode; string; Value that indicates the default subinventory where the primary product is yielded.
  • CostingBatchOutputSize; number; 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.
  • 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; 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.
  • ErrorMessages; string; 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.
  • ItemNumber; string; Number that represents the user key to the top level, final assembly, subassembly, or model item that belongs to an organization.
  • ItemStructureName; string; Unique name given to a specific variation of an item structure type.
  • MaintenanceCode; string; Abbreviation that identifies the user-defined maintenance work definition.
  • MaintenanceDescription; string; Description of the maintenance work definition name.
  • MaintenanceName; string; Name of the maintenance work definition.
  • MinimumTransferQuantity; number; Minimum transfer quantity defined for an item to schedule overlapping and sequential operations of work orders.
  • OrganizationCode; string; Value that identifies the manufacturing plant to which this work definition belongs.
  • PreassignLotFlag; boolean; 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.
  • ProcessName; string; Name of the process. This attribute is applicable only when WorkMethodCode is PROCESS_MANUFACTURING.
  • ProductionPriority; number; 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.
  • SerialTrackingFlag; boolean; 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.
  • StartDate; string; Date when the work definition version is effective.
  • StatusCode; string; Value that indicates the status of the work definition. Valid values are Active and Inactive. The default value is Active.
  • TransformFromItemNumber; string; Number that identifies the assembly item being transformed to a new assembly item on a transform work definition.
  • VersionNumber; string; Number that indicates the version of the work definition.
  • WorkDefinitionCode; string; Value that indicates the user-defined work definition code.
  • WorkDefinitionId; integer; Value that uniquely identifies the work definition. Its value is an application generated.
  • WorkMethodCode; string; Value that represents the user key to the work method.
  • WorkOrderSubType; string; Subtype of default work order used during work order creation.
  • WorkOrderType; string; Type of default work order used during work order creation.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context:
  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.

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 : workDefinitionRequests-workDefinitionHeaders

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/workDefinitionRequests-workDefinitionHeaders-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object workDefinitionRequests-workDefinitionHeaders-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/workDefinitionRequests-workDefinitionHeaders-item-response"
    }
}

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

Type: object

Show Source

• ActionCode: string
  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.
• alternateResources: array Alternate Resources
  Title: Alternate Resources

  The Alternate Resources resource manages the alternate resources of a resource.
• ATOMaterials: array ATO Materials
  Title: ATO Materials

  The ATO Materials resource manages the materials for assemble-to-order (ATO) enabled items.
• BatchQuantity: number
  Batch quantity for which the work definition is defined.
• BatchUOMCode: string
  Maximum Length: 3

  Unit of measure of the batch quantity.
• CompletionLocator: string
  Maximum Length: 255

  Locator into which the product completion is posted.
• CompletionSubinventoryCode: string
  Maximum Length: 10

  Value that indicates the default subinventory where the primary product is yielded.
• CostingBatchOutputSize: number
  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.
• 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 request. 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 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.
• ItemNumber: string
  Maximum Length: 300

  Number that represents the user key to the top level, final assembly, subassembly, or model item that belongs to an organization.
• ItemStructureName: string
  Maximum Length: 80

  Unique name given to a specific variation of an item structure type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaintenanceCode: string
  Maximum Length: 30

  Abbreviation that identifies the user-defined maintenance work definition.
• MaintenanceDescription: string
  Maximum Length: 240

  Description of the maintenance work definition name.
• MaintenanceName: string
  Maximum Length: 120

  Name of the maintenance work definition.
• materials: array Materials
  Title: Materials

  The Materials resource manages the materials of a work definition operation.
• MinimumTransferQuantity: number
  Minimum transfer quantity defined for an item to schedule overlapping and sequential operations of work orders.
• operations: array Operations
  Title: Operations

  The Operations resource manages the operations of a work definition.
• OrganizationCode: string
  Maximum Length: 30

  Value that identifies the manufacturing plant to which this work definition belongs.
• outputs: array Outputs
  Title: Outputs

  The Outputs resource manages the outputs of a work definition operation.
• PreassignLotFlag: boolean
  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.
• ProcessName: string
  Maximum Length: 120

  Name of the process. This attribute is applicable only when WorkMethodCode is PROCESS_MANUFACTURING.
• ProductionPriority: number
  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: array Resources
  Title: Resources

  The Resources resource manages the resources of a work definition operation.
• SerialTrackingFlag: boolean
  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.
• StartDate: string (date-time)
  Date when the work definition version is effective.
• StatusCode: string
  Maximum Length: 30

  Value that indicates the status of the work definition. Valid values are Active and Inactive. The default value is Active.
• TransformFromItemNumber: string
  Maximum Length: 300

  Number that identifies the assembly item being transformed to a new assembly item on a transform work definition.
• VersionNumber: string
  Maximum Length: 10

  Number that indicates the version of the work definition.
• WorkDefinitionCode: string
  Maximum Length: 30

  Value that indicates the user-defined work definition code.
• WorkDefinitionId: integer (int64)
  Value that uniquely identifies the work definition. Its value is an application generated.
• WorkMethodCode: string
  Maximum Length: 30

  Value that represents the user key to the work method.
• WorkOrderSubType: string
  Maximum Length: 30

  Subtype of default work order used during work order creation.
• WorkOrderType: string
  Maximum Length: 30

  Type of default work order used during work order creation.

{
    "type":"object",
    "properties":{
        "outputs":{
            "title":"Outputs",
            "type":"array",
            "description":"The Outputs resource manages the outputs of a work definition operation.",
            "items":{
                "$ref":"#/components/schemas/workDefinitionRequests-workDefinitionHeaders-outputs-item-response"
            }
        },
        "ProcessName":{
            "maxLength":"120",
            "type":"string",
            "description":"Name of the process. This attribute is applicable only when WorkMethodCode is PROCESS_MANUFACTURING.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkOrderType":{
            "maxLength":"30",
            "type":"string",
            "description":"Type of default work order used during work order creation.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkDefinitionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work definition. Its value is an application generated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that specifies the desired action to perform on the work definition. Valid values include CREATE, UPDATE, or DELETE. This is a mandatory attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "WorkOrderSubType":{
            "maxLength":"30",
            "type":"string",
            "description":"Subtype of default work order used during work order creation.",
            "nullable":true,
            "x-queryable":true
        },
        "TransformFromItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Number that identifies the assembly item being transformed to a new assembly item on a transform work definition.",
            "nullable":true,
            "x-queryable":true
        },
        "ATOMaterials":{
            "title":"ATO Materials",
            "type":"array",
            "description":"The ATO Materials resource manages the materials for assemble-to-order (ATO) enabled items.",
            "items":{
                "$ref":"#/components/schemas/workDefinitionRequests-workDefinitionHeaders-ATOMaterials-item-response"
            }
        },
        "StatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates the status of the work definition. Valid values are Active and Inactive. The default value is Active.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the work definition version is effective.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CostingBatchOutputSize":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumTransferQuantity":{
            "type":"number",
            "description":"Minimum transfer quantity defined for an item to schedule overlapping and sequential operations of work orders.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Number that represents the user key to the top level, final assembly, subassembly, or model item that belongs to an organization.",
            "nullable":true,
            "x-queryable":true
        },
        "operations":{
            "title":"Operations",
            "type":"array",
            "description":"The Operations resource manages the operations of a work definition.",
            "items":{
                "$ref":"#/components/schemas/workDefinitionRequests-workDefinitionHeaders-operations-item-response"
            }
        },
        "alternateResources":{
            "title":"Alternate Resources",
            "type":"array",
            "description":"The Alternate Resources resource manages the alternate resources of a resource.",
            "items":{
                "$ref":"#/components/schemas/workDefinitionRequests-workDefinitionHeaders-alternateResources-item-response"
            }
        },
        "OrganizationCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the manufacturing plant to which this work definition belongs.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MaintenanceName":{
            "maxLength":"120",
            "type":"string",
            "description":"Name of the maintenance work definition.",
            "nullable":true,
            "x-queryable":true
        },
        "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
        },
        "PreassignLotFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "CompletionLocator":{
            "maxLength":"255",
            "type":"string",
            "description":"Locator into which the product completion is posted.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMessageNames":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "resources":{
            "title":"Resources",
            "type":"array",
            "description":"The Resources resource manages the resources of a work definition operation.",
            "items":{
                "$ref":"#/components/schemas/workDefinitionRequests-workDefinitionHeaders-resources-item-response"
            }
        },
        "CompletionSubinventoryCode":{
            "maxLength":"10",
            "type":"string",
            "description":"Value that indicates the default subinventory where the primary product is yielded.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkMethodCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that represents the user key to the work method.",
            "nullable":true,
            "x-queryable":true
        },
        "BatchQuantity":{
            "type":"number",
            "description":"Batch quantity for which the work definition is defined.",
            "nullable":true,
            "x-queryable":true
        },
        "MaintenanceDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of the maintenance work definition name.",
            "nullable":true,
            "x-queryable":true
        },
        "BatchUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Unit of measure of the batch quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "VersionNumber":{
            "maxLength":"10",
            "type":"string",
            "description":"Number that indicates the version of the work definition.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMessages":{
            "maxLength":"2000",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemStructureName":{
            "maxLength":"80",
            "type":"string",
            "description":"Unique name given to a specific variation of an item structure type.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkDefinitionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates the user-defined work definition code.",
            "nullable":true,
            "x-queryable":true
        },
        "materials":{
            "title":"Materials",
            "type":"array",
            "description":"The Materials resource manages the materials of a work definition operation.",
            "items":{
                "$ref":"#/components/schemas/workDefinitionRequests-workDefinitionHeaders-materials-item-response"
            }
        },
        "SerialTrackingFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductionPriority":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "MaintenanceCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the user-defined maintenance work definition.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Alternate Resources

Type: array

Title: Alternate Resources

The Alternate Resources resource manages the alternate resources of a resource.

Show Source

• Array of: object workDefinitionRequests-workDefinitionHeaders-alternateResources-item-response

{
    "title":"Alternate Resources",
    "type":"array",
    "description":"The Alternate Resources resource manages the alternate resources of a resource.",
    "items":{
        "$ref":"#/components/schemas/workDefinitionRequests-workDefinitionHeaders-alternateResources-item-response"
    }
}

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

• Array of: object workDefinitionRequests-workDefinitionHeaders-ATOMaterials-item-response

{
    "title":"ATO Materials",
    "type":"array",
    "description":"The ATO Materials resource manages the materials for assemble-to-order (ATO) enabled items.",
    "items":{
        "$ref":"#/components/schemas/workDefinitionRequests-workDefinitionHeaders-ATOMaterials-item-response"
    }
}

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 : Materials

Type: array

Title: Materials

The Materials resource manages the materials of a work definition operation.

Show Source

• Array of: object workDefinitionRequests-workDefinitionHeaders-materials-item-response

{
    "title":"Materials",
    "type":"array",
    "description":"The Materials resource manages the materials of a work definition operation.",
    "items":{
        "$ref":"#/components/schemas/workDefinitionRequests-workDefinitionHeaders-materials-item-response"
    }
}

Nested Schema : Operations

Type: array

Title: Operations

The Operations resource manages the operations of a work definition.

Show Source

• Array of: object workDefinitionRequests-workDefinitionHeaders-operations-item-response

{
    "title":"Operations",
    "type":"array",
    "description":"The Operations resource manages the operations of a work definition.",
    "items":{
        "$ref":"#/components/schemas/workDefinitionRequests-workDefinitionHeaders-operations-item-response"
    }
}

Nested Schema : Outputs

Type: array

Title: Outputs

The Outputs resource manages the outputs of a work definition operation.

Show Source

• Array of: object workDefinitionRequests-workDefinitionHeaders-outputs-item-response

{
    "title":"Outputs",
    "type":"array",
    "description":"The Outputs resource manages the outputs of a work definition operation.",
    "items":{
        "$ref":"#/components/schemas/workDefinitionRequests-workDefinitionHeaders-outputs-item-response"
    }
}

Nested Schema : Resources

Type: array

Title: Resources

The Resources resource manages the resources of a work definition operation.

Show Source

• Array of: object workDefinitionRequests-workDefinitionHeaders-resources-item-response

{
    "title":"Resources",
    "type":"array",
    "description":"The Resources resource manages the resources of a work definition operation.",
    "items":{
        "$ref":"#/components/schemas/workDefinitionRequests-workDefinitionHeaders-resources-item-response"
    }
}

Nested Schema : workDefinitionRequests-workDefinitionHeaders-alternateResources-item-response

Type: object

Show Source

• ActionCode: string
  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.
• AlternateResourceCode: string
  Maximum Length: 30

  Value that indicates the alternate resource.
• BasisType: string
  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.
• EquipmentParameterFileContent: string (byte)
  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.
• EquipmentParameterFileName: string
  Maximum Length: 512

  Name of the equipment parameters flat file associated with the work definition operation alternate resource.
• ErrorMessageNames: string
  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.
• ErrorMessages: string
  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.
• InverseUsage: number
  Value that indicates the inverse alternate resource usage rate.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OperationSequenceNumber: number
  Number that indicates the execution sequence of the operation. A valid value must be a positive whole number.
• PriorityRanking: 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.
• ProgramFileName: string
  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.
• ResourceCode: string
  Maximum Length: 30

  Value that represents the resource code of the resource for which this alternate resource is applicable.
• ResourceSequenceNumber: number
  Number that defines the sequence of the resource used in the operation. A valid value must be a positive whole number.
• UnitsAssigned: 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.
• UsageRate: number
  The alternate resource usage rate to yield one unit of product. The default value is from the primary resource.

{
    "type":"object",
    "properties":{
        "ResourceCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that represents the resource code of the resource for which this alternate resource is applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramFileName":{
            "maxLength":"300",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceSequenceNumber":{
            "type":"number",
            "description":"Number that defines the sequence of the resource used in the operation. A valid value must be a positive whole number.",
            "nullable":true,
            "x-queryable":true
        },
        "InverseUsage":{
            "type":"number",
            "description":"Value that indicates the inverse alternate resource usage rate.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "ErrorMessageNames":{
            "maxLength":"225",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitsAssigned":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "EquipmentParameterFileName":{
            "maxLength":"512",
            "type":"string",
            "description":"Name of the equipment parameters flat file associated with the work definition operation alternate resource.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMessages":{
            "maxLength":"2000",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "BasisType":{
            "maxLength":"30",
            "type":"string",
            "description":"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:\n1 (VARIABLE), 2 (FIXED). If the value is not specified during the CREATE action, the default value is 1.",
            "nullable":true,
            "x-queryable":true
        },
        "UsageRate":{
            "type":"number",
            "description":"The alternate resource usage rate to yield one unit of product. The default value is from the primary resource.",
            "nullable":true,
            "x-queryable":true
        },
        "PriorityRanking":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "AlternateResourceCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates the alternate resource.",
            "nullable":true,
            "x-queryable":true
        },
        "OperationSequenceNumber":{
            "type":"number",
            "description":"Number that indicates the execution sequence of the operation. A valid value must be a positive whole number.",
            "nullable":true,
            "x-queryable":true
        },
        "EquipmentParameterFileContent":{
            "type":"string",
            "description":"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.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "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 : 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 : workDefinitionRequests-workDefinitionHeaders-ATOMaterials-item-response

Type: object

Show Source

• ActionCode: string
  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.
• ComponentHierarchy: string
  Maximum Length: 4000

  Value that indicates the hierarchy in the item structure at which the material is assigned.
• ErrorMessageNames: string
  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.
• ErrorMessages: string
  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.
• FindNumber: number
  Unique identifier of a component that appears more than once in an item structure.
• ItemNumber: string
  Maximum Length: 300

  Number that identifies the item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaterialSequenceNumber: number
  Number that indicates the unique sequence of the component assigned to the work definition operation.
• OperationSequenceNumber: number
  Number that indicates the execution sequence of the operation. A valid value must be a positive whole number.
• StartDate: string (date-time)
  Date when the material assignment begins.
• SupplyLocator: string
  Maximum Length: 255

  Locator in subinventory to use, by default, when the plant uses material during assembly or an operation pull.
• SupplySubinventory: string
  Maximum Length: 10

  Value that indicates the subinventory from which this material is consumed.
• SupplyType: string
  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.

{
    "type":"object",
    "properties":{
        "SupplySubinventory":{
            "maxLength":"10",
            "type":"string",
            "description":"Value that indicates the subinventory from which this material is consumed.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "ErrorMessageNames":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplyLocator":{
            "maxLength":"255",
            "type":"string",
            "description":"Locator in subinventory to use, by default, when the plant uses material during assembly or an operation pull.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMessages":{
            "maxLength":"2000",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the material assignment begins.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentHierarchy":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that indicates the hierarchy in the item structure at which the material is assigned.",
            "nullable":true,
            "x-queryable":true
        },
        "FindNumber":{
            "type":"number",
            "description":"Unique identifier of a component that appears more than once in an item structure.",
            "nullable":true,
            "x-queryable":true
        },
        "MaterialSequenceNumber":{
            "type":"number",
            "description":"Number that indicates the unique sequence of the component assigned to the work definition operation.",
            "nullable":true,
            "x-queryable":true
        },
        "OperationSequenceNumber":{
            "type":"number",
            "description":"Number that indicates the execution sequence of the operation. A valid value must be a positive whole number.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplyType":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates the supply type. Valid values are 1 (Push), 2 (Assembly Pull), 3 (Operation Pull), 4 (Bulk), 5 (Supplier), and 6 (Phantom). \nIf 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.",
            "nullable":true,
            "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 : workDefinitionRequests-workDefinitionHeaders-materials-item-response

Type: object

Show Source

• ActionCode: string
  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.
• AdhocItemFlag: boolean
  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.
• BasisType: string
  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.
• ErrorMessageNames: string
  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.
• ErrorMessages: string
  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.
• FindNumber: number
  Unique identifier of a component that appears more than once in an item structure.
• InverseQuantity: number
  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.
• ItemNumber: string
  Maximum Length: 300

  Number that identifies the item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaterialSequenceNumber: number
  Number that defines the unique sequence of the component assigned to the work definition operation.
• OperationSequenceNumber: number
  Number that indicates the execution sequence of the operation. A valid value must be a positive whole number.
• Quantity: number
  Quantity required to make each unit of the item. The quantity is required when the unit of measure is provided.
• StartDate: string (date-time)
  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.
• SupplyLocator: string
  Locator in subinventory to use, by default, when the plant uses material during assembly or an operation pull.
• SupplySubinventory: string
  Maximum Length: 10

  Value that indicates the subinventory from which this material is consumed.
• SupplyType: string
  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.
• UOMCode: string
  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.
• YieldFactor: number
  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.

{
    "type":"object",
    "properties":{
        "SupplySubinventory":{
            "maxLength":"10",
            "type":"string",
            "description":"Value that indicates the subinventory from which this material is consumed.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "ErrorMessageNames":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity required to make each unit of the item. The quantity is required when the unit of measure is provided.",
            "nullable":true,
            "x-queryable":true
        },
        "InverseQuantity":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplyLocator":{
            "type":"string",
            "description":"Locator in subinventory to use, by default, when the plant uses material during assembly or an operation pull.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMessages":{
            "maxLength":"2000",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":true,
            "x-queryable":true
        },
        "BasisType":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "YieldFactor":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "FindNumber":{
            "type":"number",
            "description":"Unique identifier of a component that appears more than once in an item structure.",
            "nullable":true,
            "x-queryable":true
        },
        "MaterialSequenceNumber":{
            "type":"number",
            "description":"Number that defines the unique sequence of the component assigned to the work definition operation.",
            "nullable":true,
            "x-queryable":true
        },
        "OperationSequenceNumber":{
            "type":"number",
            "description":"Number that indicates the execution sequence of the operation. A valid value must be a positive whole number.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplyType":{
            "maxLength":"30",
            "type":"string",
            "description":"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).\nIf 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.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AdhocItemFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"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.",
            "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 : workDefinitionRequests-workDefinitionHeaders-operations-item-response

Type: object

Show Source

• ActionCode: string
  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.
• AddlMtlAtManualIssue: string
  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.
• AutoTransactFlag: boolean
  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.
• CountPointOperationFlag: boolean
  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.
• ErrorMessageNames: string
  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.
• ErrorMessages: string
  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.
• FixedLeadTime: number
  Fixed lead time used to calculate the operation's start and end date for the supplier operation.
• LeadTimePercent: number
  Percent lead time computed by the manufacturing lead time calculation program and used in the cumulative lead time calculation.
• LeadTimeUnitOfMeasure: string
  Maximum Length: 25

  Unit of measure for the fixed or variable lead time values on the supplier operation.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OperationComplWithOpenExceptions: string
  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.
• OperationComplWithUnderIssue: string
  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.
• OperationDescription: string
  Maximum Length: 240

  Value that indicates the description of the work definition operation.
• OperationName: string
  Maximum Length: 120

  Value that indicates the name of the work definition operation.
• OperationSequenceNumber: number
  Number that defines the sequence of operation execution. A valid value must be a positive whole number.
• OperationType: string
  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.
• OperationYield: number
  Indicates the yield factor of an operation that represents the percentage of the starting quantity that's yielded on completion of the operation.
• OptionDependentFlag: boolean
  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.
• OSPItemNumber: string
  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.
• PlanningPercent: number
  Percent that is used by planning for resources forecast explosion. This applies to an assemble-to-order (ATO) model work definition only.
• ReferencedFlag: boolean
  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.
• ResequenceFlag: boolean
  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.
• SerialTrackingFlag: boolean
  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.
• ShippingDocumentsFlag: boolean
  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.
• StandardOperationCode: string
  Maximum Length: 30

  Value that represents the user key to the standard operation.
• SupplierName: string
  Maximum Length: 360

  Name of the suggested supplier for a supplier operation.
• SupplierSiteCode: string
  Maximum Length: 15

  Value that identifies the suggested supplier site for a supplier operation.
• VariableLeadTime: number
  Variable lead time used to calculate the operation's start and end date based on the operation quantity for the supplier operation.
• WorkCenterCode: string
  Maximum Length: 30

  Value that indicates the user key of the work center where this operation is executed.

{
    "type":"object",
    "properties":{
        "OperationYield":{
            "type":"number",
            "description":"Indicates the yield factor of an operation that represents the percentage of the starting quantity that's yielded on completion of the operation.",
            "nullable":true,
            "x-queryable":true
        },
        "OSPItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Item number that represents the value added service in a supplier operation. This is also commonly known as a partially finished assembly.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "LeadTimeUnitOfMeasure":{
            "maxLength":"25",
            "type":"string",
            "description":"Unit of measure for the fixed or variable lead time values on the supplier operation.",
            "nullable":true,
            "x-queryable":true
        },
        "FixedLeadTime":{
            "type":"number",
            "description":"Fixed lead time used to calculate the operation's start and end date for the supplier operation.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningPercent":{
            "type":"number",
            "description":"Percent that is used by planning for resources forecast explosion. This applies to an assemble-to-order (ATO) model work definition only.",
            "nullable":true,
            "x-queryable":true
        },
        "ShippingDocumentsFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "OptionDependentFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "LeadTimePercent":{
            "type":"number",
            "description":"Percent lead time computed by the manufacturing lead time calculation program and used in the cumulative lead time calculation.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierSiteCode":{
            "maxLength":"15",
            "type":"string",
            "description":"Value that identifies the suggested supplier site for a supplier operation.",
            "nullable":true,
            "x-queryable":true
        },
        "OperationComplWithOpenExceptions":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "CountPointOperationFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AddlMtlAtManualIssue":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ReferencedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkCenterCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates the user key of the work center where this operation is executed.",
            "nullable":true,
            "x-queryable":true
        },
        "VariableLeadTime":{
            "type":"number",
            "description":"Variable lead time used to calculate the operation's start and end date based on the operation quantity for the supplier operation.",
            "nullable":true,
            "x-queryable":true
        },
        "StandardOperationCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that represents the user key to the standard operation.",
            "nullable":true,
            "x-queryable":true
        },
        "OperationName":{
            "maxLength":"120",
            "type":"string",
            "description":"Value that indicates the name of the work definition operation.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMessageNames":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "OperationDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"Value that indicates the description of the work definition operation.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMessages":{
            "maxLength":"2000",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "AutoTransactFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierName":{
            "maxLength":"360",
            "type":"string",
            "description":"Name of the suggested supplier for a supplier operation.",
            "nullable":true,
            "x-queryable":true
        },
        "OperationComplWithUnderIssue":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "OperationSequenceNumber":{
            "type":"number",
            "description":"Number that defines the sequence of operation execution. A valid value must be a positive whole number.",
            "nullable":true,
            "x-queryable":true
        },
        "SerialTrackingFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ResequenceFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "OperationType":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that specifies the type of the operation. A list of accepted values is defined in the lookup type ORA_WIS_OPERATION_TYPE.",
            "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 : 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 : workDefinitionRequests-workDefinitionHeaders-resources-item-response

Type: object

Show Source

• ActionCode: string
  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.
• AssignedUnits: number
  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.
• BasisType: string
  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.
• ChargeType: string
  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.
• EquipmentParameterFileContent: string (byte)
  Value that uniquely identifies the parametric data and inspection characteristics stored in the equipment parameters flat file associated with the work definition operation resource.
• EquipmentParameterFileName: string
  Maximum Length: 512

  Name of the equipment parameters flat file associated with the work definition operation resource.
• EquipmentProfileCode: string
  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.
• ErrorMessageNames: string
  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.
• ErrorMessages: string
  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.
• InverseUsageRate: number
  Value that indicates the inverse resource usage rate. Don't specify this attribute if a value is specified for the UsageRate attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OperationSequenceNumber: number
  Number that defines the sequence of operation execution. A valid value must be a positive whole number.
• PrincipalFlag: boolean
  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.
• ProfileCode: string
  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.
• ProgramFileName: string
  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.
• ResourceActivityCode: string
  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.
• ResourceCode: string
  Maximum Length: 30

  Value that indicates the resource assigned to the operation.
• ResourceSequenceNumber: number
  Number that defines the sequence of the resource used in the operation. A valid value must be a positive whole number.
• ScheduledIndicator: string
  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.
• UsageRate: number
  Resource usage rate to yield one unit of product. The default value is 1 if a value is not specified during the CREATE action.

{
    "type":"object",
    "properties":{
        "ResourceCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates the resource assigned to the operation.",
            "nullable":true,
            "x-queryable":true
        },
        "InverseUsageRate":{
            "type":"number",
            "description":"Value that indicates the inverse resource usage rate. Don't specify this attribute if a value is specified for the UsageRate attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceActivityCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramFileName":{
            "maxLength":"300",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceSequenceNumber":{
            "type":"number",
            "description":"Number that defines the sequence of the resource used in the operation. A valid value must be a positive whole number.",
            "nullable":true,
            "x-queryable":true
        },
        "EquipmentProfileCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the equipment profile associated with the work definition operation resource. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "ErrorMessageNames":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ProfileCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the job profile associated with the work definition operation resource. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-queryable":true
        },
        "EquipmentParameterFileName":{
            "maxLength":"512",
            "type":"string",
            "description":"Name of the equipment parameters flat file associated with the work definition operation resource.",
            "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 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.",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduledIndicator":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"NO",
            "x-queryable":true
        },
        "AssignedUnits":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "BasisType":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "UsageRate":{
            "type":"number",
            "description":"Resource usage rate to yield one unit of product. The default value is 1 if a value is not specified during the CREATE action.",
            "nullable":true,
            "x-queryable":true
        },
        "PrincipalFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeType":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"AUTOMATIC",
            "x-queryable":true
        },
        "OperationSequenceNumber":{
            "type":"number",
            "description":"Number that defines the sequence of operation execution. A valid value must be a positive whole number.",
            "nullable":true,
            "x-queryable":true
        },
        "EquipmentParameterFileContent":{
            "type":"string",
            "description":"Value that uniquely identifies the parametric data and inspection characteristics stored in the equipment parameters flat file associated with the work definition operation resource.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "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"
    }
}

Back to Top