Deleting Attributes

The DELETE method of the attributes service removes attributes from the specified entity (a user, an organization, or the server-level). When attributes are removed, both the name and the value of the attribute are removed, not only the value. For possible values of <entity> in the URL, see Entities with Attributes.

There are two syntaxes; the following one is for deleting multiple attributes or all attributes at once.

Method

URL

DELETE

http://<host>:<port>/jasperserver[-pro]/rest_v2/<entity>attributes?<arguments>

Argument

Type

Description

name

Optional
String

Specify an attribute name to remove that attribute. Repeat this argument to delete multiple attributes. When this argument is omitted, all attributes are deleted from the given entity.

Return Value on Success

Typical Return Values on Failure

204 No Content – The attributes were successfully removed from the given entity.

404 Not Found – When the user ID or organization ID does not match any user or organization. The content includes an error message.

400 Bad Request – When an attribute name is null, blank, or too long (see Attribute Limitations). If one attribute causes an error, the operation stops and returns an error, but attributes that were already deleted remain deleted.

The second syntax deletes a single attribute named in the URL from the specified entity.

Method

URL

DELETE

http://<host>:<port>/jasperserver[-pro]/rest_v2/<entity>attributes/attrName

Return Value on Success

Typical Return Values on Failure

204 No Content – The attribute was successfully removed from the given entity.

404 Not Found – When the user ID, organization ID, or attribute name does not match any user, organization, or attribute. The content includes an error message.

400 Bad Request – When an attribute name is null, blank, or too long (see Attribute Limitations).

Version: 
Feedback
randomness