Get one work definition
get
/fscmRestApi/resources/11.13.18.05/workDefinitions/{WorkDefinitionId}
Request
Path Parameters
-
WorkDefinitionId(required): integer(int64)
Value that uniquely identifies the work definition. It is a primary key that the application generates when it creates the work definition.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : workDefinitions-item-response
Type:
Show Source
object
-
BatchQuantity: number
Title:
Batch Quantity
Quantity of the batch. -
BatchUOMCode: string
Title:
UOM
Maximum Length:3
Unit of measure of the batch. -
CompletionLocator: string
Read Only:
true
Maximum Length:255
Value that indicates the completion locator to use by default when considering the work order for product completion. -
CompletionLocatorId: integer
(int64)
Title:
Completion Locator
Read Only:true
Value that uniquely identifies the completion locator. -
CompletionSubinventoryCode: string
Title:
Completion Subinventory
Read Only:true
Maximum Length:10
Abbreviation that indicates the completion subinventory to use by default when considering the work order for product completion. -
CostingBatchOutputSize: number
Title:
Costing Batch Output Size
Read Only:true
Assumed batch size for the purposes of computing a standard cost. -
CostingPriority: number
Title:
Costing Priority
Read Only:true
Priority to use when determining which work definition to use when rolling up costs during a planning scenario. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created this record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the record was created. -
EffectiveFromDate: string
(date)
Read Only:
true
Date and time when the work definition becomes available. -
EffectiveToDate: string
(date)
Read Only:
true
Date and time when the work definition is no longer available. -
InactiveDate: string
(date)
Read Only:
true
Date when the work definition became inactive. -
InventoryItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item, product, or assembly in the inventory organization. -
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the inventory item. -
ItemNumber: string
Read Only:
true
Maximum Length:300
Number that identifies the inventory item. -
ItemStructureId: integer
Read Only:
true
Value that uniquely identifies the item structure used to define material requirements. -
ItemStructureName: string
Title:
Display Name
Read Only:true
Maximum Length:80
Description of the item structure. -
ItemStructureType: string
Title:
Internal Name
Read Only:true
Maximum Length:30
Type of the item structure. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MinimumTransferQuantity: number
Title:
Minimum Transfer Quantity
Minimum transfer quantity defined for an item to schedule overlapping and sequential operations of work orders. -
OrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the inventory organization that comes enabled for manufacturing. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory organization that comes enabled for manufacturing. It is a primary key that the application generates when it creates the inventory organization. -
PreassignLotFlag: boolean
Title:
Preassign Lots
Read Only:true
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 preassigned lot numbers can't be associated with a 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. This attribute does not have a default value. This attribute is associated with a feature that requires opt in. -
ProcessName: string
Title:
Name
Maximum Length:120
Name of the process. This is unique across all work definitions in the inventory organizations. -
ProductionPriority: number
Title:
Production Priority
Read Only:true
Priority that planning uses to determine which work definition to use when planning a manufacturing run. -
SeededFlag: boolean
Read Only:
true
Maximum Length:1
Default Value:false
Contains one of the following values: true or false. If true, then the work definition name is predefined. If false, then the work definition name is user defined. This attribute does not have a default value. -
SerialTrackingFlag: boolean
Read Only:
true
Maximum Length:1
Default Value:false
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. This attribute does not have a default value. -
Status: string
Read Only:
true
Maximum Length:255
Status of the work definition. Valid values are Active and Inactive. -
StatusCode: string
Title:
Work Definition Status
Read Only:true
Maximum Length:30
Default Value:ACTIVE
Abbreviation that identifies the work definition status. -
SystemGeneratedFlag: boolean
Title:
Automatic
Read Only:true
Maximum Length:1
Default Value:false
Contains one of the following values: true or false. If true, then the work definition is automatically created by the application. If false, then the work definition is manually created. This attribute does not have a default value. -
TransformFromItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the assembly item that is being transformed to a new assembly item on a transform work definition. -
TransformFromItemNumber: string
Read Only:
true
Maximum Length:300
Number that identifies the transfer item. -
UsedInPlanningFlag: boolean
Read Only:
true
Maximum Length:1
Default Value:false
Contains one of the following values: true or false. If true, then the work definition using the associated work definition name is used for planning. If false, then planning cannot use the work definition. This attribute does not have a default value. -
VersionEffectiveFromDate: string
(date-time)
Title:
Start Date
Read Only:true
Date and time when the work definition version becomes available. -
VersionEffectiveToDate: string
(date-time)
Title:
End Date
Read Only:true
Date and time when the work definition version is no longer available. -
VersionNumber: string
Title:
Version
Read Only:true
Maximum Length:10
Number that indicates the version of the work definition. -
WorkDefinitionAttachment: array
Attachments for Work Definitions
Title:
Attachments for Work Definitions
The Attachments for Work Definitions resource gets the attachments that the work definition references. -
WorkDefinitionCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the work definition. -
WorkDefinitionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work definition. It is a primary key that the application generates when it creates the work definition. -
WorkDefinitionMaterial: array
Work Definition Materials
Title:
Work Definition Materials
The Work Definition Materials resource gets all the materials of a work definition across the operations. -
WorkDefinitionName: string
Read Only:
true
Maximum Length:80
Name of the work definition. The work definition name describes different ways to make an item. More than one manufacturing process might make the item. The application uses the predefined main work definition to create a work order, by default. -
WorkDefinitionNameDescription: string
Read Only:
true
Maximum Length:240
Description of the work definition. -
WorkDefinitionNameId: integer
(int64)
Title:
Work Definition Name
Read Only:true
Value that uniquely identifies the work definition name. It is a primary key that the application generates when it creates a work definition name. -
WorkDefinitionOperation: array
Work Definition Operations
Title:
Work Definition Operations
The Operations resource gets the operations for the work definition. -
WorkDefinitionOutput: array
Work Definition Outputs
Title:
Work Definition Outputs
The Work Definition Outputs resource gets all the outputs of a work definition across the operations. -
WorkDefinitionResource: array
Work Definition Resources
Title:
Work Definition Resources
The Work Definition Resources resource gets all the resources of a work definition across the operations. -
WorkDefinitionType: string
Read Only:
true
Maximum Length:255
Description of the work definition type. -
WorkDefinitionTypeCode: string
Title:
Type
Read Only:true
Maximum Length:30
Default Value:STANDARD
Abbreviation that identifies the type of work definition. A list of accepted values is defined in the lookup type ORA_WIS_WORK_DEFINITION_TYPE. -
WorkDefinitionVersionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work definition version. It is a primary key that the application generates when it creates a version of a work definition. A work definition version defines the dates when the production process is available. -
WorkMethodCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the user key to the work method. -
WorkMethodDescription: string
Read Only:
true
Maximum Length:240
Description of the work method. -
WorkMethodId: integer
(int64)
Read Only:
true
Value that identifies the work method for which this work definition is applicable. -
WorkMethodName: string
Title:
Work Method
Read Only:true
Maximum Length:80
Name of the work method. -
WorkOrderSubType: string
Title:
Subtype
Read Only:true
Maximum Length:80
Subtype of default work order used during work order creation. -
WorkOrderType: string
Title:
Type
Read Only:true
Maximum Length:80
Type of default work order used during work order creation.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Attachments for Work Definitions
Type:
array
Title:
Attachments for Work Definitions
The Attachments for Work Definitions resource gets the attachments that the work definition references.
Show Source
Nested Schema : Work Definition Materials
Type:
array
Title:
Work Definition Materials
The Work Definition Materials resource gets all the materials of a work definition across the operations.
Show Source
Nested Schema : Work Definition Operations
Type:
array
Title:
Work Definition Operations
The Operations resource gets the operations for the work definition.
Show Source
Nested Schema : Work Definition Outputs
Type:
array
Title:
Work Definition Outputs
The Work Definition Outputs resource gets all the outputs of a work definition across the operations.
Show Source
Nested Schema : Work Definition Resources
Type:
array
Title:
Work Definition Resources
The Work Definition Resources resource gets all the resources of a work definition across the operations.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : workDefinitions-WorkDefinitionAttachment-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the attachment of a work definition operation output. It is a primary key that the application generates when a document is attached to the work definition operation output. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Login that the user used when creating the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attachment record. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the current version of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the contents in the attachment are no longer available. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) that locates the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the user most recently updated the document that is attached to the work definition operation output. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Login of the user who updated the document that is attached to the work definition operation output. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the document that is attached to the work definition. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL (Uniform Resource Locator) that locates the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login that the user used when adding or modifying the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workDefinitions-WorkDefinitionMaterial-item-response
Type:
Show Source
object
-
AdhocItemFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true or false. If true, then the material line is based on the item structure. If false, then the material line is not based on the item structure. This attribute does not have a default value. -
BasisType: string
Title:
Basis
Read Only:true
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 2: the application varies the component quantity that it requires for the parent assembly according to the quantity of the work order. -
ComponentSequenceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item structure component (EGP_COMPONENTS_B) assigned to this operation. -
ComponentSequenceIdPath: string
(byte)
Read Only:
true
Value that uniquely identifies this component in the exploded ATO Model item structure. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created this record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the record was created. -
FindNumber: number
Title:
Find Number
Read Only:true
Unique identifier of a component that appears more than once in an item structure. -
InventoryItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the component. It is a primary key that the application generates when it creates the item. -
InverseQuantity: number
Title:
Inverse Quantity
Read Only:true
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. -
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the component. -
ItemNumber: string
Read Only:
true
Maximum Length:300
Number that identifies the item. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when record was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaterialSequenceNumber: number
Title:
Sequence
Read Only:true
Number that indicates the unique sequence of the component assigned to the work definition operation. -
MaterialType: string
Read Only:
true
Maximum Length:30
Type of material of the items or components that the work definition operation references. Contains one of the following values: COMPONENT or PRIMARY_PRODUCT. COMPONENT: the material is a component that the application issues to the work order. PRIMARY_PRODUCT: the material is an assembly that is an output of a work order. -
OperationName: string
Title:
Name
Read Only:true
Maximum Length:120
Name of the operation. -
OperationSequenceNumber: number
Title:
Sequence
Read Only:true
Number that indicates the sequence to use when performing the work definition operation. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory organization that the application enabled for manufacturing. It is a primary key that the application generates when it creates the inventory organization. -
Quantity: number
Title:
Quantity
Read Only:true
Quantity required to make each unit of the item. -
SecondaryQuantity: number
Title:
Secondary Quantity
Read Only:true
Required component quantity in the secondary unit of measure. This attribute is associated with a feature that requires opt in. -
SecondaryUnitOfMeasure: string
Title:
Secondary UOM
Read Only:true
Secondary unit of measure of the component. This attribute is associated with a feature that requires opt in. -
SecondaryUOMCode: string
Title:
Secondary UOM Code
Read Only:true
Abbreviation that identifies the secondary unit of measure of the component. This attribute is associated with a feature that requires opt in. -
StandardOperationCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the standard operation. -
StandardOperationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the standard operation that the work definition operation references. It is a primary key that the application generates when it creates the standard operation. -
SupplyLocator: string
Read Only:
true
Maximum Length:255
Locator in subinventory to use, by default, when the plant uses material during assembly or an operation pull. -
SupplyLocatorId: integer
(int64)
Title:
Supply Locator
Read Only:true
Value that uniquely identifies the locator. It is a primary key that the application generates when it creates the locator. -
SupplySubinventory: string
Title:
Supply Subinventory
Read Only:true
Maximum Length:10
Subinventory to use, by default, when the plant uses material during assembly or an operation pull. -
SupplyType: string
Title:
Supply Type
Read Only:true
Maximum Length:30
Consumption of the material. Values include Assembly pull, Operation pull, Push, Bulk, or Supplier. -
SupplyTypeDescription: string
Read Only:
true
Maximum Length:255
Description of the supply type. -
UnitOfMeasure: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Unit of measure that the component uses. It is the primary unit of measure of the item. -
UOMCode: string
Title:
UOM Code
Read Only:true
Maximum Length:3
Abbreviation that identifies the unit of measure that the component uses. -
WorkAreaCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the work area. -
WorkAreaDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the work area. -
WorkAreaId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work area. It is a primary key that the application generates when it creates the work area. -
WorkAreaName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the work area. -
WorkCenterCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the work center. -
WorkCenterDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the work center. -
WorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work center. It is a primary key that the application generates when it creates the work center. -
WorkCenterName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the work center. -
WorkDefinitionId: integer
(int64)
Read Only:
true
Default Value:1
Value that uniquely identifies the work definition. It is a primary key that the application generates when it creates the work definition. -
WorkDefinitionOperationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work definition operation. It is a primary key that the application generates when it creates the work definition operation. -
WorkDefinitionOperationMaterialAttachment: array
Attachments for Materials
Title:
Attachments for Materials
The Attachments for Materials resource gets the attachments that contain details about the material. -
WorkDefinitionOperationMaterialDFF: array
Flexfields for Materials
Title:
Flexfields for Materials
The Flexfields for Materials resource gets the descriptive flexfields that contain details about the material. -
WorkDefinitionOperationMaterialId: integer
(int64)
Read Only:
true
Value that uniquely identifies the material for the work definition operation. It is a primary key that the application generates when it creates the material. -
WorkDefinitionOperationSubstituteMaterial: array
Substitute Materials
Title:
Substitute Materials
The Substitute Materials resource gets the substitute materials that the work definition operation uses. -
YieldFactor: number
Read Only:
true
Factor to use when calculating the quantity that the operation requires to accommodate component waste when it processes the item. It is recommended that you set the yield to between 0 and 1. You can set the yield to a value that is greater than 1. The application considers the yield when it calculates the required quantity according to the Include plant parameter for the component yield.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Attachments for Materials
Type:
array
Title:
Attachments for Materials
The Attachments for Materials resource gets the attachments that contain details about the material.
Show Source
Nested Schema : Flexfields for Materials
Type:
array
Title:
Flexfields for Materials
The Flexfields for Materials resource gets the descriptive flexfields that contain details about the material.
Show Source
Nested Schema : Substitute Materials
Type:
array
Title:
Substitute Materials
The Substitute Materials resource gets the substitute materials that the work definition operation uses.
Show Source
Nested Schema : workDefinitions-WorkDefinitionMaterial-WorkDefinitionOperationMaterialAttachment-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the attachment of a work definition operation output. It is a primary key that the application generates when a document is attached to the work definition operation output. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Login that the user used when creating the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attachment record. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the current version of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the contents in the attachment are no longer available. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) that locates the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the user most recently updated the document that is attached to the work definition operation output. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Login of the user who updated the document that is attached to the work definition operation output. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the document that is attached to the work definition. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL (Uniform Resource Locator) that locates the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login that the user used when adding or modifying the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workDefinitions-WorkDefinitionMaterial-WorkDefinitionOperationMaterialDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:80
Descriptive flexfield context name for work definition operation materials. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
Discriminator: string
This is a transient attribute. The value of this attribute will always be null. Ignore this attribute.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
WdOperationMaterialId: integer
(int64)
Value that uniquely identifies the material that the work definition operation consumes. It is a primary key that the application generates when it consumes the material.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workDefinitions-WorkDefinitionMaterial-WorkDefinitionOperationSubstituteMaterial-item-response
Type:
Show Source
object
-
ComponentSequenceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the sequence of the substitute component that the application assigns to the material that the work definition operation consumes. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PriorityRanking: number
Read Only:
true
Ranking of the substitute component to use instead of the primary component. -
SubstituteComponentId: integer
(int64)
Read Only:
true
Value that uniquely identifies the substitute component. It is a primary key that the application generates when it creates the item. -
SubstituteInverseQuantity: number
Read Only:
true
Inverse of the Quantity Per Product attribute. 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. -
SubstituteItemQuantity: number
Read Only:
true
Quantity required to make each unit of the item. -
WdOperationMaterialId: integer
(int64)
Read Only:
true
Value that uniquely identifies the material for a work definition operation. It is a primary key that the application generates when it consumes the material. -
WdOperationSubstituteMaterialId: integer
(int64)
Read Only:
true
Value that uniquely identifies the substitute material for a work definition operation. It is a primary key that the application generates when it consumes the substitute material.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workDefinitions-WorkDefinitionOperation-item-response
Type:
Show Source
object
-
AddlMtlAtManualIssue: string
Title:
Additional Manual Material Issue
Read Only:true
Maximum Length:30
Default Value:ALLOW
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
Title:
Automatically Transact
Read Only:true
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 performed when the quantity is moved outside the operation. If false, then both resources and materials are not automatically charged. This attribute does not have a default value. -
CountPointOperationFlag: boolean
Title:
Count Point
Read Only:true
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. This attribute does not have a default value. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created this record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the record was created. -
EffectiveFromDate: string
(date-time)
Title:
Start Date
Read Only:true
Date when the operation is effective. -
EffectiveToDate: string
(date-time)
Title:
End Date
Read Only:true
Date when the operation is no longer effective. -
FixedLeadTime: number
Title:
Fixed
Read Only:true
Lead time to perform this outside processing (OSP) operation for each unit of the outside processing item. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
LeadTimePercent: number
Title:
Lead Time
Read Only:true
Lead time percent computed by the manufacturing lead time calculation program and used in the cumulative lead time calculation. -
LeadTimeUnitOfMeasure: string
Read Only:
true
Maximum Length:255
Name of the unit of measure that the lead time uses for the supplier operation. -
LeadTimeUOMCode: string
Title:
UOM
Read Only:true
Maximum Length:3
Abbreviation that identifies the unit of measure that the lead time uses for the supplier operation. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OperationComplWithOpenExceptions: string
Title:
Completions with Open Exceptions
Read Only:true
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
Title:
Completions with Under Issues
Read Only:true
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
Title:
Description
Read Only:true
Maximum Length:240
Description of the operation. -
OperationName: string
Title:
Name
Read Only:true
Maximum Length:120
Name of the operation. -
OperationSequenceNumber: number
Title:
Sequence
Read Only:true
Number that indicates the sequence to use when performing the work order operations. -
OperationType: string
Title:
Operation Type
Read Only:true
Maximum Length:30
Default Value:IN_HOUSE
Type of operation. Contains one of the following values: IN_HOUSE or SUPPLIER. IN_HOUSE: the organization that owns the work order performs the operation. SUPPLIER: the supplier performs the operation. -
OperationTypeDescription: string
Read Only:
true
Maximum Length:255
Description of the operation type. -
OptionDependentFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true or false. If true, then the operation is dependent on the choice of one or multiple optional components. If false, then the operation is not dependent on the optional components. This attribute does not have a default value. This attribute applies only to an assemble-to-order (ATO) model work definition. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory organization that the application enabled for manufacturing. It is a primary key that the application generates when it creates the inventory organization. -
OSPItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Value that uniquely identifies the outside processing (OSP) supplier. It is a primary key that the application generates when it creates a supplier. -
OSPItemId: integer
(int64)
Title:
Item
Read Only:true
Value that uniquely identifies the outside processing (OSP) item. It is a primary key that the application generates when it creates an item. -
OSPItemNumber: string
Read Only:
true
Maximum Length:300
Description of the outside processing (OSP) item. -
PlanningPercent: number
Title:
Planning
Read Only:true
Percent that planning uses for resources forecast explosion. The value must be a positive number. This attribute applies only to an assemble-to-order (ATO) model work definition. -
ReferencedFlag: boolean
Read Only:
true
Maximum Length:1
Default Value:false
Contains one of the following values: true or false. If true, then the operation is a standard operation. If false, then the operation is not a standard operation. This is a read-only value. -
ResequenceFlag: boolean
Title:
Allow Resequencing
Read Only:true
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. It is read-only value. This attribute is associated with a feature that requires opt in. -
SerialTrackingFlag: boolean
Read Only:
true
Maximum Length:1
Default Value:true
Contains one of the following values: true or false. If true, then the product is tracked by serial number while running this operation. If false, then the product is not tracked by serial number. This attribute does not have a default value. -
ShippingDocumentsFlag: boolean
Title:
Generate shipment
Read Only:true
Maximum Length:1
Contains one of the following values: true or false. If true, then create shipping documents for this outside processing (OSP) operation. If false, then do not create shipping documents. This attribute does not have a default value. -
StandardOperationCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the standard operation. -
StandardOperationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the standard operation that the work definition operation references. It is a primary key that the application generates when it creates the standard operation. -
StandardOperationName: string
Title:
Name
Read Only:true
Maximum Length:120
Name of the standard operation. -
SupplierId: integer
(int64)
Title:
Supplier
Read Only:true
Name of the outside processing (OSP) supplier. -
SupplierName: string
Read Only:
true
Maximum Length:255
Value that uniquely identifies the supplier site. It is a primary key that the application generates when it creates a supplier site. -
SupplierSiteDescription: string
Read Only:
true
Maximum Length:255
Lead time to perform this outside processing (OSP) operation, independent of the quantity of the outside processing item. -
SupplierSiteId: integer
(int64)
Title:
Supplier Site
Read Only:true
Description of the supplier site. -
translations: array
Translations for Operations
Title:
Translations for Operations
The Translations for Operations resource gets the translations for operation name and operation description. -
VariableLeadTime: number
Title:
Variable
Read Only:true
Abbreviation that identifies the unit of measure that the lead time uses. -
WorkAreaCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the work area. -
WorkAreaDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the work area. -
WorkAreaId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work area. It is a primary key that the application generates when it creates the work area. -
WorkAreaName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the work area. -
WorkCenterCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the work center. -
WorkCenterDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the work center. -
WorkCenterId: integer
(int64)
Title:
Work Center
Read Only:true
Value that uniquely identifies the work center. It is a primary key that the application generates when it creates the work center. -
WorkCenterName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the work center. -
WorkDefinitionId: integer
(int64)
Read Only:
true
Default Value:1
Value that uniquely identifies the work definition. It is a primary key that the application generates when it creates the work definition. -
WorkDefinitionOperationAttachment: array
Attachments for Operations
Title:
Attachments for Operations
The Attachments for Operations resource gets the attachments that the work definition operation uses. -
WorkDefinitionOperationDFF: array
Flexfields for Operations
Title:
Flexfields for Operations
The Flexfields for Operations resource gets the descriptive flexfields that contain details about the work definition operation. -
WorkDefinitionOperationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work definition operation. It is a primary key that the application generates when it creates the work definition operation. -
WorkDefinitionOperationMaterial: array
Materials for Operations
Title:
Materials for Operations
The Materials for Operations gets the materials that the work definition operation uses. -
WorkDefinitionOperationOutput: array
Outputs for Operations
Title:
Outputs for Operations
The Outputs for Operations gets the output that the work definition operation uses. -
WorkDefinitionOperationResource: array
Resources for Operations
Title:
Resources for Operations
The Resources for Operations resource gets the resources that the work definition operation uses.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Translations for Operations
Type:
array
Title:
Translations for Operations
The Translations for Operations resource gets the translations for operation name and operation description.
Show Source
Nested Schema : Attachments for Operations
Type:
array
Title:
Attachments for Operations
The Attachments for Operations resource gets the attachments that the work definition operation uses.
Show Source
Nested Schema : Flexfields for Operations
Type:
array
Title:
Flexfields for Operations
The Flexfields for Operations resource gets the descriptive flexfields that contain details about the work definition operation.
Show Source
Nested Schema : Materials for Operations
Type:
array
Title:
Materials for Operations
The Materials for Operations gets the materials that the work definition operation uses.
Show Source
Nested Schema : Outputs for Operations
Type:
array
Title:
Outputs for Operations
The Outputs for Operations gets the output that the work definition operation uses.
Show Source
Nested Schema : Resources for Operations
Type:
array
Title:
Resources for Operations
The Resources for Operations resource gets the resources that the work definition operation uses.
Show Source
Nested Schema : workDefinitions-WorkDefinitionOperation-translations-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created this record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the record was created. -
Language: string
Maximum Length:
4
Value that uniquely identifies the language. It is the primary key. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OperationDescription: string
Maximum Length:
240
Description of the operation. -
OperationName: string
Maximum Length:
120
Name of the operation. -
SourceLang: string
Maximum Length:
4
Source language of the operation description and operation name. -
WdOperationId: integer
(int64)
Value that uniquely identifies the work definition operation. It is a primary key that the application generates when it creates the operation. This attribute is required.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationAttachment-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the attachment of a work definition operation output. It is a primary key that the application generates when a document is attached to the work definition operation output. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Login that the user used when creating the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attachment record. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the current version of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the contents in the attachment are no longer available. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) that locates the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the user most recently updated the document that is attached to the work definition operation output. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Login of the user who updated the document that is attached to the work definition operation output. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the document that is attached to the work definition. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL (Uniform Resource Locator) that locates the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login that the user used when adding or modifying the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:80
Descriptive flexfield context name for work definition operations. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
Discriminator: string
This is a transient attribute. The value of this attribute will always be null. Ignore this attribute.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
WdOperationId: integer
(int64)
Value that uniquely identifies the work definition. It is a primary key that the application generates when it creates the work definition.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationMaterial-item-response
Type:
Show Source
object
-
AdhocItemFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true or false. If true, then the material line is based on the item structure. If false, then the material line is not based on the item structure. This attribute does not have a default value. -
BasisType: string
Title:
Basis
Read Only:true
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 2: the application varies the component quantity that it requires for the parent assembly according to the quantity of the work order. -
ComponentSequenceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item structure component (EGP_COMPONENTS_B) assigned to this operation. -
ComponentSequenceIdPath: string
(byte)
Read Only:
true
Value that uniquely identifies this component in the exploded ATO Model item structure. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created this record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the record was created. -
FindNumber: number
Title:
Find Number
Read Only:true
Unique identifier of a component that appears more than once in an item structure. -
InventoryItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the component. It is a primary key that the application generates when it creates the item. -
InverseQuantity: number
Title:
Inverse Quantity
Read Only:true
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. -
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the component. -
ItemNumber: string
Read Only:
true
Maximum Length:300
Number that identifies the item. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when record was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaterialSequenceNumber: number
Title:
Sequence
Read Only:true
Number that indicates the unique sequence of the component assigned to the work definition operation. -
MaterialType: string
Read Only:
true
Maximum Length:30
Type of material of the items or components that the work definition operation references. Contains one of the following values: COMPONENT or PRIMARY_PRODUCT. COMPONENT: the material is a component that the application issues to the work order. PRIMARY_PRODUCT: the material is an assembly that is an output of a work order. -
OperationName: string
Title:
Name
Read Only:true
Maximum Length:120
Name of the operation. -
OperationSequenceNumber: number
Title:
Sequence
Read Only:true
Number that indicates the sequence to use when performing the work definition operation. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory organization that the application enabled for manufacturing. It is a primary key that the application generates when it creates the inventory organization. -
Quantity: number
Title:
Quantity
Read Only:true
Quantity required to make each unit of the item. -
SecondaryQuantity: number
Title:
Secondary Quantity
Read Only:true
Required component quantity in the secondary unit of measure. This attribute is associated with a feature that requires opt in. -
SecondaryUnitOfMeasure: string
Title:
Secondary UOM
Read Only:true
Secondary unit of measure of the component. This attribute is associated with a feature that requires opt in. -
SecondaryUOMCode: string
Title:
Secondary UOM Code
Read Only:true
Abbreviation that identifies the secondary unit of measure of the component. This attribute is associated with a feature that requires opt in. -
StandardOperationCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the standard operation. -
StandardOperationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the standard operation that the work definition operation references. It is a primary key that the application generates when it creates the standard operation. -
SupplyLocator: string
Read Only:
true
Maximum Length:255
Locator in subinventory to use, by default, when the plant uses material during assembly or an operation pull. -
SupplyLocatorId: integer
(int64)
Title:
Supply Locator
Read Only:true
Value that uniquely identifies the locator. It is a primary key that the application generates when it creates the locator. -
SupplySubinventory: string
Title:
Supply Subinventory
Read Only:true
Maximum Length:10
Subinventory to use, by default, when the plant uses material during assembly or an operation pull. -
SupplyType: string
Title:
Supply Type
Read Only:true
Maximum Length:30
Consumption of the material. Values include Assembly pull, Operation pull, Push, Bulk, or Supplier. -
SupplyTypeDescription: string
Read Only:
true
Maximum Length:255
Description of the supply type. -
UnitOfMeasure: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Unit of measure that the component uses. It is the primary unit of measure of the item. -
UOMCode: string
Title:
UOM Code
Read Only:true
Maximum Length:3
Abbreviation that identifies the unit of measure that the component uses. -
WorkAreaCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the work area. -
WorkAreaDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the work area. -
WorkAreaId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work area. It is a primary key that the application generates when it creates the work area. -
WorkAreaName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the work area. -
WorkCenterCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the work center. -
WorkCenterDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the work center. -
WorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work center. It is a primary key that the application generates when it creates the work center. -
WorkCenterName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the work center. -
WorkDefinitionId: integer
(int64)
Read Only:
true
Default Value:1
Value that uniquely identifies the work definition. It is a primary key that the application generates when it creates the work definition. -
WorkDefinitionOperationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work definition operation. It is a primary key that the application generates when it creates the work definition operation. -
WorkDefinitionOperationMaterialAttachment: array
Attachments for Materials
Title:
Attachments for Materials
The Attachments for Materials resource gets the attachments that contain details about the material. -
WorkDefinitionOperationMaterialDFF: array
Flexfields for Materials
Title:
Flexfields for Materials
The Flexfields for Materials resource gets the descriptive flexfields that contain details about the material. -
WorkDefinitionOperationMaterialId: integer
(int64)
Read Only:
true
Value that uniquely identifies the material for the work definition operation. It is a primary key that the application generates when it creates the material. -
WorkDefinitionOperationSubstituteMaterial: array
Substitute Materials
Title:
Substitute Materials
The Substitute Materials resource gets the substitute materials that the work definition operation uses. -
YieldFactor: number
Read Only:
true
Factor to use when calculating the quantity that the operation requires to accommodate component waste when it processes the item. It is recommended that you set the yield to between 0 and 1. You can set the yield to a value that is greater than 1. The application considers the yield when it calculates the required quantity according to the Include plant parameter for the component yield.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Attachments for Materials
Type:
array
Title:
Attachments for Materials
The Attachments for Materials resource gets the attachments that contain details about the material.
Show Source
Nested Schema : Flexfields for Materials
Type:
array
Title:
Flexfields for Materials
The Flexfields for Materials resource gets the descriptive flexfields that contain details about the material.
Show Source
Nested Schema : Substitute Materials
Type:
array
Title:
Substitute Materials
The Substitute Materials resource gets the substitute materials that the work definition operation uses.
Show Source
Nested Schema : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationMaterial-WorkDefinitionOperationMaterialAttachment-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the attachment of a work definition operation output. It is a primary key that the application generates when a document is attached to the work definition operation output. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Login that the user used when creating the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attachment record. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the current version of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the contents in the attachment are no longer available. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) that locates the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the user most recently updated the document that is attached to the work definition operation output. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Login of the user who updated the document that is attached to the work definition operation output. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the document that is attached to the work definition. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL (Uniform Resource Locator) that locates the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login that the user used when adding or modifying the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationMaterial-WorkDefinitionOperationMaterialDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:80
Descriptive flexfield context name for work definition operation materials. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
Discriminator: string
This is a transient attribute. The value of this attribute will always be null. Ignore this attribute.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
WdOperationMaterialId: integer
(int64)
Value that uniquely identifies the material that the work definition operation consumes. It is a primary key that the application generates when it consumes the material.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationMaterial-WorkDefinitionOperationSubstituteMaterial-item-response
Type:
Show Source
object
-
ComponentSequenceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the sequence of the substitute component that the application assigns to the material that the work definition operation consumes. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PriorityRanking: number
Read Only:
true
Ranking of the substitute component to use instead of the primary component. -
SubstituteComponentId: integer
(int64)
Read Only:
true
Value that uniquely identifies the substitute component. It is a primary key that the application generates when it creates the item. -
SubstituteInverseQuantity: number
Read Only:
true
Inverse of the Quantity Per Product attribute. 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. -
SubstituteItemQuantity: number
Read Only:
true
Quantity required to make each unit of the item. -
WdOperationMaterialId: integer
(int64)
Read Only:
true
Value that uniquely identifies the material for a work definition operation. It is a primary key that the application generates when it consumes the material. -
WdOperationSubstituteMaterialId: integer
(int64)
Read Only:
true
Value that uniquely identifies the substitute material for a work definition operation. It is a primary key that the application generates when it consumes the substitute material.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationOutput-item-response
Type:
Show Source
object
-
CompletionLocator: string
Read Only:
true
Maximum Length:255
Locator into which this output line is produced. -
CompletionSubinventory: string
Title:
Completion Subinventory
Read Only:true
Maximum Length:10
Subinventory into which this output line is produced. -
CompletionType: string
Title:
Completion Type
Read Only:true
Maximum Length:30
Indicates the completion type code. A list of accepted values is defined in the lookup type ORA_WIS_OUTPUT_COMPL_TYPE. -
CompletionTypeDescription: string
Read Only:
true
Maximum Length:255
Description of the completion type code. -
CostAllocationPercentage: number
Title:
Cost Allocation Percentage
Read Only:true
Cost percentage share of this output across all outputs. This attribute is null for manually entered costs. -
CostingPriority: number
Title:
Costing Priority
Read Only:true
Priority to use when determining which work definition to use when calculating the standard cost by using rolling up costs during costing. Upon exploding the bill of materials, the child work definitions are threaded using the priority number selected at the top. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created this record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the record was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
User who most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Date when the record was most recently updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OperationName: string
Title:
Name
Read Only:true
Maximum Length:120
Name of the work definition operation. -
OperationSequenceNumber: number
Title:
Sequence
Read Only:true
Number that indicates the sequence of running the operation. -
Output: string
Read Only:
true
Maximum Length:300
Number that identifies the output item of an operation. -
OutputDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the item of the output. -
OutputId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work definition operation output. The application generates this value. -
OutputSequence: number
Title:
Sequence
Read Only:true
Number that indicates the sequence of this output line within this operation. -
OutputType: string
Title:
Output Type
Read Only:true
Maximum Length:30
Type of output produced by the operation. A list of accepted values is defined in the lookup type ORA_WIS_WD_OUTPUT_MATERIAL. -
Quantity: number
Title:
Quantity
Read Only:true
Quantity of output expected to be produced by this operation. -
SecondaryQuantity: number
Title:
Secondary Quantity
Read Only:true
Output quantity expected to be produced by this operation in the secondary unit of measure. This attribute is associated with a feature that requires opt in. -
SecondaryUnitOfMeasure: string
Title:
Secondary UOM
Read Only:true
Secondary unit of measure of the output. This attribute is associated with a feature that requires opt in. -
SecondaryUOMCode: string
Title:
Secondary UOM Code
Read Only:true
Abbreviation that identifies the secondary unit of measure of the output. This attribute is associated with a feature that requires opt in. -
StandardOperationCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the user key to the standard operation. -
StandardOperationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the standard operation. The application generates this value. -
UnitOfMeasure: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Unit of measure of the output. -
UOMCode: string
Title:
UOM
Read Only:true
Maximum Length:3
Abbreviation that identifies the unit of measure of the output. -
WorkAreaCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the work area. This attribute uniquely identifies a work area within a manufacturing plant. -
WorkAreaDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the work area. -
WorkAreaId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work area. The application generates this value. -
WorkAreaName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the work area. -
WorkCenterCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the user key to the work center. -
WorkCenterDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the work center. -
WorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work center. The application generates this value. -
WorkCenterName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the work center. -
WorkDefinitionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work definition. This is used to enforce uniqueness of an output item across the work definition operations. -
WorkDefinitionOperationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the operation to which this operation output item is assigned. -
WorkDefinitionOperationOutputAttachment: array
Attachments for Outputs
Title:
Attachments for Outputs
The Attachments for Outputs resource gets the attachments that contain details about the output. -
WorkDefinitionOperationOutputDFF: array
Flexfields for Outputs
Title:
Flexfields for Outputs
The Flexfields for Outputs resource gets the descriptive flexfields that contain details about the output.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Attachments for Outputs
Type:
array
Title:
Attachments for Outputs
The Attachments for Outputs resource gets the attachments that contain details about the output.
Show Source
Nested Schema : Flexfields for Outputs
Type:
array
Title:
Flexfields for Outputs
The Flexfields for Outputs resource gets the descriptive flexfields that contain details about the output.
Show Source
Nested Schema : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationOutput-WorkDefinitionOperationOutputAttachment-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the attachment of a work definition operation output. It is a primary key that the application generates when a document is attached to the work definition operation output. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Login that the user used when creating the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attachment record. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the current version of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the contents in the attachment are no longer available. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) that locates the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the user most recently updated the document that is attached to the work definition operation output. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Login of the user who updated the document that is attached to the work definition operation output. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the document that is attached to the work definition. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL (Uniform Resource Locator) that locates the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login that the user used when adding or modifying the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationOutput-WorkDefinitionOperationOutputDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:80
Descriptive flexfield context name for work definition operation output. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for work definition operation output. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
WdOperationOutputId: integer
(int64)
Value that uniquely identifies the work definition operation output. The application generates this value.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationResource-item-response
Type:
Show Source
object
-
AssignedUnits: number
Title:
Units Assigned
Read Only:true
Number of resource units the application assigns to perform the operation. -
BasisType: string
Title:
Basis
Read Only:true
Maximum Length:30
Default Value:2
Contains one of the following values: 1 or 2. If 1, then the resource consumption is fixed. It does not change according to work order quantity. If 2, then the resource consumption is not fixed. It might change according to work order quantity. This attribute does not have a default value. -
ChargeType: string
Title:
Charge Type
Read Only:true
Maximum Length:30
Contains one of the following values 1 or 2. If 1, then the user manually charges the resources. If 2, then the application automatically charges the resource when it completes the operation. This attribute does not have a default value. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created this record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the record was created. -
CurrentRevision: string
Maximum Length:
255
Value that uniquely identifies the current revision of the document item, which represents the current revision of the program file. -
EquipmentParameterFileContent: string
(byte)
Read Only:
true
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
Read Only:
true
Maximum Length:512
Name of the equipment parameter's flat file associated with the work definition operation's resource. -
EquipmentProfileCode: string
Read Only:
true
Maximum Length:255
Abbreviation that identifies the equipment profile associated with the work definition operation resource. This attribute is associated with a feature that requires opt in. -
EquipmentProfileId: integer
(int64)
Title:
Equipment Profile
Read Only:true
Value that uniquely identifies the equipment profile associated with the work definition operation resource. This attribute is associated with a feature that requires opt in. -
InverseUsageRate: number
Title:
Inverse Usage
Read Only:true
Rate that indicates the inverse resource usage. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when record was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OperationName: string
Title:
Name
Read Only:true
Maximum Length:120
Name of the operation. -
OperationSequenceNumber: number
Title:
Sequence
Read Only:true
Number that indicates the sequence to use when performing the work order operations. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory organization that the application enabled for manufacturing. It is a primary key that the application generates when it creates the inventory organization. -
PrincipalFlag: boolean
Title:
Principal
Read Only:true
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. If false, then the resource is not the principal resource. This attribute does not have a default value. -
ProfileCode: string
Read Only:
true
Maximum Length:255
Abbreviation that identifies the job profile associated with the work definition operation resource. This attribute is associated with a feature that requires opt in. -
ProfileId: integer
(int64)
Read Only:
true
Value that uniquely identifies the job profile associated with the work definition operation resource. This attribute is associated with a feature that requires opt in. -
ProgramFileId: integer
(int64)
Read Only:
true
Value that uniquely identifies the document item assigned to the master organization that represents the name of the program file used by the equipment. -
ProgramFileName: string
Maximum Length:
255
Value that uniquely identifies the document item that represents the program file. -
ResourceActivityCode: string
Title:
Activity
Read Only:true
Maximum Length:30
Abbreviation that identifies the resource activity. -
ResourceCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the resource. -
ResourceDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the resource. -
ResourceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the production resource. It is a primary key that the application generates when it consumes the production resource. -
ResourceName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the resource. -
ResourceSequenceNumber: number
Title:
Sequence
Read Only:true
Number that the application uses to determine the step in the sequence it must use to make sure resources work together correctly to finish the operation. If multiple resource lines include the same resource sequence number, then the application schedules them to occur at the same time. -
ResourceType: string
Title:
Type
Read Only:true
Maximum Length:30
Category of the resource. Values include Labor or Equipment. -
ScheduledIndicator: string
Title:
Scheduled
Read Only:true
Maximum Length:30
Contains one of the following values: Yes or No. If Yes, then scheduling schedules the resource and computes the start date and completion dates. If No, then scheduling does not schedule the resource and the application sets the start date equal to the completion date. This attribute does not have a default value. -
StandardOperationCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the standard operation. -
StandardOperationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the standard operation that the work definition operation references. It is a primary key that the application generates when it creates the standard operation. -
UnitOfMeasure: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Unit of measure that the resource uses. -
UOMCode: string
Title:
UOM
Read Only:true
Maximum Length:3
Abbreviation that identifies the unit of measure that the resource uses. -
UsageRate: number
Title:
Usage
Read Only:true
Rate of the resource that the plant requires to make each unit of the item. -
WorkAreaCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the work area. -
WorkAreaDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the work area. -
WorkAreaId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work area. It is a primary key that the application generates when it creates the work area. -
WorkAreaName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the work area. -
WorkCenterCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the work center. -
WorkCenterDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the work center. -
WorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work center. It is a primary key that the application generates when it creates the work center. -
WorkCenterName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the work center. -
WorkDefinitionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work definition. It is a primary key that the application generates when it creates the work definition. -
WorkDefinitionOperationAlternateResource: array
Alternate Resources
Title:
Alternate Resources
The Alternate Resources resource gets the alternate resources that the work definition operation uses. -
WorkDefinitionOperationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work definition operation. It is a primary key that the application generates when it creates the work definition operation. -
WorkDefinitionOperationResourceAttachment: array
Attachments for Resources
Title:
Attachments for Resources
The Attachments for Resources resource gets the attachments that contain details about the resource. -
WorkDefinitionOperationResourceDFF: array
Flexfields for Resources
Title:
Flexfields for Resources
The Flexfields for Resources resource gets the descriptive flexfields that contain details about the resource that the work definition operation uses. -
WorkDefinitionOperationResourceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the resource for the work definition operation. It is a primary key that the application generates when it creates the resource.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Alternate Resources
Type:
array
Title:
Alternate Resources
The Alternate Resources resource gets the alternate resources that the work definition operation uses.
Show Source
Nested Schema : Attachments for Resources
Type:
array
Title:
Attachments for Resources
The Attachments for Resources resource gets the attachments that contain details about the resource.
Show Source
Nested Schema : Flexfields for Resources
Type:
array
Title:
Flexfields for Resources
The Flexfields for Resources resource gets the descriptive flexfields that contain details about the resource that the work definition operation uses.
Show Source
Nested Schema : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationResource-WorkDefinitionOperationAlternateResource-item-response
Type:
Show Source
object
-
AssignedUnits: number
Title:
Units Assigned
Read Only:true
Number of resource units the application assigns to perform the operation. -
CurrentRevision: string
Maximum Length:
255
Value that uniquely identifies the current revision of the document item, which represents the current revision of the program file. -
EquipmentParameterFileContent: string
(byte)
Read Only:
true
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
Read Only:
true
Maximum Length:512
Name of the equipment parameter's flat file associated with the work definition operation's alternate resource. -
InverseUsageRate: number
Title:
Inverse Usage
Read Only:true
Inverse of the usage rate. The application uses this inverse when the resource usage rate is a fraction, but the inverse of this rate is an integer. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PriorityRanking: number
Title:
Priority
Read Only:true
Ranking of the alternative resource to use instead of the primary resource. -
ProgramFileId: integer
(int64)
Read Only:
true
Value that uniquely identifies the document item assigned to the master organization that represents the name of the program file used by the equipment. -
ProgramFileName: string
Maximum Length:
255
Value that uniquely identifies the document item that represents the program file. -
ResourceCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the resource. -
ResourceDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the resource. -
ResourceId: integer
(int64)
Title:
Resource
Read Only:true
Value that uniquely identifies the production resource. It is a primary key that the application generates when it consumes the production resource. -
ResourceName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the resource. -
ResourceType: string
Title:
Type
Read Only:true
Maximum Length:30
Category of the resource. Values include Labor or Equipment. -
UnitOfMeasure: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Unit of measure that the resource uses. -
UOMCode: string
Title:
UOM
Read Only:true
Maximum Length:3
Abbreviation that identifies the unit of measure that the resource uses. -
UsageRate: number
Title:
Usage
Read Only:true
Resource usage that the plant requires to make each unit of the item. -
WdOperationAlternateResourceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the alternative resource of a work definition operation. It is a primary key that the application generates when it creates the alternative resource of a work definition operation. -
WdOperationResourceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the resource that the work definition operation consumes. It is a primary key that the application generates when it consumes the resource.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationResource-WorkDefinitionOperationResourceAttachment-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the attachment of a work definition operation output. It is a primary key that the application generates when a document is attached to the work definition operation output. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Login that the user used when creating the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attachment record. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the current version of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the contents in the attachment are no longer available. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) that locates the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the user most recently updated the document that is attached to the work definition operation output. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Login of the user who updated the document that is attached to the work definition operation output. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the document that is attached to the work definition. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL (Uniform Resource Locator) that locates the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login that the user used when adding or modifying the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationResource-WorkDefinitionOperationResourceDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Country Specific
Maximum Length:80
Descriptive flexfield context name for work definition operation resources. -
__FLEX_Context_DisplayValue: string
Title:
Country Specific
-
Discriminator: string
This is a transient attribute. The value of this attribute will always be null. Ignore this attribute.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
WdOperationResourceId: integer
(int64)
Value that uniquely identifies the resource that the work definition operation consumes. It is a primary key that the application generates when it consumes the resource.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workDefinitions-WorkDefinitionOutput-item-response
Type:
Show Source
object
-
CompletionLocator: string
Read Only:
true
Maximum Length:255
Locator into which this output line is produced. -
CompletionSubinventory: string
Title:
Completion Subinventory
Read Only:true
Maximum Length:10
Subinventory into which this output line is produced. -
CompletionType: string
Title:
Completion Type
Read Only:true
Maximum Length:30
Indicates the completion type code. A list of accepted values is defined in the lookup type ORA_WIS_OUTPUT_COMPL_TYPE. -
CompletionTypeDescription: string
Read Only:
true
Maximum Length:255
Description of the completion type code. -
CostAllocationPercentage: number
Title:
Cost Allocation Percentage
Read Only:true
Cost percentage share of this output across all outputs. This attribute is null for manually entered costs. -
CostingPriority: number
Title:
Costing Priority
Read Only:true
Priority to use when determining which work definition to use when calculating the standard cost by using rolling up costs during costing. Upon exploding the bill of materials, the child work definitions are threaded using the priority number selected at the top. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created this record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the record was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
User who most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Date when the record was most recently updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OperationName: string
Title:
Name
Read Only:true
Maximum Length:120
Name of the work definition operation. -
OperationSequenceNumber: number
Title:
Sequence
Read Only:true
Number that indicates the sequence of running the operation. -
Output: string
Read Only:
true
Maximum Length:300
Number that identifies the output item of an operation. -
OutputDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the item of the output. -
OutputId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work definition operation output. The application generates this value. -
OutputSequence: number
Title:
Sequence
Read Only:true
Number that indicates the sequence of this output line within this operation. -
OutputType: string
Title:
Output Type
Read Only:true
Maximum Length:30
Type of output produced by the operation. A list of accepted values is defined in the lookup type ORA_WIS_WD_OUTPUT_MATERIAL. -
Quantity: number
Title:
Quantity
Read Only:true
Quantity of output expected to be produced by this operation. -
SecondaryQuantity: number
Title:
Secondary Quantity
Read Only:true
Output quantity expected to be produced by this operation in the secondary unit of measure. This attribute is associated with a feature that requires opt in. -
SecondaryUnitOfMeasure: string
Title:
Secondary UOM
Read Only:true
Secondary unit of measure of the output. This attribute is associated with a feature that requires opt in. -
SecondaryUOMCode: string
Title:
Secondary UOM Code
Read Only:true
Abbreviation that identifies the secondary unit of measure of the output. This attribute is associated with a feature that requires opt in. -
StandardOperationCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the user key to the standard operation. -
StandardOperationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the standard operation. The application generates this value. -
UnitOfMeasure: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Unit of measure of the output. -
UOMCode: string
Title:
UOM
Read Only:true
Maximum Length:3
Abbreviation that identifies the unit of measure of the output. -
WorkAreaCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the work area. This attribute uniquely identifies a work area within a manufacturing plant. -
WorkAreaDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the work area. -
WorkAreaId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work area. The application generates this value. -
WorkAreaName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the work area. -
WorkCenterCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the user key to the work center. -
WorkCenterDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the work center. -
WorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work center. The application generates this value. -
WorkCenterName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the work center. -
WorkDefinitionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work definition. This is used to enforce uniqueness of an output item across the work definition operations. -
WorkDefinitionOperationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the operation to which this operation output item is assigned. -
WorkDefinitionOperationOutputAttachment: array
Attachments for Outputs
Title:
Attachments for Outputs
The Attachments for Outputs resource gets the attachments that contain details about the output. -
WorkDefinitionOperationOutputDFF: array
Flexfields for Outputs
Title:
Flexfields for Outputs
The Flexfields for Outputs resource gets the descriptive flexfields that contain details about the output.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Attachments for Outputs
Type:
array
Title:
Attachments for Outputs
The Attachments for Outputs resource gets the attachments that contain details about the output.
Show Source
Nested Schema : Flexfields for Outputs
Type:
array
Title:
Flexfields for Outputs
The Flexfields for Outputs resource gets the descriptive flexfields that contain details about the output.
Show Source
Nested Schema : workDefinitions-WorkDefinitionOutput-WorkDefinitionOperationOutputAttachment-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the attachment of a work definition operation output. It is a primary key that the application generates when a document is attached to the work definition operation output. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Login that the user used when creating the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attachment record. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the current version of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the contents in the attachment are no longer available. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) that locates the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the user most recently updated the document that is attached to the work definition operation output. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Login of the user who updated the document that is attached to the work definition operation output. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the document that is attached to the work definition. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL (Uniform Resource Locator) that locates the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login that the user used when adding or modifying the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workDefinitions-WorkDefinitionOutput-WorkDefinitionOperationOutputDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:80
Descriptive flexfield context name for work definition operation output. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for work definition operation output. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
WdOperationOutputId: integer
(int64)
Value that uniquely identifies the work definition operation output. The application generates this value.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workDefinitions-WorkDefinitionResource-item-response
Type:
Show Source
object
-
AssignedUnits: number
Title:
Units Assigned
Read Only:true
Number of resource units the application assigns to perform the operation. -
BasisType: string
Title:
Basis
Read Only:true
Maximum Length:30
Default Value:2
Contains one of the following values: 1 or 2. If 1, then the resource consumption is fixed. It does not change according to work order quantity. If 2, then the resource consumption is not fixed. It might change according to work order quantity. This attribute does not have a default value. -
ChargeType: string
Title:
Charge Type
Read Only:true
Maximum Length:30
Contains one of the following values 1 or 2. If 1, then the user manually charges the resources. If 2, then the application automatically charges the resource when it completes the operation. This attribute does not have a default value. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created this record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the record was created. -
CurrentRevision: string
Maximum Length:
255
Value that uniquely identifies the current revision of the document item, which represents the current revision of the program file. -
EquipmentParameterFileContent: string
(byte)
Read Only:
true
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
Read Only:
true
Maximum Length:512
Name of the equipment parameter's flat file associated with the work definition operation's resource. -
EquipmentProfileCode: string
Read Only:
true
Maximum Length:255
Abbreviation that identifies the equipment profile associated with the work definition operation resource. This attribute is associated with a feature that requires opt in. -
EquipmentProfileId: integer
(int64)
Title:
Equipment Profile
Read Only:true
Value that uniquely identifies the equipment profile associated with the work definition operation resource. This attribute is associated with a feature that requires opt in. -
InverseUsageRate: number
Title:
Inverse Usage
Read Only:true
Rate that indicates the inverse resource usage. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when record was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OperationName: string
Title:
Name
Read Only:true
Maximum Length:120
Name of the operation. -
OperationSequenceNumber: number
Title:
Sequence
Read Only:true
Number that indicates the sequence to use when performing the work order operations. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory organization that the application enabled for manufacturing. It is a primary key that the application generates when it creates the inventory organization. -
PrincipalFlag: boolean
Title:
Principal
Read Only:true
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. If false, then the resource is not the principal resource. This attribute does not have a default value. -
ProfileCode: string
Read Only:
true
Maximum Length:255
Abbreviation that identifies the job profile associated with the work definition operation resource. This attribute is associated with a feature that requires opt in. -
ProfileId: integer
(int64)
Read Only:
true
Value that uniquely identifies the job profile associated with the work definition operation resource. This attribute is associated with a feature that requires opt in. -
ProgramFileId: integer
(int64)
Read Only:
true
Value that uniquely identifies the document item assigned to the master organization that represents the name of the program file used by the equipment. -
ProgramFileName: string
Maximum Length:
255
Value that uniquely identifies the document item that represents the program file. -
ResourceActivityCode: string
Title:
Activity
Read Only:true
Maximum Length:30
Abbreviation that identifies the resource activity. -
ResourceCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the resource. -
ResourceDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the resource. -
ResourceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the production resource. It is a primary key that the application generates when it consumes the production resource. -
ResourceName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the resource. -
ResourceSequenceNumber: number
Title:
Sequence
Read Only:true
Number that the application uses to determine the step in the sequence it must use to make sure resources work together correctly to finish the operation. If multiple resource lines include the same resource sequence number, then the application schedules them to occur at the same time. -
ResourceType: string
Title:
Type
Read Only:true
Maximum Length:30
Category of the resource. Values include Labor or Equipment. -
ScheduledIndicator: string
Title:
Scheduled
Read Only:true
Maximum Length:30
Contains one of the following values: Yes or No. If Yes, then scheduling schedules the resource and computes the start date and completion dates. If No, then scheduling does not schedule the resource and the application sets the start date equal to the completion date. This attribute does not have a default value. -
StandardOperationCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the standard operation. -
StandardOperationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the standard operation that the work definition operation references. It is a primary key that the application generates when it creates the standard operation. -
UnitOfMeasure: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Unit of measure that the resource uses. -
UOMCode: string
Title:
UOM
Read Only:true
Maximum Length:3
Abbreviation that identifies the unit of measure that the resource uses. -
UsageRate: number
Title:
Usage
Read Only:true
Rate of the resource that the plant requires to make each unit of the item. -
WorkAreaCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the work area. -
WorkAreaDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the work area. -
WorkAreaId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work area. It is a primary key that the application generates when it creates the work area. -
WorkAreaName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the work area. -
WorkCenterCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the work center. -
WorkCenterDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the work center. -
WorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work center. It is a primary key that the application generates when it creates the work center. -
WorkCenterName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the work center. -
WorkDefinitionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work definition. It is a primary key that the application generates when it creates the work definition. -
WorkDefinitionOperationAlternateResource: array
Alternate Resources
Title:
Alternate Resources
The Alternate Resources resource gets the alternate resources that the work definition operation uses. -
WorkDefinitionOperationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work definition operation. It is a primary key that the application generates when it creates the work definition operation. -
WorkDefinitionOperationResourceAttachment: array
Attachments for Resources
Title:
Attachments for Resources
The Attachments for Resources resource gets the attachments that contain details about the resource. -
WorkDefinitionOperationResourceDFF: array
Flexfields for Resources
Title:
Flexfields for Resources
The Flexfields for Resources resource gets the descriptive flexfields that contain details about the resource that the work definition operation uses. -
WorkDefinitionOperationResourceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the resource for the work definition operation. It is a primary key that the application generates when it creates the resource.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Alternate Resources
Type:
array
Title:
Alternate Resources
The Alternate Resources resource gets the alternate resources that the work definition operation uses.
Show Source
Nested Schema : Attachments for Resources
Type:
array
Title:
Attachments for Resources
The Attachments for Resources resource gets the attachments that contain details about the resource.
Show Source
Nested Schema : Flexfields for Resources
Type:
array
Title:
Flexfields for Resources
The Flexfields for Resources resource gets the descriptive flexfields that contain details about the resource that the work definition operation uses.
Show Source
Nested Schema : workDefinitions-WorkDefinitionResource-WorkDefinitionOperationAlternateResource-item-response
Type:
Show Source
object
-
AssignedUnits: number
Title:
Units Assigned
Read Only:true
Number of resource units the application assigns to perform the operation. -
CurrentRevision: string
Maximum Length:
255
Value that uniquely identifies the current revision of the document item, which represents the current revision of the program file. -
EquipmentParameterFileContent: string
(byte)
Read Only:
true
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
Read Only:
true
Maximum Length:512
Name of the equipment parameter's flat file associated with the work definition operation's alternate resource. -
InverseUsageRate: number
Title:
Inverse Usage
Read Only:true
Inverse of the usage rate. The application uses this inverse when the resource usage rate is a fraction, but the inverse of this rate is an integer. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PriorityRanking: number
Title:
Priority
Read Only:true
Ranking of the alternative resource to use instead of the primary resource. -
ProgramFileId: integer
(int64)
Read Only:
true
Value that uniquely identifies the document item assigned to the master organization that represents the name of the program file used by the equipment. -
ProgramFileName: string
Maximum Length:
255
Value that uniquely identifies the document item that represents the program file. -
ResourceCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the resource. -
ResourceDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the resource. -
ResourceId: integer
(int64)
Title:
Resource
Read Only:true
Value that uniquely identifies the production resource. It is a primary key that the application generates when it consumes the production resource. -
ResourceName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the resource. -
ResourceType: string
Title:
Type
Read Only:true
Maximum Length:30
Category of the resource. Values include Labor or Equipment. -
UnitOfMeasure: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Unit of measure that the resource uses. -
UOMCode: string
Title:
UOM
Read Only:true
Maximum Length:3
Abbreviation that identifies the unit of measure that the resource uses. -
UsageRate: number
Title:
Usage
Read Only:true
Resource usage that the plant requires to make each unit of the item. -
WdOperationAlternateResourceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the alternative resource of a work definition operation. It is a primary key that the application generates when it creates the alternative resource of a work definition operation. -
WdOperationResourceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the resource that the work definition operation consumes. It is a primary key that the application generates when it consumes the resource.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workDefinitions-WorkDefinitionResource-WorkDefinitionOperationResourceAttachment-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the attachment of a work definition operation output. It is a primary key that the application generates when a document is attached to the work definition operation output. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Login that the user used when creating the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attachment record. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the current version of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the contents in the attachment are no longer available. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) that locates the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the user most recently updated the document that is attached to the work definition operation output. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Login of the user who updated the document that is attached to the work definition operation output. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the document that is attached to the work definition. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL (Uniform Resource Locator) that locates the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login that the user used when adding or modifying the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workDefinitions-WorkDefinitionResource-WorkDefinitionOperationResourceDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Country Specific
Maximum Length:80
Descriptive flexfield context name for work definition operation resources. -
__FLEX_Context_DisplayValue: string
Title:
Country Specific
-
Discriminator: string
This is a transient attribute. The value of this attribute will always be null. Ignore this attribute.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
WdOperationResourceId: integer
(int64)
Value that uniquely identifies the resource that the work definition operation consumes. It is a primary key that the application generates when it consumes the resource.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- WorkDefinitionAttachment
-
Operation: /fscmRestApi/resources/11.13.18.05/workDefinitions/{WorkDefinitionId}/child/WorkDefinitionAttachmentParameters:
- WorkDefinitionId:
$request.path.WorkDefinitionId
The Attachments for Work Definitions resource gets the attachments that the work definition references. - WorkDefinitionId:
- WorkDefinitionMaterial
-
Operation: /fscmRestApi/resources/11.13.18.05/workDefinitions/{WorkDefinitionId}/child/WorkDefinitionMaterialParameters:
- WorkDefinitionId:
$request.path.WorkDefinitionId
The Work Definition Materials resource gets all the materials of a work definition across the operations. - WorkDefinitionId:
- WorkDefinitionOperation
-
Operation: /fscmRestApi/resources/11.13.18.05/workDefinitions/{WorkDefinitionId}/child/WorkDefinitionOperationParameters:
- WorkDefinitionId:
$request.path.WorkDefinitionId
The Operations resource gets the operations for the work definition. - WorkDefinitionId:
- WorkDefinitionOutput
-
Operation: /fscmRestApi/resources/11.13.18.05/workDefinitions/{WorkDefinitionId}/child/WorkDefinitionOutputParameters:
- WorkDefinitionId:
$request.path.WorkDefinitionId
The Work Definition Outputs resource gets all the outputs of a work definition across the operations. - WorkDefinitionId:
- WorkDefinitionResource
-
Operation: /fscmRestApi/resources/11.13.18.05/workDefinitions/{WorkDefinitionId}/child/WorkDefinitionResourceParameters:
- WorkDefinitionId:
$request.path.WorkDefinitionId
The Work Definition Resources resource gets all the resources of a work definition across the operations. - WorkDefinitionId:
Examples
This example describes how to get one work definition.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/workDefinitions/WorkDefinitionId"
For example, the following command gets work definition 300100071643009:
curl -u username:password "https://servername/fscmRestApi/resources/version/workDefinitions/300100071643009"
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "OrganizationId" : 207, "OrganizationCode" : "M1", "WorkDefinitionNameId" : 300100071642973, "WorkDefinitionName" : "PPS-CPU", "WorkDefinitionNameDescription" : "PPS-CPU", "WorkDefinitionCode" : "PPS-CPU", "UsedInPlanningFlag" : true, "SeededFlag" : false, "EffectiveFromDate" : "2015-12-01", "EffectiveToDate" : null, "WorkDefinitionId" : 300100071643009, "ProductionPriority" : 1, "CostingPriority" : null, "InventoryItemId" : 300100061374128, "WorkDefinitionVersionId" : 300100071643010, "VersionEffectiveFromDate" : "2015-12-01T10:03:39.935+00:00", "VersionEffectiveToDate" : null }