FUfulcrumpro
Material

Get a material by id. Use this endpoint instead of the path-based v1 when your material ids may contain '/' characters, which ASP.NET Core routing cannot match once URL-encoded.

Changed on
post/api/v2/materials/get

Request

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

Request body

idstring required

Unique id of the material to retrieve.

Response

The material for the given id

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)

  • 125d94e06273Revision 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)

    • 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)

    • 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)

    • 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)

    • 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)