GET

Get all system avatars

Returns all system avatars of the given type.

Request

Path parameters

type

string

Required

Responses

Returns a map containing a list of system avatars. A map is returned to be consistent with the shape of the project/KEY/avatars REST end point.

application/json

AvatarBean
GET/api/2/avatar/{type}/system
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/avatar/{type}/system' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
POST

Create temporary avatar

Creates temporary avatar

Request

Path parameters

type

string

Required

Query parameters

filename

string

size

string

Responses

temporary avatar cropping instructions

application/json

AvatarCroppingBean
POST/api/2/avatar/{type}/temporary
1 2 3 4 curl --request POST \ --url 'http://{baseurl}/rest/api/2/avatar/{type}/temporary' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
POST

Update avatar cropping

Updates the cropping instructions of the temporary avatar

Request

Path parameters

type

string

Required

Request bodyapplication/json

cropping instructions

cropperOffsetX

integer

cropperOffsetY

integer

cropperWidth

integer

needsCropping

boolean

url

string

Responses

Returned if the cropping coordinates are invalid

POST/api/2/avatar/{type}/temporaryCrop
1 2 3 4 curl --request POST \ --url 'http://{baseurl}/rest/api/2/avatar/{type}/temporaryCrop' \ --user 'email@example.com:<api_token>' \ --header 'Content-Type: application/json'

Rate this page: