Wallpapers

Get list of wallpapers

Returns list of wallpapers

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

query Parameters
created_on_gt
string <datetime>

Filter applications created after a given timestamp.

created_on_lt
string <datetime>

Filter applications created before a given timestamp.

updated_on_gt
string <datetime>

Filter applications updated after a given timestamp.

updated_on_lt
string <datetime>

Filter applications updated before a given timestamp.

limit
integer
Default: 20

Number of results to return per page.

offset
integer
Default: 0

Return results from this index.

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/api/v1/enterprise/{enterprise_id}/wallpaper/
Response samples
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

Create wallpaper

Returns instance of created wallpaper

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

Request Body schema: multipart/form-data
image_file
required
string <path>

Valid file to upload

orientation
required
string

Orientation of image e.g. landscape

Responses
201

Successful Operation

400

Bad request

401

Authorization information is missing or invalid.

403

Forbidden, no permission to perform this action.

415

Unsupported media type.

500

Internal server error

post/api/v1/enterprise/{enterprise_id}/wallpaper/
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9",
  • "image_file": "string",
  • "thumbnail": "string",
  • "orientation": "string",
  • "is_active": true,
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}

Get instance of wallpaper

Returns instance of wallpaper

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

wallpaper_id
required
string

A UUID string identifying the wallpaper.

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/api/v1/enterprise/{enterprise_id}/wallpaper/{wallpaper_id}/
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9",
  • "image_file": "string",
  • "thumbnail": "string",
  • "orientation": "string",
  • "is_active": true,
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}

Deletes instance of wallpaper

Empty response

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

wallpaper_id
required
string

A UUID string identifying the wallpaper.

Responses
204

The resource was deleted successfully.

400

Invalid request.

401

Authorization information is missing or invalid.

403

Forbidden, no permission to perform this action.

404

Not Found.

500

Internal server error

delete/api/v1/enterprise/{enterprise_id}/wallpaper/{wallpaper_id}/
Response samples
application/json
{
  • "errors": [
    ],
  • "message": "string",
  • "status": 0
}