Logo

Tile Icon

APIs to manage tile icons. Tile icons allow Templates-based users to apply a icons to devices.

Get List of Device Tile Icons

Returns list of tile icons

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

query Parameters
created_on_gt
string <datetime>

Filter tile icons created after a given timestamp.

created_on_lt
string <datetime>

Filter tile icons created before a given timestamp.

updated_on_gt
string <datetime>

Filter tile icons updated after a given timestamp.

updated_on_lt
string <datetime>

Filter tile icons updated before a given timestamp.

category
string

Filter tile icons by category.

device_model
string

Filter tile icons by device model.

custom
boolean

Filter custom tile icons.

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/v1/enterprise/{enterprise_id}/tile-icons/
Request samples 
curl -i -X GET \
  'https://develop-api.esper.cloud/api/v1/enterprise/{enterprise_id}/tile-icons/?created_on_gt=string&created_on_lt=string&updated_on_gt=string&updated_on_lt=string&category=string&device_model=string&custom=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

Create a tile icon

Create a tile icon.

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

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

Valid file to upload

device_model
required
string

Device model

enterprise
required
string <uuid>

UUID string representing enterprise of tile icon

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/v1/enterprise/{enterprise_id}/tile-icons/
Request samples 
curl -i -X POST \
  'https://develop-api.esper.cloud/api/v1/enterprise/{enterprise_id}/tile-icons/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F icon_file=string \
  -F device_model=string \
  -F enterprise=796caaf9-a7de-4817-9ffa-39d04bf83de9
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "category": "string",
  • "icon_file": "string",
  • "device_model": "string",
  • "custom": true,
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}

Get instance of a tile icon

Get a tile icon.

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

tileicons_id
required
string

A UUID string identifying the tile icon.

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/v1/enterprise/{enterprise_id}/tile-icons/{tileicons_id}/
Request samples 
curl -i -X GET \
  'https://develop-api.esper.cloud/api/v1/enterprise/{enterprise_id}/tile-icons/{tileicons_id}/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "category": "string",
  • "icon_file": "string",
  • "device_model": "string",
  • "custom": true,
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}

Delete a tile icon

Deletes a title icon

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

tileicons_id
required
string

A UUID string identifying the tile icon.

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/v1/enterprise/{enterprise_id}/tile-icons/{tileicons_id}/
Request samples 
curl -i -X DELETE \
  'https://develop-api.esper.cloud/api/v1/enterprise/{enterprise_id}/tile-icons/{tileicons_id}/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "errors": [
    ],
  • "message": "string",
  • "status": 0
}

Set a tile icon for a device

Apply a tile icon to a device.

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

Request Body schema: application/json
required
icon
string or null <uuid>
apply_mode
string
Default: "devices"
Enum: "devices" "all_devices" "groups" "device_model"
device_model
string or null
devices
Array of any <string>
groups
Array of strings
Responses
201

Successful Operation

400

Bad request

401

Authorization information is missing or invalid.

403

Forbidden, no permission to perform this action.

500

Internal server error

post/v1/enterprise/{enterprise_id}/tile-icon-apply/
Request samples
application/json
{
  • "icon": "bc9b3dc5-578a-4929-a13c-7d1a9725e2b0",
  • "apply_mode": "devices",
  • "device_model": "string",
  • "devices": [
    ],
  • "groups": [
    ]
}
Response samples
application/json
{
  • "icon": "bc9b3dc5-578a-4929-a13c-7d1a9725e2b0",
  • "apply_mode": "devices",
  • "device_model": "string",
  • "devices": [
    ],
  • "groups": [
    ]
}

Removes tile icon for device

Returns the model of the device(s)

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

Request Body schema: application/json
required
model
required
string

Model of device

Responses
201

Successful Operation

400

Bad request

401

Authorization information is missing or invalid.

403

Forbidden, no permission to perform this action.

500

Internal server error

post/v1/enterprise/{enterprise_id}/tile-icon-unapply/
Request samples
application/json
{
  • "model": "string"
}
Response samples
application/json
{
  • "model": "string"
}
➔ Next to Alerts