Get all work definitions

get

/fscmRestApi/resources/11.13.18.05/workDefinitions

Request

Query Parameters
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds work definitions according to the work definition identifier as the primary key.
      Finder Variables:
      • WorkDefinitionId; integer; Value that uniquely identifies the work definition. It is a primary key that the application generates when it creates the work definition. This attribute is required.
    • findByMaterialItemId: Finds work definitions according to the component identifier as the primary key.
      Finder Variables:
      • InventoryItemId; integer; Value that uniquely identifies the component. It is a primary key that the application generates when it creates the item. This attribute is required.
    • findByOSPItemId: Finds work definitions according to the identifier of the outside processing item as the primary key.
      Finder Variables:
      • OSPItemId; integer; Value that uniquely identifies the outside processing item. It is a primary key that the application generates when it creates the item. This attribute is required.
    • findByOutputItemId: Finds the work definition according to the output as the primary key.
      Finder Variables:
      • OutputItemId; integer; Value that uniquely identifies the output item. It is a primary key that the application generates when you create output item. This attribute is required.
    • findByResourceId: Finds work definitions according to the resource identifier as the primary key.
      Finder Variables:
      • ResourceId; integer; Value that uniquely identifies the production resource. It is a primary key that the application generates when it creates the production resource. This attribute is required.
    • findBySupplierId: Finds work definitions according to the supplier identifier as the primary key.
      Finder Variables:
      • SupplierId; integer; Value that uniquely identifies the supplier. It is a primary key that the application generates when it creates the supplier. This attribute is required.
    • findBySupplierSiteId: Finds work definitions according to the supplier site identifier as the primary key.
      Finder Variables:
      • SupplierSiteId; integer; Value that uniquely identifies the supplier site. It is a primary key that the application generates when it creates the supplier site. This attribute is required.
    • findByWorkAreaId: Finds work definitions according to the work area identifier as the primary key.
      Finder Variables:
      • WorkAreaId; integer; Value that uniquely identifies the work area. It is a primary key that the application generates when it creates the work area. This attribute is required.
    • findByWorkCenterId: Finds work definitions according to the work center identifier as the primary key.
      Finder Variables:
      • WorkCenterId; integer; Value that uniquely identifies the work center. It is a primary key that the application generates when it creates the work center. This attribute is required.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • BatchQuantity; number; Quantity of the batch.
    • BatchUOMCode; string; Unit of measure of the batch.
    • CompletionLocator; string; Value that indicates the completion locator to use by default when considering the work order for product completion.
    • CompletionLocatorId; integer; Value that uniquely identifies the completion locator.
    • CompletionSubinventoryCode; string; Abbreviation that indicates the completion subinventory to use by default when considering the work order for product completion.
    • CostingBatchOutputSize; number; Assumed batch size for the purposes of computing a standard cost.
    • CostingPriority; number; Priority to use when determining which work definition to use when rolling up costs during a planning scenario.
    • CreatedBy; string; User who created this record.
    • CreationDate; string; Date and time when the record was created.
    • EffectiveFromDate; string; Date and time when the work definition becomes available.
    • EffectiveToDate; string; Date and time when the work definition is no longer available.
    • InventoryItemId; integer; Value that uniquely identifies the item, product, or assembly in the inventory organization.
    • ItemDescription; string; Description of the inventory item.
    • ItemNumber; string; Number that identifies the inventory item.
    • ItemStructureId; integer; Value that uniquely identifies the item structure used to define material requirements.
    • ItemStructureName; string; Description of the item structure.
    • ItemStructureType; string; Type of the item structure.
    • LastUpdateDate; string; Date when the record was most recently updated.
    • LastUpdatedBy; string; User who most recently updated the record.
    • MinimumTransferQuantity; number; Minimum transfer quantity defined for an item to schedule overlapping and sequential operations of work orders.
    • OrganizationCode; string; Abbreviation that identifies the inventory organization that comes enabled for manufacturing.
    • OrganizationId; integer; 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; 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; Name of the process. This is unique across all work definitions in the inventory organizations.
    • ProductionPriority; number; Priority that planning uses to determine which work definition to use when planning a manufacturing run.
    • SeededFlag; boolean; 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; 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.
    • StatusCode; string; Abbreviation that identifies the work definition status.
    • SystemGeneratedFlag; boolean; 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; Value that uniquely identifies the assembly item that is being transformed to a new assembly item on a transform work definition.
    • TransformFromItemNumber; string; Number that identifies the transfer item.
    • UsedInPlanningFlag; boolean; 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 and time when the work definition version becomes available.
    • VersionEffectiveToDate; string; Date and time when the work definition version is no longer available.
    • VersionNumber; string; Number that indicates the version of the work definition.
    • WorkDefinitionCode; string; Abbreviation that identifies the work definition.
    • WorkDefinitionId; integer; Value that uniquely identifies the work definition. It is a primary key that the application generates when it creates the work definition.
    • WorkDefinitionName; string; 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.
    • WorkDefinitionNameId; integer; Value that uniquely identifies the work definition name. It is a primary key that the application generates when it creates a work definition name.
    • WorkDefinitionTypeCode; string; 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; 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; Abbreviation that identifies the user key to the work method.
    • WorkMethodDescription; string; Description of the work method.
    • WorkMethodId; integer; Value that identifies the work method for which this work definition is applicable.
    • WorkMethodName; string; Name of the work method.
    • WorkOrderSubType; string; Subtype of default work order used during work order creation.
    • WorkOrderSubTypeCode; string; Abbreviation that identifies the subtype of default work order used during work order creation.
    • WorkOrderType; string; Type of default work order used during work order creation.
    • WorkOrderTypeCode; string; Abbreviation that identifies the type of default work order used during work order creation.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : workDefinitions
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : workDefinitions-item-response
Type: object
Show Source
  • Title: Batch Quantity
    Quantity of the batch.
  • Title: UOM
    Maximum Length: 3
    Unit of measure of the batch.
  • Read Only: true
    Maximum Length: 255
    Value that indicates the completion locator to use by default when considering the work order for product completion.
  • Title: Completion Locator
    Read Only: true
    Value that uniquely identifies the completion locator.
  • 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.
  • Title: Costing Batch Output Size
    Read Only: true
    Assumed batch size for the purposes of computing a standard cost.
  • Title: Costing Priority
    Read Only: true
    Priority to use when determining which work definition to use when rolling up costs during a planning scenario.
  • Read Only: true
    Maximum Length: 64
    User who created this record.
  • Read Only: true
    Date and time when the record was created.
  • Title: Cumulative Yield
    Read Only: true
    Indicates the cumulative yield of the work definition operations that represent the percentage of the starting quantity that's yielded on completion of the last operation.
  • Read Only: true
    Date and time when the work definition becomes available.
  • Read Only: true
    Date and time when the work definition is no longer available.
  • Read Only: true
    Date when the work definition became inactive.
  • Read Only: true
    Value that uniquely identifies the item, product, or assembly in the inventory organization.
  • Title: Item Description
    Read Only: true
    Maximum Length: 240
    Description of the inventory item.
  • Read Only: true
    Maximum Length: 300
    Number that identifies the inventory item.
  • Read Only: true
    Value that uniquely identifies the item structure used to define material requirements.
  • Title: Display Name
    Read Only: true
    Maximum Length: 80
    Description of the item structure.
  • Title: Internal Name
    Read Only: true
    Maximum Length: 30
    Type of the item structure.
  • Read Only: true
    Date when the record was most recently updated.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the record.
  • Links
  • Title: Minimum Transfer Quantity
    Minimum transfer quantity defined for an item to schedule overlapping and sequential operations of work orders.
  • Read Only: true
    Maximum Length: 18
    Abbreviation that identifies the inventory organization that comes enabled for manufacturing.
  • 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.
  • 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.
  • Title: Name
    Maximum Length: 120
    Name of the process. This is unique across all work definitions in the inventory organizations.
  • Title: Production Priority
    Read Only: true
    Priority that planning uses to determine which work definition to use when planning a manufacturing run.
  • 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.
  • 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.
  • Read Only: true
    Maximum Length: 255
    Status of the work definition. Valid values are Active and Inactive.
  • Title: Work Definition Status
    Read Only: true
    Maximum Length: 30
    Default Value: ACTIVE
    Abbreviation that identifies the work definition status.
  • 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.
  • Read Only: true
    Value that uniquely identifies the assembly item that is being transformed to a new assembly item on a transform work definition.
  • Read Only: true
    Maximum Length: 300
    Number that identifies the transfer item.
  • 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.
  • Title: Start Date
    Read Only: true
    Date and time when the work definition version becomes available.
  • Title: End Date
    Read Only: true
    Date and time when the work definition version is no longer available.
  • Title: Version
    Read Only: true
    Maximum Length: 10
    Number that indicates the version of the work definition.
  • Attachments for Work Definitions
    Title: Attachments for Work Definitions
    The Attachments for Work Definitions resource gets the attachments that the work definition references.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the work definition.
  • 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.
  • Work Definition Materials
    Title: Work Definition Materials
    The Work Definition Materials resource gets all the materials of a work definition across the operations.
  • 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.
  • Read Only: true
    Maximum Length: 240
    Description of the work definition.
  • 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.
  • Work Definition Operations
    Title: Work Definition Operations
    The Operations resource gets the operations for the work definition.
  • Work Definition Outputs
    Title: Work Definition Outputs
    The Work Definition Outputs resource gets all the outputs of a work definition across the operations.
  • Work Definition Resources
    Title: Work Definition Resources
    The Work Definition Resources resource gets all the resources of a work definition across the operations.
  • Read Only: true
    Maximum Length: 255
    Description of the work definition type.
  • 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.
  • 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.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the user key to the work method.
  • Read Only: true
    Maximum Length: 240
    Description of the work method.
  • Read Only: true
    Value that identifies the work method for which this work definition is applicable.
  • Title: Work Method
    Read Only: true
    Maximum Length: 80
    Name of the work method.
  • Title: Subtype
    Read Only: true
    Maximum Length: 80
    Subtype of default work order used during work order creation.
  • Title: Code
    Maximum Length: 80
    Abbreviation that identifies the subtype of default work order used during work order creation.
  • Title: Type
    Read Only: true
    Maximum Length: 80
    Type of default work order used during work order creation.
  • Title: Code
    Maximum Length: 80
    Abbreviation that identifies the type of default work order used during work order creation.
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 : workDefinitions-WorkDefinitionAttachment-item-response
Type: object
Show Source
Nested Schema : workDefinitions-WorkDefinitionMaterial-item-response
Type: object
Show Source
  • 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.
  • 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.
  • Read Only: true
    Value that uniquely identifies the item structure component (EGP_COMPONENTS_B) assigned to this operation.
  • Read Only: true
    Value that uniquely identifies this component in the exploded ATO Model item structure.
  • Read Only: true
    Maximum Length: 64
    User who created this record.
  • Read Only: true
    Date and time when the record was created.
  • Title: Find Number
    Read Only: true
    Unique identifier of a component that appears more than once in an item structure.
  • Read Only: true
    Value that uniquely identifies the component. It is a primary key that the application generates when it creates the item.
  • 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.
  • Title: Item Description
    Read Only: true
    Maximum Length: 240
    Description of the component.
  • Read Only: true
    Maximum Length: 300
    Number that identifies the item.
  • Read Only: true
    Date when record was most recently updated.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the record.
  • Links
  • Title: Sequence
    Read Only: true
    Number that indicates the unique sequence of the component assigned to the work definition operation.
  • 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.
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name of the operation.
  • Title: Sequence
    Read Only: true
    Number that indicates the sequence to use when performing the work definition operation.
  • 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.
  • Title: Quantity
    Read Only: true
    Quantity required to make each unit of the item.
  • 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.
  • Title: Secondary UOM
    Read Only: true
    Secondary unit of measure of the component. This attribute is associated with a feature that requires opt in.
  • 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.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the standard operation.
  • 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.
  • Read Only: true
    Maximum Length: 255
    Locator in subinventory to use, by default, when the plant uses material during assembly or an operation pull.
  • 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.
  • 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.
  • Title: Supply Type
    Read Only: true
    Maximum Length: 30
    Consumption of the material. Values include Assembly pull, Operation pull, Push, Bulk, or Supplier.
  • Read Only: true
    Maximum Length: 255
    Description of the supply type.
  • 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.
  • Title: UOM Code
    Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the unit of measure that the component uses.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the work area.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the work area.
  • 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.
  • Title: Name
    Read Only: true
    Maximum Length: 80
    Name of the work area.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the work center.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the 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.
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name of the work center.
  • 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.
  • 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.
  • Attachments for Materials
    Title: Attachments for Materials
    The Attachments for Materials resource gets the attachments that contain details about the material.
  • Flexfields for Materials
    Title: Flexfields for Materials
    The Flexfields for Materials resource gets the descriptive flexfields that contain details about the material.
  • 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.
  • Substitute Materials
    Title: Substitute Materials
    The Substitute Materials resource gets the substitute materials that the work definition operation uses.
  • 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 : 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: object
