Get all materials
get
/fscmRestApi/resources/11.13.18.05/workDefinitions/{WorkDefinitionId}/child/WorkDefinitionOperation/{WorkDefinitionOperationId}/child/WorkDefinitionOperationMaterial
Request
Path Parameters
-
WorkDefinitionId(required): integer(int64)
Value that uniquely identifies the work definition. It is a primary key that the application generates when it creates the work definition.
-
WorkDefinitionOperationId(required): integer(int64)
Value that uniquely identifies the work definition operation. It is a primary key that the application generates when it creates the work definition operation.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: 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.
- PrimaryKey: Finds work definition operation materials according to the material identifier of the work definition operation as the primary key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- 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.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationMaterial
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationMaterial-item-response
Type:
Show Source
object
-
AdhocItemFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true or false. If true, then the material line is based on the item structure. If false, then the material line is not based on the item structure. This attribute does not have a default value. -
BasisType: string
Title:
Basis
Read Only:true
Maximum Length:30
Contains one of the following values: 1 or 2. If 1, then the application does not consider the quantity of the work order when it sets the component quantity that it requires for the parent assembly 2: the application varies the component quantity that it requires for the parent assembly according to the quantity of the work order. -
ComponentSequenceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item structure component (EGP_COMPONENTS_B) assigned to this operation. -
ComponentSequenceIdPath: string
(byte)
Read Only:
true
Value that uniquely identifies this component in the exploded ATO Model item structure. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created this record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the record was created. -
FindNumber: number
Title:
Find Number
Read Only:true
Unique identifier of a component that appears more than once in an item structure. -
InventoryItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the component. It is a primary key that the application generates when it creates the item. -
InverseQuantity: number
Title:
Inverse Quantity
Read Only:true
Inverse of the Quantity Per Product. The application uses the inverse when the Quantity Per Product for the material is a fraction, but the inverse of this quantity is an integer. -
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the component. -
ItemNumber: string
Read Only:
true
Maximum Length:300
Number that identifies the item. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when record was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaterialSequenceNumber: number
Title:
Sequence
Read Only:true
Number that indicates the unique sequence of the component assigned to the work definition operation. -
MaterialType: string
Read Only:
true
Maximum Length:30
Type of material of the items or components that the work definition operation references. Contains one of the following values: COMPONENT or PRIMARY_PRODUCT. COMPONENT: the material is a component that the application issues to the work order. PRIMARY_PRODUCT: the material is an assembly that is an output of a work order. -
OperationName: string
Title:
Name
Read Only:true
Maximum Length:120
Name of the operation. -
OperationSequenceNumber: number
Title:
Sequence
Read Only:true
Number that indicates the sequence to use when performing the work definition operation. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory organization that the application enabled for manufacturing. It is a primary key that the application generates when it creates the inventory organization. -
Quantity: number
Title:
Quantity
Read Only:true
Quantity required to make each unit of the item. -
SecondaryQuantity: number
Title:
Secondary Quantity
Read Only:true
Required component quantity in the secondary unit of measure. This attribute is associated with a feature that requires opt in. -
SecondaryUnitOfMeasure: string
Title:
Secondary UOM
Read Only:true
Secondary unit of measure of the component. This attribute is associated with a feature that requires opt in. -
SecondaryUOMCode: string
Title:
Secondary UOM Code
Read Only:true
Abbreviation that identifies the secondary unit of measure of the component. This attribute is associated with a feature that requires opt in. -
StandardOperationCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the standard operation. -
StandardOperationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the standard operation that the work definition operation references. It is a primary key that the application generates when it creates the standard operation. -
SupplyLocator: string
Read Only:
true
Maximum Length:255
Locator in subinventory to use, by default, when the plant uses material during assembly or an operation pull. -
SupplyLocatorId: integer
(int64)
Title:
Supply Locator
Read Only:true
Value that uniquely identifies the locator. It is a primary key that the application generates when it creates the locator. -
SupplySubinventory: string
Title:
Supply Subinventory
Read Only:true
Maximum Length:10
Subinventory to use, by default, when the plant uses material during assembly or an operation pull. -
SupplyType: string
Title:
Supply Type
Read Only:true
Maximum Length:30
Consumption of the material. Values include Assembly pull, Operation pull, Push, Bulk, or Supplier. -
SupplyTypeDescription: string
Read Only:
true
Maximum Length:255
Description of the supply type. -
UnitOfMeasure: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Unit of measure that the component uses. It is the primary unit of measure of the item. -
UOMCode: string
Title:
UOM Code
Read Only:true
Maximum Length:3
Abbreviation that identifies the unit of measure that the component uses. -
WorkAreaCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the work area. -
WorkAreaDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the work area. -
WorkAreaId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work area. It is a primary key that the application generates when it creates the work area. -
WorkAreaName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the work area. -
WorkCenterCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the work center. -
WorkCenterDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the work center. -
WorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work center. It is a primary key that the application generates when it creates the work center. -
WorkCenterName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the work center. -
WorkDefinitionId: integer
(int64)
Read Only:
true
Default Value:1
Value that uniquely identifies the work definition. It is a primary key that the application generates when it creates the work definition. -
WorkDefinitionOperationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work definition operation. It is a primary key that the application generates when it creates the work definition operation. -
WorkDefinitionOperationMaterialAttachment: array
Attachments for Materials
Title:
Attachments for Materials
The Attachments for Materials resource gets the attachments that contain details about the material. -
WorkDefinitionOperationMaterialDFF: array
Flexfields for Materials
Title:
Flexfields for Materials
The Flexfields for Materials resource gets the descriptive flexfields that contain details about the material. -
WorkDefinitionOperationMaterialId: integer
(int64)
Read Only:
true
Value that uniquely identifies the material for the work definition operation. It is a primary key that the application generates when it creates the material. -
WorkDefinitionOperationSubstituteMaterial: array
Substitute Materials
Title:
Substitute Materials
The Substitute Materials resource gets the substitute materials that the work definition operation uses. -
YieldFactor: number
Read Only:
true
Factor to use when calculating the quantity that the operation requires to accommodate component waste when it processes the item. It is recommended that you set the yield to between 0 and 1. You can set the yield to a value that is greater than 1. The application considers the yield when it calculates the required quantity according to the Include plant parameter for the component yield.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Attachments for Materials
Type:
array
Title:
Attachments for Materials
The Attachments for Materials resource gets the attachments that contain details about the material.
Show Source
Nested Schema : Flexfields for Materials
Type:
array
Title:
Flexfields for Materials
The Flexfields for Materials resource gets the descriptive flexfields that contain details about the material.
Show Source
Nested Schema : Substitute Materials
Type:
array
Title:
Substitute Materials
The Substitute Materials resource gets the substitute materials that the work definition operation uses.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationMaterial-WorkDefinitionOperationMaterialAttachment-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the attachment of a work definition operation output. It is a primary key that the application generates when a document is attached to the work definition operation output. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Login that the user used when creating the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attachment record. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the current version of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the contents in the attachment are no longer available. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) that locates the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the user most recently updated the document that is attached to the work definition operation output. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Login of the user who updated the document that is attached to the work definition operation output. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the document that is attached to the work definition. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL (Uniform Resource Locator) that locates the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login that the user used when adding or modifying the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationMaterial-WorkDefinitionOperationMaterialDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:80
Descriptive flexfield context name for work definition operation materials. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
Discriminator: string
This is a transient attribute. The value of this attribute will always be null. Ignore this attribute.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
WdOperationMaterialId: integer
(int64)
Value that uniquely identifies the material that the work definition operation consumes. It is a primary key that the application generates when it consumes the material.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationMaterial-WorkDefinitionOperationSubstituteMaterial-item-response
Type:
Show Source
object
-
ComponentSequenceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the sequence of the substitute component that the application assigns to the material that the work definition operation consumes. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PriorityRanking: number
Read Only:
true
Ranking of the substitute component to use instead of the primary component. -
SubstituteComponentId: integer
(int64)
Read Only:
true
Value that uniquely identifies the substitute component. It is a primary key that the application generates when it creates the item. -
SubstituteInverseQuantity: number
Read Only:
true
Inverse of the Quantity Per Product attribute. The application uses the inverse when the Quantity Per Product for the material is a fraction, but the inverse of this quantity is an integer. -
SubstituteItemQuantity: number
Read Only:
true
Quantity required to make each unit of the item. -
WdOperationMaterialId: integer
(int64)
Read Only:
true
Value that uniquely identifies the material for a work definition operation. It is a primary key that the application generates when it consumes the material. -
WdOperationSubstituteMaterialId: integer
(int64)
Read Only:
true
Value that uniquely identifies the substitute material for a work definition operation. It is a primary key that the application generates when it consumes the substitute material.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source