GET Icons({id})

Get icons known by the system.

Request Information

Parameters

Name	Description	Additional information
id	Id. Icon data associated with a given id is immutable. This allows you to reliably cache retrieved icons by id.	Type: String
format	Icon format. Default value is 'Ico'. Note: 'Ico' results contain all known image sizes and color depths.	Type: IconFormat
width	Width, in pixels. Minimum is 4. Default is 32. Ignored if the icon format is 'Ico'.	Type: Number
height	Height, in pixels. Minimum is 4. Default is 32. Ignored if the icon format is 'Ico'.	Type: Number
bpp	Color depth, in bits-per-pixel. Valid values are 4, 8, 16, 24, and 32. Default is 32. Ignored if the icon format is 'Ico'.	Type: Number
conversionMode	Conversion mode to use if an image cannot be found matching the specified width, height, and bpp. Default is 'Closest'. Ignored if the icon format is 'Ico'.	Type: IconConversionMode

Response Information

An icon.

Response type

IconModel

Response body formats

application/json, text/json

Sample:

{
  "Href": "[api:Icons(00000000-0000-0000-0000-000000000002)]",
  "Id": "00000000-0000-0000-0000-000000000002",
  "Format": "Ico",
  "Width": 0,
  "Height": 0,
  "ColorDepth": 0,
  "DataBase64": "AAABAA...AAA="
}