# Class: DocumentRoot

## tibco.objectapi.de.resource.DocumentRoot

#### new DocumentRoot()

Constructs a new DocumentRoot.

The following features are supported:

- `Create Resource`
- `Create Resource Response`
- `Delete Resource`
- `Delete Resource Response`
- `Find Resources`
- `Find Resources Response`
- `Get Deleted Resources`
- `Get Deleted Resources Response`
- `Get Resource`
- `Get Resource Response`
- `Purge Deleted Resources`
- `Purge Deleted Resources Response`
- `Update Resource`
- `Update Resource Response`

### Members

#### createResource :tibco.objectapi.de.resource.XmlCreateResource

This property holds the value of the 'Create Resource' containment reference.

##### Type:

- tibco.objectapi.de.resource.XmlCreateResource

#### createResourceResponse :tibco.objectapi.de.resource.CreateResourceResponseType

Response element for the createResource operation. Details the properties and attributes of the resource identified in the request. This property holds the value of the 'Create Resource Response' containment reference.

##### Type:

- tibco.objectapi.de.resource.CreateResourceResponseType

#### deleteResource :tibco.objectapi.de.resource.XmlDeleteResource

This property holds the value of the 'Delete Resource' containment reference.

##### Type:

- tibco.objectapi.de.resource.XmlDeleteResource

#### deleteResourceResponse :tibco.objectapi.de.resource.DeleteResourceResponseType

Response element for the deleteResource operation. This property holds the value of the 'Delete Resource Response' containment reference.

##### Type:

- tibco.objectapi.de.resource.DeleteResourceResponseType

#### findResources :tibco.objectapi.de.resource.FindResourcesType

Request element for the findResource operation. The request identifies any number of groups, positions, organization units, organizations, locations, capabilities, or privileges from which the associated resources will be identified. The request may also identify resources by their name. Normally either GUIDs or resource names are specified in the request, however a mixture can be specified if necessary. Note that a request with no GUIDs or resource names is invalid - at least one of the two must be specified. Where both GUIDs and resource names are specified in the request these lists are independent of each of other - the GUIDs do not need to match up with corresponding resource names. The response lists those resources, giving their GUID, name, and label properties. If the same resource is associated with more than one of the entities identified in the request, that resource only appears once in the response. The response does not indicate the entity from which the resource was located. The model version in the request identifies the organization model major version in which the search for the entities should be performed. The default value of -1 indicates that the latest version should be used. When the request is to locate resources by their names, the model version is not used (but must still be valid). As a resource's associations, and the resource itself, can be limited by a date range, the search can selectively include only those resources that are currently associated with the identified entities. When searching by resource name or associations, a true value ensures that the response only includes those resources whose date restrictions fall within the current date/time. This property holds the value of the 'Find Resources' containment reference.

##### Type:

- tibco.objectapi.de.resource.FindResourcesType

#### findResourcesResponse :tibco.objectapi.de.resource.FindResourcesResponseType

Response element for the findResource operation. The request identifies any number of groups, positions, organization units, organizations, locations, capabilities or privileges, from which the associated resources are to be identified. The response lists those resources, giving their GUID, name, and label properties. If the same resource is associated with more than one of the entities identified in the request, that resource only appears once in the response. The response does not indicate the entity from which the resource was located. Any date range that applies to either the resource or its association with the entity is ignored, unless the request indicates that only current resources are to be included. The GUIDs of the resources included in the response can be passed to the getResource operation in order to retrieve detailed information on any resource. The model version in the response identifies the organization model major version in which the search for the entities was performed. This property holds the value of the 'Find Resources Response' containment reference.

##### Type:

- tibco.objectapi.de.resource.FindResourcesResponseType

#### getDeletedResources :tibco.objectapi.de.resource.GetDeletedResourcesType

Requests a list of the deleted resources. The results will be ordered by name, and may be, optionally, paged. This property holds the value of the 'Get Deleted Resources' containment reference.

##### Type:

- tibco.objectapi.de.resource.GetDeletedResourcesType

#### getDeletedResourcesResponse :tibco.objectapi.de.resource.GetDeletedResourcesResponseType

The response object for XmlGetDeletedResources. Lists the details of the deleted resources. This property holds the value of the 'Get Deleted Resources Response' containment reference.

##### Type:

- tibco.objectapi.de.resource.GetDeletedResourcesResponseType

#### getResource :tibco.objectapi.de.resource.XmlGetResource

This property holds the value of the 'Get Resource' containment reference.

##### Type:

- tibco.objectapi.de.resource.XmlGetResource

#### getResourceResponse :tibco.objectapi.de.resource.GetResourceResponseType

Response element for the getResource operation. Details the properties and attributes of the resources identified in the request. This property holds the value of the 'Get Resource Response' containment reference.

##### Type:

- tibco.objectapi.de.resource.GetResourceResponseType

#### purgeDeletedResources :tibco.objectapi.de.resource.PurgeDeletedResourcesType

Requests that the identified, deleted resource records be purged. This property holds the value of the 'Purge Deleted Resources' containment reference.

##### Type:

- tibco.objectapi.de.resource.PurgeDeletedResourcesType

#### purgeDeletedResourcesResponse :tibco.objectapi.de.resource.PurgeDeletedResourcesResponseType

The response object for purgeDeletedResources requests. This property holds the value of the 'Purge Deleted Resources Response' containment reference.

##### Type:

- tibco.objectapi.de.resource.PurgeDeletedResourcesResponseType

#### updateResource :tibco.objectapi.de.resource.XmlUpdateResource

This property holds the value of the 'Update Resource' containment reference.

##### Type:

- tibco.objectapi.de.resource.XmlUpdateResource

#### updateResourceResponse :tibco.objectapi.de.resource.UpdateResourceResponseType

Response element for the updateResource operation. Provides an acknowledgement of the update and details the properties and attributes of the resources identified in the request. This property holds the value of the 'Update Resource Response' containment reference.

##### Type:

- tibco.objectapi.de.resource.UpdateResourceResponseType