GetMaterial
- Last UpdatedOct 05, 2022
- 1 minute read
The GetMaterial method returns a full or filtered list of materials. When only the user credentials are specified in the GetMaterial request, the entire material list is returned.
You can also return a filtered list of materials that is filtered by one of the following properties:
-
MaterialID - Exact or Regular expression.
-
Material properties - ID property, Value property, multiple properties.
Return the full material list
Specify only the user credentials to return the entire material list.
Filtering by Material ID
You can filter the GetMaterial list by Material ID. Each material is uniquely identified by its ID, which is currently the Material full name. The scheme name is currently the full name, and you can choose to perform an Exact or Regular Expression match.
Filtering by Material properties
You can filter the GetMaterial list by Material properties, including:
-
ID property
-
Value property
-
Multiple properties
The returned results would be an AND of the specified filters.
Filtering by multiple properties
The properties filter is an array, so you can specify any number of properties to filter by. The result would be a material that has the properties of the specified filters.
For more information and examples, see the Get Equipment topic.