Get all materials

get

/fscmRestApi/resources/11.13.18.05/workDefinitions/{WorkDefinitionId}/child/WorkDefinitionOperation/{WorkDefinitionOperationId}/child/WorkDefinitionOperationMaterial

Request

Path Parameters
Query Parameters
  • 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>
  • 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 definition operation materials according to the material identifier of the work definition operation as the primary key.
      Finder Variables:
      • WorkDefinitionOperationMaterialId; integer; Value that uniquely identifies the material for the work definition operation. It is the primary key. This attribute is required.
    • findByVersionIdAndWorkDefinitionAsOfDate: Finds operation materials of a work definition according to the version ID and the as-of-date attribute of the work definition.
      Finder Variables:
      • VersionId; integer; Value that uniquely identifies the version ID of a work definition.
      • WorkDefinitionAsOfDate; string; Value that uniquely identifies the as-of-date attribute of a work definition.
  • 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:
    • AdhocItemFlag; boolean; 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; 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.
    • CreatedBy; string; User who created this record.
    • CreationDate; string; Date and time when the record was created.
    • FindNumber; number; Unique identifier of a component that appears more than once in an item structure.
    • InventoryItemId; integer; Value that uniquely identifies the component. It is a primary key that the application generates when it creates the item.
    • ItemNumber; string; Number that identifies the item.
    • LastUpdateDate; string; Date when record was most recently updated.
    • LastUpdatedBy; string; User who most recently updated the record.
    • MaterialSequenceNumber; number; Number that indicates the unique sequence of the component assigned to the work definition operation.
    • MaterialType; string; 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.
    • OperationSequenceNumber; number; Number that indicates the sequence to use when performing the work definition operation.
    • OrganizationId; integer; 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.
    • SecondaryQuantity; number; Required component quantity in the secondary unit of measure. This attribute is associated with a feature that requires opt in.
    • SecondaryUOMCode; string; Abbreviation that identifies the secondary unit of measure of the component. This attribute is associated with a feature that requires opt in.
    • SecondaryUnitOfMeasure; string; Secondary unit of measure of the component. This attribute is associated with a feature that requires opt in.
    • StandardOperationCode; string; Abbreviation that identifies the standard operation.
    • StandardOperationId; integer; 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; Locator in subinventory to use, by default, when the plant uses material during assembly or an operation pull.
    • SupplyLocatorId; integer; Value that uniquely identifies the locator. It is a primary key that the application generates when it creates the locator.
    • SupplySubinventory; string; Subinventory to use, by default, when the plant uses material during assembly or an operation pull.
    • SupplyType; string; Consumption of the material. Values include Assembly pull, Operation pull, Push, Bulk, or Supplier.
    • WorkAreaCode; string; Abbreviation that identifies the work area.
    • WorkAreaId; integer; Value that uniquely identifies the work area. It is a primary key that the application generates when it creates the work area.
    • WorkCenterCode; string; Abbreviation that identifies the work center.
    • WorkCenterId; integer; Value that uniquely identifies the work center. It is a primary key that the application generates when it creates the work center.
    • WorkDefinitionId; integer; Value that uniquely identifies the work definition. It is a primary key that the application generates when it creates the work definition.
    • WorkDefinitionOperationId; integer; Value that uniquely identifies the work definition operation. It is a primary key that the application generates when it creates the work definition operation.
    • WorkDefinitionOperationMaterialId; integer; 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.
    • YieldFactor; number; Factor to use when calculating the quantity that the operation requires to accommodate component waste when it processes the item. It is recommended that you set the yield to between 0 and 1. You can set the yield to a value that is greater than 1. The application considers the yield when it calculates the required quantity according to the Include plant parameter for the component yield.
  • 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-WorkDefinitionOperation-WorkDefinitionOperationMaterial
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
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: 80
    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.
Back to Top