FUfulcrumpro
Material

Find materials based on search parameters.

Changed on
post/api/materials/list

Request

  • Base URL
    https://api.fulcrumpro.com
  • URL
    https://api.fulcrumpro.com/api/materials/list
  • Auth
    none declared

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.

isCustomboolean nullable

True for a material the account created that is not in the standard material library. Returned only by Material List and Material Get, and only when custom materials are enabled for the account.

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

dimensionUnitsstring nullable

Unit the material's dimensions are in: Inch, Foot, Yard, Millimeter, Centimeter or Meter. Routing input-material nesting d2 and d3 are costed in this unit. A routing costs from a copy of the material's units, shape type and density taken when the input material was added, so later changes to the material may not reach it.

shapeTypestring nullable

How the material is measured: Planar (sheet and plate, costed by length and width) or Linear (bar, tube and structural shapes, costed by length). A nesting's d3 applies only to Planar materials.

linearDensitynumber double nullable

Weight per unit length, in densityUnits. Used to cost Linear materials.

planarDensitynumber double nullable

Weight per unit area, in densityUnits. Used to cost Planar materials.

densityUnitsstring nullable

Unit of linearDensity and planarDensity: PoundPerFoot, KilogramPerMeter, PoundPerSquareFoot or KilogramPerSquareMeter. An input material whose material has no density for its shapeType is estimated at zero material cost.

Changes

  • 28692655305bRevision changes
    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: application/problem+json)

  • c3bdc499d639Revision changes
    • breaking

      the request property's minItems was increased to 1 (media type: application/json-patch+json)

    • breaking

      the request property's minItems was increased to 1 (media type: application/json)

    • breaking

      the request property's minItems was increased to 1 (media type: text/json)

    • breaking

      the request property's minItems was increased to 1 (media type: application/*+json)