Filaments

Find the current user's spool by its spool number.

Every spool has a short number of its own (1, 2, 3…), unique among the user's spools and never reused after a delete, so a number written on a label always means the same spool. Spoolman-compatible clients use it as the spool id. Inactive spools are included. Another user's number is a 404.

get/api/Filaments/by-number/{spoolNumber}

Request

  • Base URL: https://api.3dprintlog.com
  • URL: https://api.3dprintlog.com/api/Filaments/by-number/{spoolNumber}
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://3dprintlog.auth0.com/authorize, token URL https://3dprintlog.auth0.com/oauth/token)
    • API key in header X-Api-Key
    • API key in query parameter api_key

Path parameters

spoolNumberinteger required

The spool number.

Response

The spool with that number.

idstring uuid required
spoolNumberinteger nullable

The user's own number for this spool (1, 2, 3…), which Spoolman clients use as its id. Read-only: assigned on create, never reused, and ignored on PUT.

displayNamestring required

Common name for the roll of filament.

brandstring nullable
materialCategoryNicknamestring nullable
materialTypestring required

The material Type, ie PLA, PETG, ABS.

materialDensityGramPerCubicCmnumber double

The Density of the Material

colorNamestring nullable
colorHexstring nullable
diameterMmnumber double nullable
source1 | 2 | 3

Which field is the user-entered "source"

Sent as an integer: 1 = Weight, 2 = Length, 3 = Volume.

initialNominalVolumeMlnumber double nullable

The initial volume of the material in millileters

initialNominalLengthMnumber double nullable

The initial length of the material in meters

initialTotalWeightMginteger nullable
initialNominalWeightMginteger nullable

The initial nominal weight of the filament in milligrams.

spoolWeightMginteger nullable

The weight of the spool in milligrams.

filamentRemaininginteger nullable

Server-computed remaining filament weight in milligrams (InitialNominalWeightMg minus print usage plus weight adjustments). Null when nominal weight is not set. Read-only: ignored on write.

filamentLengthRemainingInMnumber double nullable

Server-computed remaining length in meters, converted from FilamentRemaining so the three readouts always describe the same spool. Null when the nominal weight is not tracked, and null for materials with no diameter - resin and powder have no length. Get-only: a client-supplied value cannot reach the server.

filamentVolumeRemainingInMlnumber double nullable

Server-computed remaining volume in milliliters, converted from FilamentRemaining. Deliberately NOT accumulated from the per-usage VolumeMl columns: a usage row written without normalization carries milligrams and no volume, and summing the volume column then silently under-counts the spool. Get-only: a client-supplied value cannot reach the server.

printCountinteger

Distinct prints that used this filament. Read-only: ignored on write.

totalUsedMginteger

Total milligrams consumed by prints, actual where recorded and estimated otherwise - the same rule FilamentRemaining subtracts. Read-only: ignored on write.

tempRangeStartnumber double nullable
tempRangeEndnumber double nullable
recommendedTempnumber double nullable

The user's recommended temperature

recommendedBedTempnumber double nullable

The user's recommended bed temperature

isActiveboolean
purchaseDatestring date-time nullable
purchaseLocationstring nullable

The location (either URL, or physical location where the filament was purchased)

purchasePriceValuestring nullable
purchasePriceCurrencystring nullable

The Currency Marker (ie, USD)

purchaseNotesstring nullable

Any notes about the purchase price

storageLocationstring nullable

Where is this filament stored?

notesstring nullable
isFavoriteboolean
initialLayerTimeSnumber double nullable

The initial layer cure time in seconds

layerTimeSnumber double nullable

The layer cure time in seconds (after the initial layers)

meltingTemperaturenumber double nullable

Melting temperature of the material

inertGasstring nullable

What inert gas should be used?

materialRefreshRationumber double nullable

The percentage of new powder when mixing with old powder. 1.0 means always use new powder.

colorPattern1 | 2 | 3 | 4

Sent as an integer: 1 = Solid, 2 = Multi, 3 = Gradient, 4 = Rainbow.

finishType1 | 2 | 3

Sent as an integer: 1 = Standard, 2 = Silk, 3 = Matte.

colorsstring[] nullable
effectsPrintLogApiEnumsFilamentEffect[] nullable
tagUidsstring[] nullable

RFID or NFC tag UIDs on this spool, as uppercase hex without separators (04A23F11), in order. Always a list in responses. On PUT, any case and separators are accepted and the list replaces the spool's tags; leave it out (or null) to keep them, which is what clients that predate tags do. A UID already on another of the user's spools is a 409 naming that spool.

catalogEntryIdstring nullable

The catalog entry the spool was created from. Response-only: a PUT never changes it.

Changes

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