Sign in

v2

latestOpenAPI 3.0.42026-08-084694591.6 MB
Material

Get a material. DEPRECATED: use POST /v2/materials/get instead, which accepts the material id in the request body. This endpoint fails for material ids that contain '/' characters (e.g. "SS-301-CR 1/2 HD") because ASP.NET Core routing cannot match URL-encoded forward slashes in path segments.

get/api/materials/{id}

Path parameters

idstring required

Response

The material for the given id

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