Sign in

v2

latestOpenAPI 3.0.42026-08-084694591.6 MB
Material

Find materials based on search parameters.

post/api/materials/list

Query parameters

Sort.Fieldstring

Sort field

Sort.Dir'ascending' | 'descending'

Specify sorting direction.

Sort direction

Skipinteger

Number of records to skip.

Takeinteger

Number of records to return (maximum)

Request body

idsstring[] nullable

Filter materials based on matching ids.

materialsstring[] nullable

Material names.

gradesstring[] nullable

Grades.

formsCommonEnumMaterialFormEnum[] nullable

Material forms.

displayDimensionsstring[] nullable

A list of dimension display values to include

activeboolean nullable

Indicate whether to specifically only pull active materials. If left null, all rows are included.

Response

List of materials matching the filters

idstring required

Unique id associated to this entity.

activeboolean

Indicates if this material is activated.

namestring required

Identifying name.

form'sheet' | 'plate' | 'roundBar' | 'flatBar' | 'channel' | 'squareTube' | 'angle' | 'treadPlate' | 'hexBar' | 'squareBar' | 'teeBar' | 'hBeam' | 'rectTube' | 'pipe' | 'wBeam' | 'sBeam' | 'roundTube' | 'rectBar' | 'wideBar' required

Specifies the form of the material.

materialReferenceIdstring required

Material Id

materialReferenceNamestring required

Material name

specificationstring nullable

Specification

subSpecificationstring nullable

Sub-specification

finishstring nullable

Finish

gradestring nullable

Grade

dimensionstring nullable

Dimension

typestring nullable

Material type

versionstring nullable

Version