Show Source
Nested Schema : workDefinitions-WorkDefinitionMaterial-WorkDefinitionOperationMaterialDFF-item-response
Type: object
Show Source
Nested Schema : workDefinitions-WorkDefinitionMaterial-WorkDefinitionOperationSubstituteMaterial-item-response
Type: object
Show Source
  • 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
  • Read Only: true
    Ranking of the substitute component to use instead of the primary component.
  • Read Only: true
    Value that uniquely identifies the substitute component. It is a primary key that the application generates when it creates the item.
  • 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.
  • Read Only: true
    Quantity required to make each unit of the item.
  • 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.
  • 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 : workDefinitions-WorkDefinitionOperation-item-response
Type: object
Show Source
  • 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.
  • 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.
  • 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.
  • Read Only: true
    Maximum Length: 64
    User who created this record.
  • Read Only: true
    Date and time when the record was created.
  • Title: Start Date
    Read Only: true
    Date when the operation is effective.
  • Title: End Date
    Read Only: true
    Date when the operation is no longer effective.
  • Title: Fixed
    Read Only: true
    Lead time to perform this outside processing (OSP) operation for each unit of the outside processing item.
  • Read Only: true
    Date when the record was most recently updated.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the record.
  • 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.
  • Read Only: true
    Maximum Length: 255
    Name of the unit of measure that the lead time uses for the supplier operation.
  • 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
  • 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.
  • 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.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the operation.
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name of the operation.
  • Title: Sequence
    Read Only: true
    Number that indicates the sequence to use when performing the work order operations.
  • 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.
  • Read Only: true
    Maximum Length: 255
    Description of the operation type.
  • Title: Operation Yield
    Read Only: true
    Indicates the yield factor of an operation that represents the percentage of the starting quantity that's yielded on completion of the operation.
  • 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.
  • 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.
  • 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.
  • 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.
  • Read Only: true
    Maximum Length: 300
    Description of the outside processing (OSP) item.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the standard operation.
  • 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.
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name of the standard operation.
  • Title: Supplier
    Read Only: true
    Name of the outside processing (OSP) supplier.
  • 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.
  • Read Only: true
    Maximum Length: 255
    Lead time to perform this outside processing (OSP) operation, independent of the quantity of the outside processing item.
  • Title: Supplier Site
    Read Only: true
    Description of the supplier site.
  • Translations for Operations
    Title: Translations for Operations
    The Translations for Operations resource gets the translations for operation name and operation description.
  • Title: Variable
    Read Only: true
    Abbreviation that identifies the unit of measure that the lead time uses.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the work area.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the work area.
  • 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.
  • Title: Name
    Read Only: true
    Maximum Length: 80
    Name of the work area.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the work center.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the work center.
  • 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.
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name of the work center.
  • 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.
  • Attachments for Operations
    Title: Attachments for Operations
    The Attachments for Operations resource gets the attachments that the work definition operation uses.
  • Flexfields for Operations
    Title: Flexfields for Operations
    The Flexfields for Operations resource gets the descriptive flexfields that contain details about the work definition operation.
  • 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.
  • Materials for Operations
    Title: Materials for Operations
    The Materials for Operations gets the materials that the work definition operation uses.
  • Outputs for Operations
    Title: Outputs for Operations
    The Outputs for Operations gets the output that the work definition operation uses.
  • Resources for Operations
    Title: Resources for Operations
    The Resources for Operations resource gets the resources that the work definition operation uses.
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: object
Show Source
Nested Schema : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationAttachment-item-response
Type: object
Show Source
Nested Schema : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationDFF-item-response
Type: object
Show Source
Nested Schema : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationMaterial-item-response
Type: object
Show Source
  • 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.
  • 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.
  • Read Only: true
    Value that uniquely identifies the item structure component (EGP_COMPONENTS_B) assigned to this operation.
  • Read Only: true
    Value that uniquely identifies this component in the exploded ATO Model item structure.
  • Read Only: true
    Maximum Length: 64
    User who created this record.
  • Read Only: true
    Date and time when the record was created.
  • Title: Find Number
    Read Only: true
    Unique identifier of a component that appears more than once in an item structure.
  • Read Only: true
    Value that uniquely identifies the component. It is a primary key that the application generates when it creates the item.
  • 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.
  • Title: Item Description
    Read Only: true
    Maximum Length: 240
    Description of the component.
  • Read Only: true
    Maximum Length: 300
    Number that identifies the item.
  • Read Only: true
    Date when record was most recently updated.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the record.
  • Links
  • Title: Sequence
    Read Only: true
    Number that indicates the unique sequence of the component assigned to the work definition operation.
  • 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.
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name of the operation.
  • Title: Sequence
    Read Only: true
    Number that indicates the sequence to use when performing the work definition operation.
  • 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.
  • Title: Quantity
    Read Only: true
    Quantity required to make each unit of the item.
  • 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.
  • Title: Secondary UOM
    Read Only: true
    Secondary unit of measure of the component. This attribute is associated with a feature that requires opt in.
  • 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.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the standard operation.
  • 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.
  • Read Only: true
    Maximum Length: 255
    Locator in subinventory to use, by default, when the plant uses material during assembly or an operation pull.
  • 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.
  • 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.
  • Title: Supply Type
    Read Only: true
    Maximum Length: 30
    Consumption of the material. Values include Assembly pull, Operation pull, Push, Bulk, or Supplier.
  • Read Only: true
    Maximum Length: 255
    Description of the supply type.
  • 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.
  • Title: UOM Code
    Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the unit of measure that the component uses.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the work area.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the work area.
  • 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.
  • Title: Name
    Read Only: true
    Maximum Length: 80
    Name of the work area.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the work center.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the 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.
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name of the work center.
  • 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.
  • 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.
  • Attachments for Materials
    Title: Attachments for Materials
    The Attachments for Materials resource gets the attachments that contain details about the material.
  • Flexfields for Materials
    Title: Flexfields for Materials
    The Flexfields for Materials resource gets the descriptive flexfields that contain details about the material.
  • 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.
  • Substitute Materials
    Title: Substitute Materials
    The Substitute Materials resource gets the substitute materials that the work definition operation uses.
  • 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 : 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: object
