Get image
get/images/{imageId}.png
This operation is used to retrieve the PNG image; It is determined by the "image" link relation from the job successfully creating a PNG image. This operation uses an explicit format modifier ('.png'). Doing so is to support the primary use case of embedding the link in a web page or other such context where the client cannot pass an 'Accept:' header to specify the image type.
This URL is secured, and valid only for the current user.
Name | Type | Required | Description |
---|---|---|---|
imageId | string | true | The system-generated ID returned with the completed job (in the 'image' link). |
Status | Meaning | Description | ||
---|---|---|---|---|
200 | OK | The image is returned. Caching headers (Cache-Control, Expires, Pragma) are returned encouraging the browser to cache this image. | Headers | Schema |
304 | Not Modified | If the client-supplied entity tag (If-None-Match) matches the current state, the client's image is current. Nothing is then returned. | Headers | Schema |
404 | Not Found | Either the imageId cannot be found, or the underlying image is not in the database. <p> If a user other than the one who generated the image uses this link, it is considered a security violation, and a 404 is returned so that the caller does not know the link is an otherwise-valid value. </p> | Headers | Schema |