SupportDocumentation

Custom Images

List

get

Retrieve theme custom images.

Query parameters
SiteIdinteger · int32Optional

Site ID from which to retrieve the theme custom images. If the parameter is omitted, the site ID of the Licensing Server will be used.

Responses
200
OK
get
GET /api/Theme/CustomImage HTTP/1.1
Host: 
Accept: */*

No content

Update

put

Modify a theme custom image.

Path parameters
idinteger · int32Required

The ID of the Theme Custom Image to modify.

Body

Update a RAS Theme Custom Image

newNamestring | nullableRequired

The new name of the specified Theme Custom Image

Responses
204
No Content
put
PUT /api/Theme/CustomImage/{id} HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 18

{
  "newName": "text"
}
No content

Add

post

Update an Image with specified ImageType of the Theme specified by ID.

Query parameters
SiteIdinteger · int32Optional

Site ID in which to create the theme custom image. If the parameter is omitted, the site ID of the Licensing Server will be used.

Body
ImageFilestring · binaryOptional

Upload File

Responses
204
No Content
post
POST /api/Theme/CustomImage HTTP/1.1
Host: 
Content-Type: multipart/form-data
Accept: */*
Content-Length: 22

{
  "ImageFile": "binary"
}
No content

Get

get

Retrieve a theme custom image.

Path parameters
idinteger · int32Required

The theme custom image ID.

Responses
200
OK
get
GET /api/Theme/CustomImage/{id} HTTP/1.1
Host: 
Accept: */*

No content

Delete

delete

Delete a theme custom image.

Path parameters
idinteger · int32Required

The ID of the Theme Custom Image to remove.

Responses
204
No Content
delete
DELETE /api/Theme/CustomImage/{id} HTTP/1.1
Host: 
Accept: */*

No content
PreviousImageNextVDI

Last updated

Was this helpful?