Prints

Record how a print ended.

For connectors reporting a finished job. Sets status (Success 3, Cancelled 4, Failed 5 or PartialSuccess 6) and printTimeInSeconds, and merges filamentUsage into the print's rows by filamentId: actual values are set, estimates and notes are kept, and a filament not yet on the print is added. Rows with no filamentId are matched in order against the print's unlinked rows. endedAt fills in the duration from the start date, or the start date from the duration, when one is missing. Every other field is left alone, and repeating the call is safe: remaining filament changes by the net difference only.

post/api/Prints/{id}/complete

Request

  • Base URL: https://api.3dprintlog.com
  • URL: https://api.3dprintlog.com/api/Prints/{id}/complete
  • 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

idinteger required

The ID of the print.

Request body

status1 | 2 | 3 | 4 | 5 | 6

Sent as an integer: 1 = Pending, 2 = Printing, 3 = Success, 4 = Cancelled, 5 = Failed, 6 = PartialSuccess.

endedAtstring date-time nullable

When the job ended. Fills in the start date or the duration when one is missing.

printTimeInSecondsinteger nullable

The measured print duration in seconds.

Response

The updated print.

idinteger
titlestring nullable
startDatestring date-time nullable
printerIdinteger
estimatedPrintTimeInSecondsinteger nullable
estimatedFilamentUsageMginteger nullable
printTimeInSecondsinteger nullable
filamentUsageMginteger nullable

Filament usage in milligrams

filamentTypestring nullable
notesstring nullable
urlstring nullable
fileNamestring nullable
createdByUserIdinteger
allowCommentsboolean
allowFileDownloadsboolean
status1 | 2 | 3 | 4 | 5 | 6

Sent as an integer: 1 = Pending, 2 = Printing, 3 = Success, 4 = Cancelled, 5 = Failed, 6 = PartialSuccess.

viewStatus1 | 2 | 3

Sent as an integer: 1 = Public, 2 = Unlisted, 3 = Private.

projectIdstring uuid nullable
externalSourcestring nullable

The connector that logged this print, if any. Read-only; shown to the creator only.

externalIdstring nullable

The job's id in PrintLogApi.Models.DTOs.Print.PrintDetailDTO.ExternalSource. Read-only; shown to the creator only.

connectionDisplayNamestring nullable

The display name of the connection that logged this print, for "Logged automatically by …". Null when no connection logged it or it has been deleted. Shown to the creator only.

Changes

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