Skip to navigation

Read Work Order Attachment Download Url

Available by Request

Issue a short-lived signed URL for a work order attachment. The url on the attachment list is a storage reference and is not fetchable, so call this route to get a link you can open. The key needs an explicit workOrders read grant.

expiresInSeconds defaults to 300 (5 minutes). The server clamps it to 60–900, so a larger request is capped at 900 and a smaller one raised to 60. It never rejects a value for being out of range. A non-integer value is a 400.

Every issued link is access-logged. If the log write fails, no link is issued and the request fails with a 500.

Fetch url with a plain GET and no auth header, before expiresAt. Tolerate Content-Encoding: gzip. The URL sets Content-Disposition: inline with the file name and the contentType returned here. Only PDF, JPEG, PNG, and GIF files are served. Any other type is a 415.

After expiresAt the link stops working. Call this route again for a fresh link. Never store a download link as a permanent image reference.

This route needs an explicit workOrders read grant on your API key, even when the key already works on the other work-order routes. To request the grant, contact our team.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

workOrderIdstringRequiredformat: "uuid"
The id of the work order
attachmentIdstringRequiredformat: "uuid"
The id of the attachment, from the attachment list

Query parameters

expiresInSecondsintegerOptionalDefaults to 300

Link lifetime in seconds. Clamped to 60–900 by the server; out-of-range values are coerced, not rejected

Response

Expected response to a valid request
urlstringformat: "uri"

Signed link to the file. Fetch it with a plain GET and no auth header before expiresAt

expiresAtdatetime
The time after which the link stops working
attachmentIdstringformat: "uuid"
The id of the attachment, as returned in the attachment list
workOrderIdstringformat: "uuid"
The id of the work order
fileNamestring
The file name the link serves
contentTypestring

The media type of the file: application/pdf, image/jpeg, image/png, or image/gif. Any other stored type is refused with 415, so no link is issued.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
415
Unsupported Media Type Error