Types Defined in the WSDL

The WSDL (Web Services Description Language) document defines the types that are returned by operations of the services. The types belong to the http://www.jasperforge.org/jasperserver/ws namespace. The namespace is only an identifier; it is not a valid URL. For the complete reference, refer to the WSDL document in jasperserver-ws-server-4.0.jar.

The following tables summarize the services’ operations.

Users and Roles Service

Operation

Parameter

Parameter Type

Return Type

Description

findUsers

criteria

WSUserSearchCriteria

WSUser[]

Returns a list of one or more users.

criteria has username mask, organization/tenant ID, includeSubOrgs, list of required roles, and maxRecords; null in parameters means "any."

Note: includeSubOrgs and tenantID are reserved for use in our commercial products. If they are used in community project products, they must be NULL.

putUser

user

WSUser

WSUser

Adds or updates a user.

Returns the new or updated WSUser.

deleteUser

user

WSUser

No return

Deletes the named user.

findRoles

criteria

WSRoleSearchCriteria

WSRole[]

Returns WSRole[], a list of roles.

criteria has rolename mask, organization/tenant ID, includeSubOrgs, maxRecords; null in parameters means "any."

Note: includeSubOrgs and tenantID are reserved for use in our commercial products. If they are used in community project products, they must be NULL.

putRole

role

WSRole

WSRole

Adds or updates a role.

Returns new or updated WSRole.

updateRoleName

oldRole

WSRole

WSRole

Returns WSRole.

newName

String

WSRole

New name of role.

deleteRole

role

WSRole

No return

Deletes the named role.

Organizations/Tenants Service

Operation

Parameter

Parameter Type

Return Type

Description

getTenant

tenantId

String

WSTenant[]

Organization/tenant identifier.

Returns an organization/tenant.

getSubTenantList

tenantId

String

WSTenant[]

Organization/tenant identifier.

Returns WSTenant[], a list of suborganizations in the specified organization.

putTenant

tenant

WSTenant

WSTenant

Adds or updates a tenant.

Returns the new or updated WSTenant.

deleteTenant

tenantId

String

No return

Deletes the named organization/tenant.

Permissions Service

Operation

Parameter

Parameter Type

Return Type

Description

getPermissionsForObject

targetURI

String

WSObjectPermission[]

Repository object URI.

Returns WSObjectPermission[], a list of permissions for the specified object.

putPermissions

objPerm

WSObjectPermission

WSObjectPermission

Object permission.

Returns WSObjectPermission, a new or updated object permission.

deletePermissions

objPerm

WSObjectPermission

No return

Deletes the named permission.

Version: 
Feedback