# Class: DocumentRoot

## tibco.objectapi.de.browse.DocumentRoot

#### new DocumentRoot()

Constructs a new DocumentRoot.

The following features are supported:

- `Browse Model Node`
- `Browse Model Node Response`
- `Get Capabilities`
- `Get Capabilities Response`
- `Get Privileges`
- `Get Privileges Response`
- `List Capabilities`
- `List Capabilities Response`
- `List Model Versions`
- `List Model Versions Response`
- `List Organizations`
- `List Organizations Response`
- `List Org Model Overview`
- `List Org Model Overview Response`
- `List Privileges`
- `List Privileges Response`
- `Open Org Model`
- `Open Org Model Response`

### Members

#### browseModelNode :tibco.objectapi.de.browse.BrowseModelNodeType

Request element for browseModelNode operation. This operation returns the details of the organization model entity identified by its entity-type, guid and organization model version. If no organization model version is specified (or -1) then the organization model with the greatest major version value is assumed. Each root-node in the response will indicate whether it has any children. For example, an organization entity may have organization unit entities as its children. If so, the identifiers for those immediate children will be given in the "child" sub-elements. These identifiers can, in-turn, be passed back into the browseModelNode operation in order to drill-down further into the organization model structure. For organization entities, this operation will identify those LDAP containers that administer them. That is those LDAP containesr whose resources are permitted to view that organization structure. If no LDAP containers are listed, then the organization can be accessed by all resources. Where applicable, each node in the response will specify the "selection-mode" by which associated resources will be selected for work allocation. This operation is used with the openOrgModel operation to provide a drill-down view of an organization model structure. It is useful for large organization models, where retrieving the entire structure would be expensive. The recommended alternative is to use the listOrgModelOverview operation. This property holds the value of the 'Browse Model Node' containment reference.

##### Type:

- tibco.objectapi.de.browse.BrowseModelNodeType

#### browseModelNodeResponse :tibco.objectapi.de.browse.BrowseModelNodeResponseType

Response element for browseModelNode operation. Returns the details about a specific organization model entity and its immediate children. Any child entities will identify whether they, themselves, have child entities, but will not contain those child entities. Another request to browse a child entity will be required to retrieve its child entities. This property holds the value of the 'Browse Model Node Response' containment reference.

##### Type:

- tibco.objectapi.de.browse.BrowseModelNodeResponseType

#### getCapabilities :tibco.objectapi.de.browse.GetCapabilitiesType

Request element for getCapabilities operation. This operation returns the capabilities associated with the position, group or resource identified in the request by its entity-type, guid and model version. If no organization model version is specified (or -1) then the organization model with the greatest major version value is assumed. If a capability is qualified, the qualifier values will be included in the qualifierSet elements for that entry. This property holds the value of the 'Get Capabilities' containment reference.

##### Type:

- tibco.objectapi.de.browse.GetCapabilitiesType

#### getCapabilitiesResponse :tibco.objectapi.de.browse.GetCapabilitiesResponseType

Response element for getCapabilities operation. This property holds the value of the 'Get Capabilities Response' containment reference.

##### Type:

- tibco.objectapi.de.browse.GetCapabilitiesResponseType

#### getPrivileges :tibco.objectapi.de.browse.GetPrivilegesType

Request element for getPrivileges operation. This operation returns the privileges associated with the organization unit, position or group identified in the request by its entity-type, guid and model version. If no organization model version is specified (or -1) then the organization model with the greatest major version value is assumed. The response includes only those privileges directly associated with the identified entity, and not those that the entity might inherit from its parent. (For example, a position inherits privileges from its parent organization unit.) If a privilege is qualified, the qualifier values will be included in the qualifierSet elements for that entry. This property holds the value of the 'Get Privileges' containment reference.

##### Type:

- tibco.objectapi.de.browse.GetPrivilegesType

#### getPrivilegesResponse :tibco.objectapi.de.browse.GetPrivilegesResponseType

Response element for getPrivileges operation. This property holds the value of the 'Get Privileges Response' containment reference.

##### Type:

- tibco.objectapi.de.browse.GetPrivilegesResponseType

#### listCapabilities :tibco.objectapi.de.browse.ListCapabilitiesType

Request element for listCapabilities operation. This operation lists the capabilities available in a given organization model version. If no organization model version is specified (or -1) then the organization model with the greatest major version value is assumed. The result includes the GUID and name of each capabiliy. If a capability is qualified, the qualifier is also described (including the data-type and permitted values where applicable). This property holds the value of the 'List Capabilities' containment reference.

##### Type:

- tibco.objectapi.de.browse.ListCapabilitiesType

#### listCapabilitiesResponse :tibco.objectapi.de.browse.ListCapabilitiesResponseType

Response element for listCapabilities operation. This property holds the value of the 'List Capabilities Response' containment reference.

