Prints

Change some of a print's details.

Send only the fields to change; a field left out, or sent as null, keeps its value. To null out startDate, estimatedPrintTimeInSeconds, printTimeInSeconds, notes, url, fileName or projectId, name it in clear. Setting and clearing the same field is a 400. filamentUsage, when sent, replaces every usage row, and remaining filament moves by the net difference. Unlike PUT, a patch cannot undo an edit somebody else made to another field.

patch/api/Prints/{id}

Request

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

Request body

titlestring nullable
status1 | 2 | 3 | 4 | 5 | 6

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

startDatestring date-time nullable
printerIdinteger nullable

The printer this print ran on. Must belong to the caller.

estimatedPrintTimeInSecondsinteger nullable
printTimeInSecondsinteger nullable
notesstring nullable
urlstring nullable
fileNamestring nullable
allowCommentsboolean nullable
allowFileDownloadsboolean nullable
viewStatus1 | 2 | 3

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

projectIdstring uuid nullable

Assign to an existing project the caller owns.

clearstring[] nullable

Nullable fields to null out: startDate, estimatedPrintTimeInSeconds, printTimeInSeconds, notes, url, fileName, projectId. Setting and clearing the same field in one request is rejected.

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.