TSS - Material Manager

Gets a list of mappings and materials for display in Material Manager.

Can also be used to pull data for a single material to be used in editing.

get/TSS/MaterialManager/Table

Request

  • Base URL: https://api.carboncure.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.carboncure.com/TSS/MaterialManager/Table
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://auth.carboncure.com/oauth2/authorize, token URL https://auth.carboncure.com/oauth2/token, scopes: applicationId, roles)
    • none
    • none

Query parameters

Limitinteger

Limit number of responses. Used for pagination.

Offsetinteger

Skip this many rows in the query. Used for pagination.

SortColumnstring

The name of the column to sort by.

SortOrder'Ascending' | 'Descending'

The order with which to sort the table by the sort column.

divisionIdinteger

Division ID to filter table by.

primaryMaterialType'Admixture' | 'Aggregate' | 'Cement' | 'CO2' | 'Fiber' | 'FlyAsh' | 'ReclaimedWater' | 'Slag' | 'SilicaFume' | 'SCM' | 'Water' | 'Filler'

Primary material type to filter table by. Names "Material Type" in UI

materialType'Cement' | 'CementTypeI' | 'CementTypeIS' | 'CementTypeIP' | 'CementTypeIL' | 'CementTypeII' | 'CementTypeI_II' | 'CementTypeI_IIMH' | 'CementTypeI_II_LA' | 'CementTypeIII' | 'CementTypeIV' | 'CementTypeII_V' | 'CementTypeN' | 'CementTypeS' | 'CementCemI' | 'CementCemII' | 'CementCemIII' | 'CementCemIV' | 'CementCemV' | 'CementCemVI' | 'CementBlendedHydraulic' | 'CoarseAggregate' | 'IntermediateAggregate' | 'FineAggregate' | 'Fiber' | 'FiberTypeI' | 'FiberTypeII' | 'FiberTypeIII' | 'FiberTypeIV' | 'Water' | 'CO2' | 'SCM' | 'Slag' | 'SlagFerrous' | 'SlagNonFerrous' | 'SlagFerroalloy' | 'FlyAsh' | 'FlyAshC' | 'FlyAshF' | 'FlyAshN' | 'SilicaFume' | 'ReclaimedWater' | 'Admixture' | 'AirEntrainer' | 'Retarder' | 'SuperPlasticizer' | 'WaterReducer' | 'HighRangeWaterReducer' | 'MidRangeWaterReducer' | 'LowRangeWaterReducer' | 'ViscosityModifier' | 'HydrationStabilizer' | 'CorrosionInhibitor' | 'ShrinkageReducer' | 'Accelerator' | 'NonChlorideAccelerator' | 'ChlorideAccelerator' | 'StrengthEnhancer' | 'AntiWashout' | 'Waterproofer' | 'Filler'

Material type to filter by ("Material Subtype" in UI).

admixtureMaterialSubType'AirEntrainer' | 'Retarder' | 'SuperPlasticizer' | 'WaterReducer' | 'HighRangeWaterReducer' | 'MidRangeWaterReducer' | 'LowRangeWaterReducer' | 'ViscosityModifier' | 'HydrationStabilizer' | 'CorrosionInhibitor' | 'ShrinkageReducer' | 'Accelerator' | 'NonChlorideAccelerator' | 'ChlorideAccelerator' | 'AntiWashout' | 'Waterproofer'

Admixture material type to filter by ("Secondary Material Subtype" in UI).

supplierCompanystring

Supplier company name to filter by. This is the cement plant company name in the case of cements.

supplierPlantstring

Supplier plant name to filter by. This is the cement plant plant name in the case of cements.

aliasstring

Alias to filter table by.

isOrcaUpdatedboolean

Only return materials updated via Orca if true; only return materials updated via digital integration if false. All materials returned if no value is specified.

materialMappingIdinteger

Specific ID of mapping to return. Used in edit material feature.

Response

OK

countinteger

Changes

No recorded changes to this operation across all 1 revision of this API.