##### Type:

- tibco.objectapi.de.browse.ListCapabilitiesResponseType

#### listModelVersions :tibco.objectapi.de.browse.ListModelVersionsType

Request element for listModelVersions operation. This operation lists the available organization model major versions. For each major version, the organization model deployments that make up that version will be detailed - giving their full version number, name and date deployed. This property holds the value of the 'List Model Versions' containment reference.

##### Type:

- tibco.objectapi.de.browse.ListModelVersionsType

#### listModelVersionsResponse :tibco.objectapi.de.browse.ListModelVersionsResponseType

Response element for listModelVersions operation. This property holds the value of the 'List Model Versions Response' containment reference.

##### Type:

- tibco.objectapi.de.browse.ListModelVersionsResponseType

#### listOrganizations :tibco.objectapi.de.EmptyRequest

Request to provide a list of all organizations currently deployed. This operation returns a list of all organization entities, from all organization model versions. Each organization is identified by itsentity-type, guid, model-version and name. This property holds the value of the 'List Organizations' containment reference.

##### Type:

- tibco.objectapi.de.EmptyRequest

#### listOrganizationsResponse :tibco.objectapi.de.browse.ListOrganizationsResponseType

Response element providing a list of all Organizations currently deployed. This property holds the value of the 'List Organizations Response' containment reference.

##### Type:

- tibco.objectapi.de.browse.ListOrganizationsResponseType

#### listOrgModelOverview :tibco.objectapi.de.browse.ListOrgModelOverviewType

Request element for listOrgModelOverview operation. This operation returns the structure of the organization model identified by given major version number. If no organization model version is specified (or -1) then the organization model with the greatest major version value is assumed. The response will include the entire group hierarchy, organization, organization unit and position hierarchy and the locations defined in the organization model. For organization entities, this operation will identify those LDAP containers that administer them. That is, those LDAP containers whose resources are permitted to view that organization structure. If no LDAP containers are listed, then the organization can be accessed by all resources. Where applicable, each node in the response will specify the "selection-mode" by which associated resources will be selected for work allocation. This property holds the value of the 'List Org Model Overview' containment reference.

##### Type:

- tibco.objectapi.de.browse.ListOrgModelOverviewType

#### listOrgModelOverviewResponse :tibco.objectapi.de.browse.ListOrgModelOverviewResponseType

Response element for listOrgModelOverview operation. This property holds the value of the 'List Org Model Overview Response' containment reference.

##### Type:

- tibco.objectapi.de.browse.ListOrgModelOverviewResponseType

#### listPrivileges :tibco.objectapi.de.browse.ListPrivilegesType

Request element for listPrivileges operation. This operation lists the privileges available in a given organization model version. If no organization model version is specified (or -1) then the organization model with the greatest major version value is assumed. The result includes the GUID and name of each privilege. If a privilege is qualified, the qualifier is also described (including the data-type and permitted values where applicable). This property holds the value of the 'List Privileges' containment reference.

##### Type:

- tibco.objectapi.de.browse.ListPrivilegesType

#### listPrivilegesResponse :tibco.objectapi.de.browse.ListPrivilegesResponseType

Response element for listPrivileges operation. This property holds the value of the 'List Privileges Response' containment reference.

##### Type:

- tibco.objectapi.de.browse.ListPrivilegesResponseType

#### openOrgModel :tibco.objectapi.de.browse.OpenOrgModelType

Request element for openOrgModel operation. This operation returns the root entities of the organization model identified by the given major version number. If no organization model version is specified (or -1) then the organization model with the greatest major version value is assumed. Each root-node in the response will indicate whether it has any children - for example, an organization entity may have organization unit entities as its children. If so, the identifiers for those immediate children will be given in the "child" sub-elements. These identifiers can, in-turn, be passed to the browseModelNode service in order to drill-down further into the organization model structure. For organization entities, this operation will identify those LDAP containers that administer them. That is, those LDAP containers whose resources are permitted to view that organization structure. If no LDAP containers are listed, then the organization can be accessed by all resources. Where applicable, each node in the response will specify the "selection-mode" by which associated resources will be selected for work allocation. This operation is used with the browseModelNode service to provide a drill-down view of an organization model structure. It is useful for large organization models, where retrieving the entire structure would be expensive. The recommended alternative is to use the listOrgModelOverview operation. This property holds the value of the 'Open Org Model' containment reference.

##### Type:

- tibco.objectapi.de.browse.OpenOrgModelType

#### openOrgModelResponse :tibco.objectapi.de.browse.OpenOrgModelResponseType

Response element for openOrgModel operation. This identifies the version of the organization model and lists the organization, group and location entities that form the roots through which the organization model can be traversed. This property holds the value of the 'Open Org Model Response' containment reference.

##### Type:

- tibco.objectapi.de.browse.OpenOrgModelResponseType