Sign in
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. Defaults to 0. Combine with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Take to page through a result set larger than one page.

Takeinteger

Number of records to return. Validation accepts 0 through 5000, but 0 is not a page size and what an endpoint does with it varies, so send a value from 1 to 5000.

Two cases differ. A request that supplies paging but leaves this field out takes this field's default of <b>50</b>. A request that supplies no paging at all is endpoint-specific — some define their own fallback — so it does not reliably mean any particular number of records. Either way the response says nothing about records it did not return, so send this explicitly whenever the size of the answer matters. Endpoints returning a paged envelope report totalCount and hasNextPage alongside the records; endpoints returning a bare array report neither, so page those with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Skip until a page comes back shorter than the value requested.

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

Changes

No recorded changes to this endpoint across all 23 revisions of this API.