Get avatars

v1.0.0

Returns the system and custom avatars for a project, issue type or priority.

This operation can be accessed anonymously.

required:

for custom project avatars, Browse projects for the project the avatar belongs to.
for custom issue type avatars, Browse projects for at least one project the issue type is used in.
for system avatars, none.
for priority avatars, none.

Input

{
  "type": "object",
  "properties": {
    "entityId": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "enum": [
        "project",
        "issuetype",
        "priority"
      ]
    }
  },
  "required": [
    "entityId",
    "type"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Details about system and custom avatars.",
  "properties": {
    "custom": {
      "type": "array",
      "description": "Custom avatars list.",
      "items": {
        "type": "object",
        "description": "Details of an avatar.",
        "required": [
          "id"
        ],
        "properties": {
          "fileName": {
            "type": "string",
            "description": "The file name of the avatar icon. Returned for system avatars."
          },
          "id": {
            "type": "string",
            "description": "The ID of the avatar."
          },
          "isDeletable": {
            "type": "boolean",
            "description": "Whether the avatar can be deleted."
          },
          "isSelected": {
            "type": "boolean",
            "description": "Whether the avatar is used in Jira. For example, shown as a project's avatar."
          },
          "isSystemAvatar": {
            "type": "boolean",
            "description": "Whether the avatar is a system avatar."
          },
          "owner": {
            "type": "string",
            "description": "The owner of the avatar. For a system avatar the owner is null (and nothing is returned). For non-system avatars this is the appropriate identifier, such as the ID for a project or the account ID for a user."
          },
          "urls": {
            "type": "object",
            "description": "The list of avatar icon URLs."
          }
        }
      }
    },
    "system": {
      "type": "array",
      "description": "System avatars list.",
      "items": {
        "type": "object",
        "description": "Details of an avatar.",
        "required": [
          "id"
        ],
        "properties": {
          "fileName": {
            "type": "string",
            "description": "The file name of the avatar icon. Returned for system avatars."
          },
          "id": {
            "type": "string",
            "description": "The ID of the avatar."
          },
          "isDeletable": {
            "type": "boolean",
            "description": "Whether the avatar can be deleted."
          },
          "isSelected": {
            "type": "boolean",
            "description": "Whether the avatar is used in Jira. For example, shown as a project's avatar."
          },
          "isSystemAvatar": {
            "type": "boolean",
            "description": "Whether the avatar is a system avatar."
          },
          "owner": {
            "type": "string",
            "description": "The owner of the avatar. For a system avatar the owner is null (and nothing is returned). For non-system avatars this is the appropriate identifier, such as the ID for a project or the account ID for a user."
          },
          "urls": {
            "type": "object",
            "description": "The list of avatar icon URLs."
          }
        }
      }
    }
  },
  "additionalProperties": false
}