Show Source
Nested Schema : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationMaterial-WorkDefinitionOperationMaterialDFF-item-response
Type: object
Show Source
Nested Schema : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationMaterial-WorkDefinitionOperationSubstituteMaterial-item-response
Type: object
Show Source
  • 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
  • Read Only: true
    Ranking of the substitute component to use instead of the primary component.
  • Read Only: true
    Value that uniquely identifies the substitute component. It is a primary key that the application generates when it creates the item.
  • 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.
  • Read Only: true
    Quantity required to make each unit of the item.
  • 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.
  • 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 : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationOutput-item-response
Type: object
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: object
Show Source
Nested Schema : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationOutput-WorkDefinitionOperationOutputDFF-item-response
Type: object
Show Source
Nested Schema : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationResource-item-response
Type: object
Show Source
  • Title: Units Assigned
    Read Only: true
    Number of resource units the application assigns to perform the operation.
  • 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.
  • 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.
  • Read Only: true
    Maximum Length: 64
    User who created this record.
  • Read Only: true
    Date and time when the record was created.
  • Maximum Length: 255
    Value that uniquely identifies the current revision of the document item, which represents the current revision of the program file.
  • 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.
  • Read Only: true
    Maximum Length: 512
    Name of the equipment parameter's flat file associated with the work definition operation's resource.
  • 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.
  • 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.
  • Title: Inverse Usage
    Read Only: true
    Rate that indicates the inverse resource usage.
  • Read Only: true
    Date when record was most recently updated.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the record.
  • Links
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name of the operation.
  • Title: Sequence
    Read Only: true
    Number that indicates the sequence to use when performing the work order operations.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Maximum Length: 255
    Value that uniquely identifies the document item that represents the program file.
  • Title: Activity
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the resource activity.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the resource.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the 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.
  • Title: Name
    Read Only: true
    Maximum Length: 80
    Name of the resource.
  • 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.
  • Title: Type
    Read Only: true
    Maximum Length: 30
    Category of the resource. Values include Labor or Equipment.
  • 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.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the standard operation.
  • 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.
  • Title: UOM Name
    Read Only: true
    Maximum Length: 25
    Unit of measure that the resource uses.
  • Title: UOM
    Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the unit of measure that the resource uses.
  • Title: Usage
    Read Only: true
    Rate of the resource that the plant requires to make each unit of the item.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the work area.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the work area.
  • 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.
  • Title: Name
    Read Only: true
    Maximum Length: 80
    Name of the work area.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the work center.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the 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.
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name of the work center.
  • 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.
  • Alternate Resources
    Title: Alternate Resources
    The Alternate Resources resource gets the alternate resources that the work definition operation uses.
  • 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.
  • Attachments for Resources
    Title: Attachments for Resources
    The Attachments for Resources resource gets the attachments that contain details about the resource.
  • 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.
  • 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 : 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: object
