Viewing an Organization

The GET method retrieves information about an organization and optionally its child organizations. To specify an organization, use its ID, not its path.

Method

URL

GET

http://<host>:<port>/jasperserver-pro/rest/organization/organizationID?<arguments>

Argument

Type/Value

Description

listSubOrgs?

Boolean

When this argument is omitted or is false, only the specified organization is returned. When true only the suborganizations are returned.

Return Value on Success

Typical Return Values on Failure

200 OK – The content is a descriptor for the organization or its suborganizations.

404 Not Found – When the specified organization ID is not found in the server.

When the listSubOrgs argument is omitted or false, the GET method returns a single tenant descriptor for the given organization:

<tenant>
  <alias>organization_1</alias>
  <id>organization_1</id>
  <parentId>organizations</parentId>
  <tenantDesc> </tenantDesc>
  <tenantFolderUri>/organizations/organization_1</tenantFolderUri>
  <tenantName>Organization</tenantName>
  <tenantNote> </tenantNote>
  <tenantUri>/organization_1</tenantUri>
  <theme>default</theme>
</tenant>

The tenantFolderURI is always relative to the user ID that authenticated the request. In these two examples, the user ID is superuser.

When the listSubOrgs argument is true, the GET method returns a list of tenant descriptors. If the given organization has no suborganizations, the list is empty.

<tenantsList>
  <tenant>
    <alias>SubOrganization</alias>
    <id>SubOrganization</id>
    <parentId>organization_1</parentId>
    <tenantDesc>My SubOrganization</tenantDesc>
    <tenantFolderUri>/organizations/organization_1/organizations/SubOrganization
      </tenantFolderUri>
    <tenantName>SubOrganization</tenantName>
    <tenantUri>/organization_1/SubOrganization</tenantUri>
    <theme>default</theme>
  </tenant>
</tenantsList>
Version: 
Feedback