Sign in

v1

latestSwagger 2.02026-07-13285166341.1 KB
GlobalImages

Update the metadata for an image.

Update the metadata for an image. Size may not be modified by the client. Set status to 'Available' to publish an image. Both the image and thumbnail must be uploaded. Set status to 'Created' to reset an image's contents and re-upload. A file may only be 'Removed' by the DELETE method.

put/api/v2/GlobalImages/{ID}

Path parameters

IDstring required

The GlobalImage's id.

Query parameters

overridePublisherOrDateboolean

Whether to set the publisher and date to the provided values.

Request body

Idstring

The Id of the GlobalImage Metadata.

CRCstring required

The Hash of the file (SHA256, HEX-encoded).

ThumbnailCRCstring required

The Hash of the thumbnail file (SHA256, HEX-encoded).

State'Created' | 'Available' | 'Removed' required

Indicates the state of this file. Must be 'Created' when created. Read Only.

Namestring required

The name of the file when downloaded.

Descriptionstring required

The description of the file.

Publisherstring

The Publisher of the file.

Datestring date-time

The date of the file.

Sizeinteger

The size of the file in bytes. Null until assigned by server when marked as 'Available'. Read Only

ThumbnailSizeinteger

The size of the thumbnail file in bytes. Null until assigned by server when marked as 'Available'. Read Only

Widthinteger required

The width of the file.

Heightinteger required

The height of the file.

Response

No Content