Show Source
  • Title: Units Assigned
    Read Only: true
    Number of resource units the application assigns to perform the operation.
  • Maximum Length: 255
    Value that uniquely identifies the current revision of the document item, which represents the current revision of the program file.
  • 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.
  • Read Only: true
    Maximum Length: 512
    Name of the equipment parameter's flat file associated with the work definition operation's alternate resource.
  • 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
  • Title: Priority
    Read Only: true
    Ranking of the alternative resource to use instead of the primary resource.
  • 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.
  • Maximum Length: 255
    Value that uniquely identifies the document item that represents the program file.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the resource.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the resource.
  • 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.
  • Title: Name
    Read Only: true
    Maximum Length: 80
    Name of the resource.
  • Title: Type
    Read Only: true
    Maximum Length: 30
    Category of the resource. Values include Labor or Equipment.
  • Title: UOM Name
    Read Only: true
    Maximum Length: 25
    Unit of measure that the resource uses.
  • Title: UOM
    Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the unit of measure that the resource uses.
  • Title: Usage
    Read Only: true
    Resource usage that the plant requires to make each unit of the item.
  • 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.
  • 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 : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationResource-WorkDefinitionOperationResourceAttachment-item-response
Type: object
Show Source
Nested Schema : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationResource-WorkDefinitionOperationResourceDFF-item-response
Type: object
Show Source
Nested Schema : workDefinitions-WorkDefinitionOutput-item-response
Type: object
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: object
Show Source
Nested Schema : workDefinitions-WorkDefinitionOutput-WorkDefinitionOperationOutputDFF-item-response
Type: object
Show Source
Nested Schema : workDefinitions-WorkDefinitionResource-item-response
Type: object
Show Source
  • Title: Units Assigned
    Read Only: true
    Number of resource units the application assigns to perform the operation.
  • 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.
  • 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.
  • Read Only: true
    Maximum Length: 64
    User who created this record.
  • Read Only: true
    Date and time when the record was created.
  • Maximum Length: 255
    Value that uniquely identifies the current revision of the document item, which represents the current revision of the program file.
  • 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.
  • Read Only: true
    Maximum Length: 512
    Name of the equipment parameter's flat file associated with the work definition operation's resource.
  • 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.
  • 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.
  • Title: Inverse Usage
    Read Only: true
    Rate that indicates the inverse resource usage.
  • Read Only: true
    Date when record was most recently updated.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the record.
  • Links
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name of the operation.
  • Title: Sequence
    Read Only: true
    Number that indicates the sequence to use when performing the work order operations.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Maximum Length: 255
    Value that uniquely identifies the document item that represents the program file.
  • Title: Activity
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the resource activity.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the resource.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the 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.
  • Title: Name
    Read Only: true
    Maximum Length: 80
    Name of the resource.
  • 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.
  • Title: Type
    Read Only: true
    Maximum Length: 30
    Category of the resource. Values include Labor or Equipment.
  • 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.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the standard operation.
  • 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.
  • Title: UOM Name
    Read Only: true
    Maximum Length: 25
    Unit of measure that the resource uses.
  • Title: UOM
    Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the unit of measure that the resource uses.
  • Title: Usage
    Read Only: true
    Rate of the resource that the plant requires to make each unit of the item.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the work area.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the work area.
  • 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.
  • Title: Name
    Read Only: true
    Maximum Length: 80
    Name of the work area.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the work center.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the 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.
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name of the work center.
  • 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.
  • Alternate Resources
    Title: Alternate Resources
    The Alternate Resources resource gets the alternate resources that the work definition operation uses.
  • 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.
  • Attachments for Resources
    Title: Attachments for Resources
    The Attachments for Resources resource gets the attachments that contain details about the resource.
  • 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.
  • 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 : 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: object
