PHP Client - Sample Code

Jaspersoft Community 'Read-Only' as of July 8, 2022

Transition to New TIBCO Community Just Weeks Away

You can still search, review wiki content, and review discussions in read-only mode. Please email with questions or issues requiring TIBCO review or response.

About the Class

The JasperReports Server PHP Client is a wrapper for the JasperReports Server REST API. This client abstracts the details behind the communications with the server into simple-to-use functions representative of their functionality on the server. Developers do not have to deal with parsing and creating JSON data, but rather deal with objects that represent resources within the server.

By using JasperReports Server PHP Client, developers can focus on their logic and implementation rather than detailed communications with JasperReports Server.

Getting Started

Invoking the Client

In your project, you must include the autoloader so that classes can be loaded as needed. If you have not generated the autoloader file, please follow the instructions in the README for installation. Then you must initialize a client with your login credentials.

require_once __DIR__ . "/vendor/autoload.php";
use Jaspersoft\Client\Client;
$c = new Client(

Usage Patterns

There are several way to invoke the functions of the client:

// Store service for several calls
$js = $c->jobService();
// Or access service methods directly

Note that all examples on this page assume you are importing objects using the PHP 'use' keyword. If you are not, you must refer to the objects using the full qualified namespace.

Altering the Request Timeout

If you are having issues with requests timing out, you can alter the amount of time the client waits for a response before timing out. The default timeout is 30 seconds.

// Let the client wait one whole minute before timing out

Server Information

The client class can also return data about the sever it is connecting to. This data includes date formats, license information and other info about the server's configruation. It is returned in an associative array format.

$info = $c->serverInfo();

Repository and Resource Services


Searching the Repository

You can search the repository by using a RepositorySearchCriteriaobject to define your search parameters. If no criteria is provided, the entire repository will be returned.

Results are returned as a SearchResourcesResultobject. Each result is contained in the items element of the result object.

// Returns entire repository
$repo = $c->repositoryService()->searchResources();
// Search for specific items in repository
$criteria = new RepositorySearchCriteria();
$criteria->q = "logo";
$results = $c->repositoryService()->searchResources($criteria);
foreach ($results->items as $res) {
    echo $res->label . "<br>";

Creating a Resource

Many types of resources can be created. See the namespace \Jaspersoft\Dto\Resourceto see the types you may work with. Note: CompositeResourceand Resourceare abstract classes and are not expected to be insantisted or used with any 'CRUD' operations.

$folder = new Folder;
$folder->label = "ImageFolder";
$folder->description = "A folder for storing images";
$c->repositoryService()->createResource($folder, "/");

Working with Composite Resources

Some resources can reference or define subresources, these resources are known as composite resources. When dealing with such resources while using the PHP Client, you can decide to provide a reference to an existing resource, or define the resource locally.

For example, when you create a ReportUnit object, you can set the datasourcefield to either of the following:

  • A string representing the path to a data source in the repository. This will create a reference to the designated resource.
  • A concrete DataSourceobject with all the required fields. This will create a local definition of the data source.

The following example defines a ReportUnit that references a data source and a query in the repository. The array of input controls includes both referenced resources and a locally defined InputControlstructure.

$report_shop = new \Jaspersoft\DTO\Resource\ReportUnit();
$city_control = new \Jaspersoft\DTO\Resource\InputControl();
$city_control->query = "/queries/cityQuery";
$city_control->label = "city";
$city_control->type = 7;
$city_control->visible = true;
$city_control->visibleColumns = ["city", "country", "zipcode"];
$city_control->valueColumn = "city";
$report_shop->label = "All Accounts Report of Shops";
$report_shop->description = "AllAccounts style report derived from the shops JDBC datasource";
$report_shop->uri = "/my_reports/allaccount_shop";
$report_shop->dataSource = "/datasources/shopJDBC";
$report_shop->inputControls = array(
$report_shop->query = "/queries/shop_accounts";
$report_shop->jrxml = "/jrxml/allaccounts";

Creating Binary Resources

The repository service is capable of uploading binary files as well. These must be handled differently than other types of resources.

The following example shows how to upload an image to the JasperReports Server repository.

$file = new File;
$file->description = "JPG of company logo";
$file->label = "logo";

Note: If your instance of JRS employs custom file types, you must define the mapping of the server type to the proper MIME type in the Jaspersoft\Tool\MimeMapper object which contains an associative array of JRS file types mapped to their relevant MIME type.

Requesting Binary Content

The following example shows how to request an image and display it in inline HTML using base64 encoding.

$image = $c->repositoryService()->getResource("/ImageFolder/logo");
$image_data = $c->repositoryService()->getBinaryFileData($image);
echo "<img src=\"data:image/jpeg;base64,".base64_encode($image_data)."\"><br><h1> Example Corporation </h1>";		

Deleting a Resource

The deleteResourcesfunction removes resources from the repository, either one at a time or several at a time. When deleting a folder, all folder contents are deleted, including recursive subfolders and their contents, provided the user credentials have delete permission on all folders and resources.

// or
$c->repositoryService()->deleteResources(array("/ImageFolder/logo", "/ImageFolder/logo2"));

Moving a Resource

Resources can be moved from one location to another within the Repository. Note that the moveResourcefunction does not rename the resource, only changes its parent. The following example moves the folder "/ImageFolder" to "/MyReports/ImageFolder":

$c->repositoryService()->moveResource("/ImageFolder", "/MyReports");		

Copying a Resource

Resources can be copied from one location to another within the Repository. The following example copies the folder "/MyReports/ImageFolder" to "/SharedReports/ImageFolder". By setting the last argument to true, folders that do not exist in the new parent's path will be created.

$c->repositoryService()->copyResource("/MyReports/ImageFolder", "/SharedReports", true);		


Searching Permissions

You can search for user permissions to a give resource in the repository by using the searchRepositoryPermissionsfunction. Provide the URI for the resource as the first argument. Other arguments are available to filter the results as needed. The following example lists all the set permission recipients for "/reports/samples/AllAccounts":

$permissions = $c->permissionService()->searchRepositoryPermissions("/reports/samples/AllAccounts");
foreach($permissions as $p)
    echo $p->recipient . "<br>";        

Updating Permissions

To update permissions, you must retrieve existing permissions, modify them, and then pass them to the updateRepositoryPermissionsfunction. The following example retrieves permissions for a report, alters the first one to have no access, and updates it on the server.

$perms = $c->permissionService()->searchRepositoryPermissions("/reports/samples/AllAccounts");
$perms[0]->mask = 0;
$c->permissionService()->updateRepositoryPermissions("/reports/samples/AllAccounts", $perms);        

Updating a Single Permission

You can update one permission at a time as shown in the following code example. It is also possible to create a new permission object from scratch and use it to update a single permission if desired.

$perms = $c->permissionService()->searchRepositoryPermissions("/reports/samples/AllAccounts");
$perms[0]->mask = 0;

Creating Permissions

Permissions can be created by first describing the permissions in Permission objects, then passing them to the server. The following example creates a new permisison for joeuser in organization_1 to administer the AllAccounts report.

$p = new RepositoryPermission("/reports/samples/AllAccounts", "user:/organization_1/joeuser", 1);
$p2 = new RepositoryPermission("/reports/samples/AllAccounts", "user:/organization_1/janeuser", 32);
$c->permissionService()->createRepositoryPermissions(array($p, $p2));
// Likewise, you can create a single permission using the non-plural version

Deleting Permissions

Removing permissions is possible by passing the permission to the deleteRepositoryPermissions function. The example below will delete the permission created in the previous example.

$p = $c->permissionService()->searchRepositoryPermissions("/reports/samples/AllACcounts", null, null, "user:/organization_1/joeuser");


Exporting Resources

Using this service, you can export data from the server to store or import to another server. You must set the user credentials to a system admin (superuserby default) when calling this service. Data is compressed as a zip archive and sent as binary data. First construct an ExportTaskobject that defines what data is to be extracted, then pass it to the startExportTaskfunction. Data can then be stored using PHP file I/O functions, or streamed to a browser by preparing the proper headers and echoing the binary data.

The following example requests an export, then refreshes the status of the export every 10 seconds. When it is finished, it downloads the data as a zip file, stores it in a file (, and offers a link to download the file.

header('Content-Type: text/html; charset=utf-8');
// The export service can take longer than 60 seconds to execute, so it is necessary to change the server execution time limit
$request->users[] = "jasperadmin";
$metadata = $c->importExportService()->startExportTask($request);
$decline = true;
while ($decline) {
    $state = $c->importExportService()->getExportState($metadata->id);
    if ($state->phase == "finished") {
        $decline = false;
        echo "<br>Export task complete, downloading....";
    } else {
        echo "Export in progress...<br>";
$f = fopen('', 'w');
$data = $c->importExportService()->fetchExport($metadata->id);
fwrite($f, $data);
echo "<br><br>Export catalog available for download <a href=''>here</a>.";        

Importing Resources

The import service allows you to import data that was previously exported. There are various flags that can be set to alter what data is imported; see the REST API documentation for specific examples of such flags.

The following example submits an import from the file "" assumed to be stored in the same folder as the PHP file. It displays "Import in progress..." and checks the status every 10 seconds until it is complete. Then it announces that the import has completed.

$request = new ImportTask;
$request->update = true;
$metadata = $c->importExportService()->startImportTask($request, file_get_contents(''));
$continue = true;
while($continue) {
    $state = $c->importExportService()->getImportState($metadata->id);
    if ($state->phase == 'finished') {
        $continue = false;
        echo "<br><br>Import complete!";
    } else {
        echo "Import in progress...<br>";

Reporting Services


Running a Report

The following code example requests the AllAccounts report in HTML format. Since the data is HTML, we can simply echo it, and the report will be presented in the web page. You can do many things with the binary data, including offering the file to be downloaded or storing it to a file.

$report = $c->reportService()->runReport('/reports/samples/AllAccounts', 'html');
echo $report;		

Downloading a Report in a Binary Report

By setting the proper headers before calling the runReportfunction, you can serve binary data to a browser as a download.

$report = $c->reportService()->runReport('/reports/samples/AllAccounts', 'pdf');
header('Cache-Control: must-revalidate');
header('Pragma: public');
header('Content-Description: File Transfer');
header('Content-Disposition: attachment; filename=report.pdf');
header('Content-Transfer-Encoding: binary');
header('Content-Length: ' . strlen($report));
header('Content-Type: application/pdf');
echo $report;		

Running a Report with Input Controls

The following example shows how to run a report with various input controls.

$controls = array(
   'Country_multi_select' => array('USA', 'Mexico'),
   'Cascading_state_multi_select' => array('CA', 'OR')
$report = $c->reportService()->runReport('/reports/samples/Cascading_multi_select_report', 'html', null, null, $controls);
echo $report;			

Retrieving Input Control Values

You can retrieve the input controls defined for a report, their possible values, and other metadata about controls. The following example lists each control and its corresponding values.

$input_controls = $c->reportService()->getReportInputControls('/reports/samples/Cascading_multi_select_report');
foreach($input_controls as $ic) {
    printf('Key: %s <br />', $ic->id);
    foreach ($ic->options as $ico) {
        printf('    -- Value: %s <br />', $ico['label']);


Listing Report Options

A report option is a set of saved input control values for a given report. You can view the different stored options for your reports using the getReportOptionsfunction. It takes the URI of a report that has options, and returns an array of objects representing each report option. The following example shows how to request all the ReportOptionsobjects, iterate through them and print the labels of each one.

$report_options = $c->optionsService()->getReportOptions('/reports/samples/Cascading_multi_select_report');
foreach($report_options as $ro) {
   echo $ro->label . "<br />";

Creating and Updating Report Options

The updateReportOptionsfunction can be used both to create new report options or to update existing ones. The following example shows how to create a new report option that makes selections for existing input controls.

$success = $c->optionsService()->updateReportOptions(
    array('Country_multi_select' => array('Canada', 'USA'),	'Cascading_state_multi_select' => array('OR', 'WA', 'BC')),
if ($success) {
   echo "Created new report option successfully";

Deleting Report Options

To delete a report option, specify the URI of the report, and provide the label of the report option.

If your report options has whitespace in the label, the current version of this function may not handle it well. Instead, use the deleteResourcesfunction to delete the report option.

try {
  $c->optionsService()->deleteReportOptions('/reports/samples/Cascading_multi_select_report', 'CanadaUSA');
} catch (Exception $e) {
  printf("An exception was thrown: ", $e->getMessage());


Searching for Jobs

The searchJobsfunction has various options that can be set to filter your results. With no options set, it returns all existing jobs on the server. All results are JobSummaryobjects that contain the ID of the job. The following example searches for all jobs scheduled for a given report.

$allAccountsJobs = $c->jobService()->searchJobs("/reports/samples/AllAccounts");

Getting Job Details

Once you know the ID of a job, you can request the specific details of that job. The getJobfunction returns a Jobobject describing the job.

$allAccountsJobs = $c->jobService()->searchJobs("/reports/samples/AllAccounts");
$first_job_details = $c->jobService()->getJob($allAccountsJobs[0]->id);		

Creating a Job

To create a job, first create a well-defined Jobobject. The Jobobject contains subclasses that define the behaviour of the scheduled job. The response to a successful job creation contains the ID of the new job.

// SimpleTrigger
$trigger = new SimpleTrigger();
$trigger->timezone = "America/Los_Angeles";
$trigger->startType = 2;
$trigger->startDate = "2025-10-26 10:00";
$trigger->occurrenceCount = 1;
// Source
$source = new Source();
$source->reportUnitURI = "/adhoc/topics/Cascading_multi_select_topic";
$source->parameters = array("Country_multi_select" => array("Mexico"),
                            "Country_name_single_select" => array("Chin-Lovell Engineering Associates"),
                            "Country_state_multi_select" => array("DF", "Jalisco", "Mexico"));
// Repository Destination
$repoDest = new RepositoryDestination();
$repoDest->folderURI = $f->uri;
$job = new Job("Sample Job Name", $trigger, $source, "Cascading_multi_select_test",
                array("PDF", "XLS"), $repoDest);
$job->description = "Sample Description";
try {
} catch (\Exception e) {
    printf('Caught Exception: %s', $e->getMessage());

Updating a Job

To update a scheduled job, request its Jobobject from the server, modify it, and then call the updateJobfunction.

The Jobclass uses properties and arrays to manage its data; this is different from the other objects that use only properties. This means you do not use get/set methods to alter the data in a Job object, but rather set the properties as if they were variables. If a property refers to a nested element of the Jobclass, use array functions to manipulate the arrays.

$allAccountsJobs = $c->jobService()->searchJobs("/reports/samples/AllAccounts");
$job = $c->jobService()->getJob($allAccountsJobs[0]->id);
$job->label = "New label";

Pausing a Job

When a job is paused, it does not run any reports. The only argument to the pauseJobfunction is either a single job ID as an integer or an array of job IDs. If no argument is provided, this function pauses all jobs to which the user has access.


Resuming a Job

To resume a job, pass the job ID to the resumeJobfunction. For convenience, you may also pass an array of job IDs. As with the pauseJobfunction, this function resumes all jobs if no argument is provided.


Deleting Job

To delete a job, search for the job by name or URI, then pass its ID to the deleteJobfunction.



Executing a Query

This service allows you to execute a query on a data source or Domain. Pass the URI of the data source or Domain and a properly written query string as parameters. The executeQueryfunction returns an associative array representing the names and values in the query results.

$query = <<<EOF
        <queryField id="public_opportunities.amount"/>
        <queryField id=""/>
$result = $c->queryService()->executeQuery('/Domains/Simple_Domain', $query);

Administration Services


Searching for Organizations

Use the searchOrganizationfunction to search for organizations by ID.

$found = $c->organizationService()->searchOrganization('org');
foreach ($found as $result)
    printf('<br>Organization Found: %s', $result->id);        

Getting Organization Details

Once you know the full ID of a specific organization, use the getOrganizationfunction to request its detailed information. This function returns an Organizationobject.

$org_one = $c->organizationService()->getOrganization("organization_1");
// Print the details of the $org_one Organization object

Creating an Organization

To create a new organization, define a new Organizationobject and pass it to the createOrganizationfunction.

$new_organization = new Organization(
      'test_organization',	// alias
      'test_organization',	// id
      'organization_1',	    // parent organization
      'Test Organization');	// organization name
try {
} catch (Exception $e) {
   printf('Creating organization failed: %s', $e->getMessage());

Updating an Organization

To modify an organization, obtain its Organizationobject with the searchOrganizationor getOrganizationfunctions. Then modify the fields you wish to update and pass it to the updateOrganizationfunction.

$search = $c->organizationService()->searchOrganization('test_organization');
$organization = $search[0];
$organization->tenantDesc = "My test organization";
try {
} catch (Exception $e) {
    printf('Unable to modify organization: %s', $e->getMessage());

Deleting Organizations

To delete an organization, obtain its Organizationobject with the searchOrganizationor getOrganizationfunctions, and pass it to the deleteOrganizationfunction.

$search = $c->organizationService()->searchOrganizations('test_organization');
$organization = $search[0];
try {
} catch (Exception $e) {
   printf('Organization deletion failure: %s', $e->getMessage());


Searching for Roles

Use the the searchRolesfunction to request all the roles of an organization, or all roles on the server. Optionally, you can search based on specific criteria for roles. The following example returns all roles on the server.

$server_roles = $c->roleService()->searchRoles();        

Getting a Specific Role

If you know the name of the role, you can request it specifically using the getRolefunction. This function returns a Roleobject.

$user_role = $c->roleService()->getRole("ROLE_USER");        

Creating a Role

To create a role, describe it in a Roleobject, then pass it to the createRolefunction. The following example creates a new role in organization_1.

$robot_role = new Role("ROLE_ROBOT", "organization_1");

Updating a Role

To upate a role, pass an updated Roleobject to the updateRolefunction. If you change the name of the role, you must pass the old name of the role as the second argument.

$robot_role = $c->roleService()->getRole("ROLE_ROBOT", "organization_1");
$old_name = $robot_role->roleName;
$robot_role->roleName = "ROLE_HUMAN";
$c->roleService()->updateRole($robot_role, $old_name);

Deleting a Role

To delete a role, first retrieve the Roleobject representing the role you wish to remove, then pass it to the deleteRolefunction.

$role_human = $c->roleService()->getRole("ROLE_HUMAN", "organization_1");


Searching for Users

Using the searchUsersfunction you can search for several users based on various critera. This function returns an array of UserLookupobjects that can be used with the getUserByLookupfunction to retrieve their fully described Userobjects.

The example below finds all users of organization_1 containing 'j' in their username, and prints out the roles assigned to each user.

$results = $c->userService()->searchUsers('j', 'organization_1');
foreach ($results as $userLookup) {
    $user = $c->userService()->getUserByLookup($userLookup);
    printf('<br>Found user: %s', $user->fullName);
    foreach ($user->roles as $role)
        printf('<br> %10s User has role: %s', '&nbsp;', $role->roleName);

Creating a User

To create a user, define a Userobject that fully describes the user, and pass it to the addOrUpdateUserfunction.

$newUser = new User(
    'Business Intelligence User',
$role = new Role('ROLE_USER', null, 'false');
try {
} catch (Exception $e) {
   printf('Could not add new user: %s', $e->getMessage());

Updating a User

To update a user, pass an updated Userobject to the addOrUpdateUserfunction.

$search = $c->userService()->searchUsers('californiaUser', 'organization_1');
$californiaUser = $c->userService()->getUserByLookup($search[0]);
try {
} catch (Exception $e) {
    printf('Attempt to modify the user failed with error: %s', $e->getMessage());

Delete User

To delete a user, first retrieve the Userobject representing the user you wish to remove, then pass it to the deleteUserfunction.

$user = $c->userService()->getUserByLookup(
    $c->userService()->searchUsers('jane', 'organization_1')[0]

Reading Attributes

User attributes are name-value pairs that administrators can assign to any user. To read the attributes on a given user, pass a Userobject to the getAttributesfunction. You can also specifiy specific attributes that you wish to read, otherwise all attributes for the user will be returned.

$californiaUser = $c->userService()->getUser("CaliforniaUser", "organization_1");
$attributes = $c->userService()->getAttributes($californiaUser);		

Adding or Updating Attributes

Use addOrUpdateAttributefunction to create or update an attribute for a user. Specify the name and value in an Attributeobject. If the attribute name matches an existing attribute, its value is updated. If the attribute name does not exist for the given user, the attribute is added to the user.

$CAuser = $c->userService()->getUser("CaliforniaUser", "organization_1");
$animal_attr = new Attribute("Favorite Animal", "Bear");
$c->userService()->addOrUpdateAttribute($CAuser, $animal_attr);		

Deleting Attributes

To remove attributes from a user, pass a Userobject and an array of attribute names (not Attributeobjects) to the deleteAttributesfunction. If no attribute names are given, all attributes are removed.

$joeUser = $c->userService()->getUser("joeuser", "organization_1");