The attribute Service

The attribute service lets you view and update profile attributes, which are custom properties associated with a user. This service does not delete attributes in this release.

Method

URL

GET

http://<host>:<port>/jasperserver[-pro]/rest/attribute/<userID>/

Return Value on Success

Typical Return Values on Failure

200 OK – The content is a descriptor for the user attributes.

404 Not Found – When the specified user ID is not found in the server.

The following example show the user attributes specified in an entityResource element:

<entityResource>
  <Item xsi:type="profileAttributeImpl"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <attrName>State</attrName>
    <attrValue>CA</attrValue>
  </Item>
  <Item xsi:type="profileAttributeImpl"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <attrName>Cities</attrName>
    <attrValue>San Francisco, Oakland, San Jose</attrValue>
  </Item>
</entityResource>

Use the PUT or POST methods of the attribute service to add attributes to a user. For this service, these methods are synonyms.

Method

URL

PUT or

POST

http://<host>:<port>/jasperserver[-pro]/rest/attribute/<userID>/

Content-Type

Content

text/plain

A well-formed descriptor that contains the attributes to add to the given user.

Return Value on Success

Typical Return Values on Failure

201 Created

404 Not Found – When the user ID is not found in the server.

The DELETE on the attribute service is not implemented in this release.

Version: 
Feedback
randomness