/avatar/{userNameOrID}
to retrieve any user's avatar or use /avatar/current
for the avatar of the currently logged-in user.
GET /rest/bpm/wle/v1/avatar/{userNameOrID}
None
None
isDefault
response attribute is set to true
, the returned image is the default avatar. For the default
avatar, the userUpdateTimestamp
and userAvatarKey
values are the same: 946681200000The default content type is application/json.
{ "description": "User Avatar", "type": "object", "properties": { "userID": {"type": "integer", "description": "The user ID of the user that is described by this object." }, "userName": {"type": "string", "description": "The user name of the user that is described by this object.", }, "userAvatarImage": {"type": "string", "description": "A base64 encoded string representing user avatar.", }, "userUpdateTimestamp": {"type": "string", "description": "The lasted update timestamp of the user avatar.", }, "userAvatarKey": {"type": "string", "description": "The key is composed of the userUpdateTimestamp and userID values. However, the default avatar does not need the user identifier and uses only the default userUpdateTimestamp value", }, "imageFormat": {"type": "string", "description": "Format of the image. JPG, GIF or PNG. " }, "isDefault": {"type": "string", "description": "Indicates if the avatar image returned was default or not." } } }
{ status:"200", data: { userID:9, userName:"tw_admin", userAvatarImage:"iVBORw0KGgoAAAANSUhgILmO2Sz-truncated-R9uVQAAAABJRU5ErkJggg==", userAvatarKey:"1494925798718-9", userUpdateTimestamp:"1494925798718", imageFormat:"jpg", isDefault:"false" } }
<?xml version="1.0" encoding="UTF-8"?> <schema targetNamespace="http://rest.bpm.ibm.com/v1/data/useravatar" elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://rest.bpm.ibm.com/v1/data/useravatar" xmlns:data="http://rest.bpm.ibm.com/v1/data/root" xmlns:cmn="http://rest.bpm.ibm.com/v1/data/common"> <import schemaLocation="BPMRestData.xsd" namespace="http://rest.bpm.ibm.com/v1/data/root" /> <import schemaLocation="Common.xsd" namespace="http://rest.bpm.ibm.com/v1/data/common" /> <!-- This type represents a user Avatar. --> <complexType name="UserAvatarData"> <complexContent> <extension base="data:Data"> <sequence> <element name="userID" type="long" /> <!-- The alphanumeric user name associated with the user --> <element name="userName" type="string" /> <!-- The Avatar or profile picture of the user --> <element name="userAvatarImage" type="string" /> <element name="userAvatarKey" type="string" /> <element name="userUpdateTimestamp" type="string" /> <element name="imageFormat" type="string" /> <element name="isDefault" type="string" /> </sequence> </extension> </complexContent> </complexType> </schema>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <bpm:ResponseData xmlns:bpm="http://rest.bpm.ibm.com/v1/data" xmlns:ex="http://rest.bpm.ibm.com/v1/data/exception" xmlns:soc="http://rest.bpm.ibm.com/v1/data/social" xmlns:sys="http://rest.bpm.ibm.com/v1/data/system" xmlns:ug="http://rest.bpm.ibm.com/v1/data/usergroup"> <status>200</status> <data xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns8="http://rest.bpm.ibm.com/v1/data/useravatar" xsi:type="ns8:UserAvatarData"> <userID>9</userID> <userName>tw_admin</userName> <userAvatarImage>wcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL</userAvatarImage> <userAvatarKey>1494925798718-9</userAvatarKey> <userUpdateTimestamp>1494925798718</userUpdateTimestamp> <imageFormat>jpg</imageFormat> <isDefault>false</isDefault> </data> </bpm:ResponseData>
The default content type is application/json.
{ "description": "WLE Error Response", "type": "object", "properties": { "status": {"type": "string", "description": "The status of the previous API call." }, "exceptionType": {"type": "string", "description": "The classname associated with the exception." }, "errorNumber": {"type": "string", "description": "Message ID of the exception." }, "errorMessage": {"type": "string", "description": "Message text of the exception." }, "errorMessageParameters": {"type": ["string"], "optional": true, "description":"Message text parameters of the exception." }, "programmersDetails": {"type": "object", "optional": true, "description":"Additional exception details, for example, a stack trace." } } }
<?xml version="1.0" encoding="UTF-8"?> <schema targetNamespace="http://rest.bpm.ibm.com/v1/data/exception" elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://rest.bpm.ibm.com/v1/data/exception" xmlns:dat="http://rest.bpm.ibm.com/v1/data/root"> <import schemaLocation="BPMRestData.xsd" namespace="http://rest.bpm.ibm.com/v1/data/root" /> <!-- This type represents an error response. --> <element name="RestRuntimeException"> <complexType> <sequence> <element name="status" type="string"/> <element name="Data" type="tns:ExceptionData"> </element> </sequence> </complexType> </element> <!-- This type contains detailed error information associated with an exception. --> <complexType name="ExceptionData"> <sequence> <element name="status" type="string"/> <!-- This specifies the java class name of the exception --> <element name="exceptionType" type="string"/> <!-- The message ID of the error message --> <element name="errorNumber" type="string" minOccurs="0"/> <!-- The complete error message --> <element name="errorMessage" type="string"/> <!-- The list of strings inserted into the error message --> <element name="errorMessageParameters" type="string" minOccurs="0" maxOccurs="unbounded"/> <!-- The stacktrace associated with the exception. Note that this will be omitted unless the "server-stacktrace-enabled" property is enabled in the server's 100Custom.xml file. --> <element name="programmersDetails" type="string"></element> <!-- Prior responses. Set if a bulk command was used --> <element name="responses" type="dat:BulkCommandResponses" minOccurs="0"></element> <element name="errorData" type="tns:ErrorData" minOccurs="0" /> </sequence> </complexType> <complexType name="ErrorData"> <sequence> <element name="code" type="string" /> <element name="data" type="string" minOccurs="0" /> </sequence> </complexType> </schema>
Code | Description |
---|---|
200 OK | Success completion. |
406 Not Acceptable | The requested content type or content encoding is not supported. |
500 Internal Server Error | A severe problem has occurred, programmer's details are provided. |
8.0.0
Parent Topic: UserAvatar Resource