getAllProjectAvatars
Get all project avatars
Details
- Method:
GET - Path:
/rest/api/3/project/{projectIdOrKey}/avatars - Operation ID:
getAllProjectAvatars
Parameters
{
"projectIdOrKey": {
"description": "The ID or (case-sensitive) key of the project.",
"required": true,
"location": "path",
"type": "string"
}
}Response Schema
{
"additionalProperties": false,
"description": "List of project avatars.",
"properties": {
"custom": {
"description": "List of avatars added to Jira. These avatars may be deleted.",
"items": {
"additionalProperties": true,
"description": "Details of an avatar.",
"properties": {
"fileName": {
"description": "The file name of the avatar icon. Returned for system avatars.",
"readOnly": true,
"type": "string"
},
"id": {
"description": "The ID of the avatar.",
"type": "string"
},
"isDeletable": {
"description": "Whether the avatar can be deleted.",
"readOnly": true,
"type": "boolean"
},
"isSelected": {
"description": "Whether the avatar is used in Jira. For example, shown as a project's avatar.",
"readOnly": true,
"type": "boolean"
},
"isSystemAvatar": {
"description": "Whether the avatar is a system avatar.",
"readOnly": true,
"type": "boolean"
},
"owner": {
"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.",
"readOnly": true,
"type": "string"
},
"urls": {
"additionalProperties": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"description": "The list of avatar icon URLs.",
"readOnly": true,
"type": "object"
}
},
"required": [
"id"
],
"type": "object"
},
"readOnly": true,
"type": "array"
},
"system": {
"description": "List of avatars included with Jira. These avatars cannot be deleted.",
"items": {
"additionalProperties": true,
"description": "Details of an avatar.",
"properties": {
"fileName": {
"description": "The file name of the avatar icon. Returned for system avatars.",
"readOnly": true,
"type": "string"
},
"id": {
"description": "The ID of the avatar.",
"type": "string"
},
"isDeletable": {
"description": "Whether the avatar can be deleted.",
"readOnly": true,
"type": "boolean"
},
"isSelected": {
"description": "Whether the avatar is used in Jira. For example, shown as a project's avatar.",
"readOnly": true,
"type": "boolean"
},
"isSystemAvatar": {
"description": "Whether the avatar is a system avatar.",
"readOnly": true,
"type": "boolean"
},
"owner": {
"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.",
"readOnly": true,
"type": "string"
},
"urls": {
"additionalProperties": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"description": "The list of avatar icon URLs.",
"readOnly": true,
"type": "object"
}
},
"required": [
"id"
],
"type": "object"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('jira')
# Call this tool
result = await agent.call_tool('getAllProjectAvatars', {
# Add required parameters here
})