Modifying a Resource

This documentation is an older version of JasperReports Server Administration Guide. View the latest documentation.

Overview of JasperReports Server Administration
- Overview of Organizations
- Overview of the Repository
- Overview of Users and Roles
- Overview of Security
- Administrator Login
- Administrator Pages
Organization, User, and Role Management
- Managing Organizations
- Managing Users
- Managing Roles
Repository Administration
- Resource Types
- JasperReport Structure
- Managing Folders and Resources
- Multiple Organizations in the Repository
- Permissions
Resources in the Repository
- Data Sources
- Queries
- Input Controls
- Query-based Input Controls
- File Resources
Themes
- Introduction
- How Themes Work
- Administering Themes
- Working With CSS Files
Import and Export
- Import and Export Catalogs
- Setting the Import-Export Encryption Key
- Importing Unencrypted Catalogs
- Import and Export through the Web UI
- Import and Export through the Command Line
System Configuration
- Configuration Settings in the User Interface
- Configuring User Password Options
- Configuring the User Session Timeout
- Encrypting User Session Login
- Configuring CSRF Prevention
- Configuring Input Validation
- Defining a Cross-Domain Policy for Flash
- Configuring Ad Hoc
- Enabling Data Snapshots
- Configuring System Logs
- Configuring Amazon Web Services
- Configuring Domains
- Configuring JasperReports Library
- Configuring Input Control Behavior
- Configuring the Scheduler
- Configuring the Heartbeat
- Configuring the Online Help
Server Diagnostics
- Events Being Audited and Monitored
- Configuring Auditing and Monitoring
- Using the Audit Data
- Using the Monitoring Data
- Importing and Exporting Event Data
- Real-Time Diagnostics
- Exposing Diagnostics Through Jaspersoft’s JMX Agent
- Using the Diagnostic Data In Reports
- Excluding Diagnostic Attributes
- Disabling the Diagnostic Subsystem
Troubleshooting
Localization
Introduction
- REST Web Services Overview
- REST Authentication
- REST Server Information
- SOAP Web Services Overview
- SOAP Authentication
- Syntax of resourceDescriptor
REST v2 - Repository Services
- The v2/resources Service
- The_v2_domains_metadata_Service
- The v2/permissions Service
- The v2/export Service
  - Checking the Export State
  - Fetching the Export Output
- The v2/import Service
REST v2 - Report Services
- The v2/reports Service
- The v2/reportExecutions Service
- The v2/inputControls Service
- The v2/options Service
- The v2/jobs Service
- The v2/queryExecutor Service
- The v2/caches Service
REST v2 - Administration Services
- The v2/organizations Service
- The v2/users Service
- The v2/attributes Service
- The v2/roles Service
page
- The resources Service
- The resource Service
- Working with Dashboards
- Working with Virtual Data Sources
- Working with Domains
- The permission Service
  - Viewing Permissions
  - Setting Permissions
page
- The report Service
- The jobsummary Service
- The job Service
REST v1 - Administration Services
- The organization Service
- The user Service
- The attribute Service
- The role Service
page
- Request and Operation Result
- List Operation
- Get Operation
- Put Operation
- Delete Operation
- Move Operation
- Copy Operation
- Errors
- Implementation Suggestions
page
- Types Defined in the WSDL
- Operations in the Scheduling Service
  - Example Request and Operation Result
- Java Client Classes
SOAP - Domain Web Service
- Types Defined in the WSDL
- Operations in the Domain Service
SOAP - Web Services for Administration
- Types Defined in the WSDL
- Users and Roles
  - findUsers
  - page

Use the PUT method above to overwrite an entire resource. Specify the path of the target resource in the URL and specify resource of the same type. Use overwrite=true to replace a resource of a different type.

The resource descriptor must completely describe the updated resource, not use individual fields. The descriptor must also use only references for nested resources, not other resources expanded inline. You can update the local resources using the hidden folder _file. For more informations, see Modifying a Resource.

In JasperReports Server 5.5, Jaspersoft introduces a new method for modifying resoures. The PATCH method updates individual descriptor fields on the target resource. It also accept expressions that modify the descriptor in the Spring Expression Language. This expression language lets you easily modify the structure and values of descriptors.

Method	URL
PATCH	http://<host>:<port>/jasperserver[-pro]/rest_v2/resources/path/to/resource
Content-Type		Content
application/json		{ "version" : 0, "patch":[ { "field":"label", "value":"New Label" }, { "field":"query", "value":"/path/to/query/resource" }, { "expression":"inputControls.add(new com.jaspersoft. jasperserver.dto.resources.ClientReference(). setUri('/datatypes/decorate'))" } ]}[/code]
application/xml		<patchItems> <version>0</version> <patch> <field>label</field> <value>New Label</value> </patch> <patch> <field>query</field> <value>/path/to/query/resource</value> </patch> <patch> <expression>inputControls.add(new com.jaspersoft. jasperserver.dto.resources.ClientReference(). setUri('/datatypes/decorate')) </expression> </patch></patchItems>[/code]
Return Value on Success			Typical Return Values on Failure
For confirmation, the response contains the full descriptor of the resource that was just modified.			400 Bad Request – Mismatch between the patch fields and the fields or syntax of the actual descriptor. 409 Conflict – Old version number; the resource was updated more recently than the last version number received.

The patch descriptor contains attributes of the target resource. It can't be used to specify the attributes of nested resources. However, you can apply the patch operation directly to the local resource in the hidden _files folder.

If your client does not support the PATCH method, use the POST method and specify the following HTTP header:

X-HTTP-Method-Override: PATCH