IconModel

Represents the data for an icon.

Properties

NameDescription Additional information
Href

See Hypermedia.

Type: String

RelatedActions

See Hypermedia.

Type: Array of RelationModel

Id

Identifier. Icons are immutable, allowing the caller to reliably cache icon data by identifier.

Type: String

Format

Icon format.

Type: IconFormat

Width

Width in pixels. If 'Format' is 'Ico', this should be ignored.

Type: Number

Height

Height in pixels. If 'Format' is 'Ico', this should be ignored.

Type: Number

ColorDepth

Color depth in bits-per-pixel. If 'Format' is 'Ico', this should be ignored.

Type: Number

DataBase64

Base-64 encoded data.

Type: String

Sample

application/json

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