Show Source
  • Title: Units Assigned
    Read Only: true
    Number of resource units the application assigns to perform the operation.
  • Maximum Length: 255
    Value that uniquely identifies the current revision of the document item, which represents the current revision of the program file.
  • 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.
  • Read Only: true
    Maximum Length: 512
    Name of the equipment parameter's flat file associated with the work definition operation's alternate resource.
  • 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
  • Title: Priority
    Read Only: true
    Ranking of the alternative resource to use instead of the primary resource.
  • 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.
  • Maximum Length: 255
    Value that uniquely identifies the document item that represents the program file.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the resource.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the resource.
  • 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.
  • Title: Name
    Read Only: true
    Maximum Length: 80
    Name of the resource.
  • Title: Type
    Read Only: true
    Maximum Length: 30
    Category of the resource. Values include Labor or Equipment.
  • Title: UOM Name
    Read Only: true
    Maximum Length: 25
    Unit of measure that the resource uses.
  • Title: UOM
    Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the unit of measure that the resource uses.
  • Title: Usage
    Read Only: true
    Resource usage that the plant requires to make each unit of the item.
  • 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.
  • 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 : workDefinitions-WorkDefinitionResource-WorkDefinitionOperationResourceAttachment-item-response
Type: object
Show Source
Nested Schema : workDefinitions-WorkDefinitionResource-WorkDefinitionOperationResourceDFF-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all work definitions.

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"

Example Response Body

The following example includes the contents of the response body in JSON format:

"{
  "items" : [ {
    "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
  }, {
...
  } ],
...
}"
Back to Top