To modify the properties of an organization, use the PUT method and specify the organization ID in the URL. The request must include an organization descriptor with the values you want to change. You cannot change the ID of an organization, only its name (used for display) and its alias (used for logging in).
|
Method |
URL |
||
|
PUT |
http://<host>:<port>/jasperserver-pro/rest_v2/organizations/organizationID/ |
||
|
Content-Type |
Content |
||
|
application/xml application/json |
A partial organization descriptor that includes the properties to change. Do not specify the following properties: id – The organization ID is permanent and can never be modified. parentId – Organizations cannot change parents. tenantUri – Organizations cannot change the organization hierarchy. tenantFolderUri – The organization folder is automatically based on its parent, which cannot be changed. |
||
|
Return Value on Success |
Typical Return Values on Failure |
||
|
200 OK – The organization was successfully updated. |
400 Bad Request – When some dependent resources cannot be resolved. |
||
The following example shows a descriptor sent to update the name and description of an organization:
{
"tenantName":"Audit Dept",
"tenantDesc":"Audit Department of Finance Division"
} |
