# Class: DocumentRoot

## tibco.objectapi.ec.DocumentRoot

#### new DocumentRoot()

Constructs a new DocumentRoot.

The following features are supported:

- `Batch Event Request`
- `Check Auto Archive Request`
- `Check Auto Archive Response`
- `Check Purge Audit Request`
- `Check Purge Audit Response`
- `Comment Request`
- `Comment Response`
- `Do Purge Audit Request`
- `Do Purge Audit Response`
- `Event Request`
- `Event Response`
- `Execute Action Request`
- `Execute Action Response`
- `Execute Generic Query Request`
- `Execute Generic Query Response`
- `Execute Registered Generic Query Request`
- `Execute Registered Generic Query Response`
- `Get All Attributes Request`
- `Get All Attributes Response`
- `Get Attributes Request`
- `Get Attributes Response`
- `Get Case Audit Request`
- `Get Case Audit Response`
- `Get Chart Data Request`
- `Get Chart Data Response`
- `Get Chart Request`
- `Get Chart Response`
- `Get Comment Audit Request`
- `Get Comment Audit Response`
- `Get Components Request`
- `Get Components Response`
- `Get Configuration Request`
- `Get Configuration Response`
- `Get Process Instance Audit Request`
- `Get Process Instance Audit Response`
- `Get Work Item Audit Request`
- `Get Work Item Audit Response`
- `Is Query Registered Request`
- `Is Query Registered Response`
- `Lookup Query By Tag Request`
- `Lookup Query By Tag Response`
- `Register Attributes Request`
- `Register Attributes Response`
- `Register Component Request`
- `Register Component Response`
- `Register Environment Request`
- `Register Environment Response`
- `Register Messages Request`
- `Register Messages Response`
- `Register Query Request`
- `Register Query Response`
- `Request Generic Measure Request`
- `Request Generic Measure Response`
- `Request Measure Request`
- `Request Measure Response`
- `Request Process Duration Measure Request`
- `Request Process Duration Measure Response`
- `Request Process Template Measure Request`
- `Request Process Template Measure Response`
- `Request Work Item Performance For Resource Request`
- `Request Work Item Performance For Resource Response`
- `Request Work Item Performance For Template Request`
- `Request Work Item Performance For Template Response`
- `Set Configuration Request`
- `Set Configuration Response`
- `Stop Auto Archive Request`
- `Stop Auto Archive Response`
- `Stop Purge Audit Request`
- `Stop Purge Audit Response`
- `Trigger Auto Archive Request`
- `Trigger Auto Archive Response`
- `Un Register Query Request`
- `Un Register Query Response`

### Members

#### batchEventRequest :tibco.objectapi.ec.BatchEventObject

Request element for batchEvent operation This property holds the value of the 'Batch Event Request' containment reference.

##### Type:

- tibco.objectapi.ec.BatchEventObject

#### checkAutoArchiveRequest :tibco.objectapi.ec.CheckAutoArchiveRequestObject

Request element for the checkAutoArchive operation. This request takes no parameters. This property holds the value of the 'Check Auto Archive Request' containment reference.

##### Type:

- tibco.objectapi.ec.CheckAutoArchiveRequestObject

#### checkAutoArchiveResponse :tibco.objectapi.ec.CheckAutoArchiveResponseObject

Response element for the checkAutoArchive operation. This property holds the value of the 'Check Auto Archive Response' containment reference.

##### Type:

- tibco.objectapi.ec.CheckAutoArchiveResponseObject

#### checkPurgeAuditRequest :tibco.objectapi.ec.CheckPurgeAuditRequestObject

Request element for the checkPurgeAudit operation. This request takes no parameters. This property holds the value of the 'Check Purge Audit Request' containment reference.

##### Type:

- tibco.objectapi.ec.CheckPurgeAuditRequestObject

#### checkPurgeAuditResponse :tibco.objectapi.ec.CheckPurgeAuditResponseObject

Response element for the checkPurgeAudit operation. This property holds the value of the 'Check Purge Audit Response' containment reference.

##### Type:

- tibco.objectapi.ec.CheckPurgeAuditResponseObject

#### commentRequest :tibco.objectapi.ec.CommentObject

Request element for comment operation This property holds the value of the 'Comment Request' containment reference.

##### Type:

- tibco.objectapi.ec.CommentObject

#### commentResponse :tibco.objectapi.ec.CommentResponseObject

Response element for comment operation This property holds the value of the 'Comment Response' containment reference.

##### Type:

- tibco.objectapi.ec.CommentResponseObject

#### doPurgeAuditRequest :tibco.objectapi.ec.DoPurgeAuditRequestObject

Request element for the doPurgeAudit operation. This property holds the value of the 'Do Purge Audit Request' containment reference.

##### Type:

- tibco.objectapi.ec.DoPurgeAuditRequestObject

#### doPurgeAuditResponse :tibco.objectapi.ec.DoPurgeAuditResponseObject

Response element for the doPurgeAudit operation. This property holds the value of the 'Do Purge Audit Response' containment reference.

##### Type:

- tibco.objectapi.ec.DoPurgeAuditResponseObject

#### eventRequest :tibco.objectapi.ec.EventObject

Request element for event and errorEvent operations This property holds the value of the 'Event Request' containment reference.

##### Type:

- tibco.objectapi.ec.EventObject

#### eventResponse :tibco.objectapi.ec.EventResponseObject

Response element for event operations This property holds the value of the 'Event Response' containment reference.

##### Type:

- tibco.objectapi.ec.EventResponseObject

#### executeActionRequest :tibco.objectapi.ec.ExecuteActionRequestObject

**PRIVATE API - Reserved for internal use** This property holds the value of the 'Execute Action Request' containment reference.

##### Type:

- tibco.objectapi.ec.ExecuteActionRequestObject

#### executeActionResponse :tibco.objectapi.ec.ExecuteActionResponseObject

**PRIVATE API - Reserved for internal use** This property holds the value of the 'Execute Action Response' containment reference.

##### Type:

- tibco.objectapi.ec.ExecuteActionResponseObject

#### executeGenericQueryRequest :tibco.objectapi.ec.ExecuteQueryObject

Request element for executeGenericQuery operation. This property holds the value of the 'Execute Generic Query Request' containment reference.

##### Type:

- tibco.objectapi.ec.ExecuteQueryObject

#### executeGenericQueryResponse :tibco.objectapi.ec.GenericQueryResponseObject

Response element for executeGenericQuery operation. This property holds the value of the 'Execute Generic Query Response' containment reference.

##### Type:

- tibco.objectapi.ec.GenericQueryResponseObject

#### executeRegisteredGenericQueryRequest :tibco.objectapi.ec.ExecuteRegisteredQueryObject

Request element for executeRegisteredGenericQuery operation. The specified QueryIdentifier can contain either a guid or a tag to identify the query. A guid is recommended for better performance. This property holds the value of the 'Execute Registered Generic Query Request' containment reference.

##### Type:

- tibco.objectapi.ec.ExecuteRegisteredQueryObject

#### executeRegisteredGenericQueryResponse :tibco.objectapi.ec.GenericQueryResponseObject

Response element for executeRegisteredGenericQuery operation. This property holds the value of the 'Execute Registered Generic Query Response' containment reference.

##### Type:

- tibco.objectapi.ec.GenericQueryResponseObject

#### getAllAttributesRequest :tibco.objectapi.ec.GetAllAttributesObject

Request element for getAllAttributes operation. This property holds the value of the 'Get All Attributes Request' containment reference.

##### Type:

- tibco.objectapi.ec.GetAllAttributesObject

#### getAllAttributesResponse :tibco.objectapi.ec.AttributesResponseObject

Response element for getAllAttributes operation. The list of attributes returned may contain different versions of attributes - each version will be identifieed by a unique ID. This property holds the value of the 'Get All Attributes Response' containment reference.

##### Type:

- tibco.objectapi.ec.AttributesResponseObject

#### getAttributesRequest :tibco.objectapi.ec.GetAttributesObject

Request element for getAttributes operation. This property holds the value of the 'Get Attributes Request' containment reference.

##### Type:

- tibco.objectapi.ec.GetAttributesObject

#### getAttributesResponse :tibco.objectapi.ec.AttributesResponseObject

Response element for getAttributes operation. This property holds the value of the 'Get Attributes Response' containment reference.

##### Type:

- tibco.objectapi.ec.AttributesResponseObject

#### getCaseAuditRequest :tibco.objectapi.ec.GetCaseAuditObject

Request element for getCaseAudit operation This property holds the value of the 'Get Case Audit Request' containment reference.

##### Type:

- tibco.objectapi.ec.GetCaseAuditObject

#### getCaseAuditResponse :tibco.objectapi.ec.GetCaseAuditResponseObject

Response element for getCaseAudit operation This property holds the value of the 'Get Case Audit Response' containment reference.

##### Type:

- tibco.objectapi.ec.GetCaseAuditResponseObject

#### getChartDataRequest :tibco.objectapi.ec.GetChartDataObject

Request element for getChartData operation This property holds the value of the 'Get Chart Data Request' containment reference.

##### Type:

- tibco.objectapi.ec.GetChartDataObject

#### getChartDataResponse :tibco.objectapi.ec.GetChartDataResponseObject

Response element for getChartData operation This property holds the value of the 'Get Chart Data Response' containment reference.

##### Type:

- tibco.objectapi.ec.GetChartDataResponseObject

#### getChartRequest :tibco.objectapi.ec.GetChartObject

Request element for getChart operation This property holds the value of the 'Get Chart Request' containment reference.

##### Type:

- tibco.objectapi.ec.GetChartObject

#### getChartResponse :tibco.objectapi.ec.GetChartResponseObject

Response element for getChart operation This property holds the value of the 'Get Chart Response' containment reference.

##### Type:

- tibco.objectapi.ec.GetChartResponseObject

#### getCommentAuditRequest :tibco.objectapi.ec.GetCommentAuditObject

Request element for getCommentAudit operation This property holds the value of the 'Get Comment Audit Request' containment reference.

##### Type:

- tibco.objectapi.ec.GetCommentAuditObject

#### getCommentAuditResponse :tibco.objectapi.ec.GetCommentAuditResponseObject

Response element for getCommentAudit operation This property holds the value of the 'Get Comment Audit Response' containment reference.

##### Type:

- tibco.objectapi.ec.GetCommentAuditResponseObject

#### getComponentsRequest :tibco.objectapi.ec.GetComponentsObject

Request element for getComponent operation. This property holds the value of the 'Get Components Request' containment reference.

##### Type:

- tibco.objectapi.ec.GetComponentsObject

#### getComponentsResponse :tibco.objectapi.ec.GetComponentsResponseObject

Response element for getComponents operation. (Due to versioning multiple components can be returned with similar details and duplicate attribute definitions.) This property holds the value of the 'Get Components Response' containment reference.

##### Type:

- tibco.objectapi.ec.GetComponentsResponseObject

#### getConfigurationRequest :tibco.objectapi.ec.GetConfigurationRequestObject

**PRIVATE API - Reserved for internal use** This property holds the value of the 'Get Configuration Request' containment reference.

##### Type:

- tibco.objectapi.ec.GetConfigurationRequestObject

#### getConfigurationResponse :tibco.objectapi.ec.GetConfigurationResponseObject

**PRIVATE API - Reserved for internal use** This property holds the value of the 'Get Configuration Response' containment reference.

##### Type:

- tibco.objectapi.ec.GetConfigurationResponseObject

#### getProcessInstanceAuditRequest :tibco.objectapi.ec.GetProcessInstanceAuditObject

Request element for getProcessInstanceAudit operation This property holds the value of the 'Get Process Instance Audit Request' containment reference.

##### Type:

- tibco.objectapi.ec.GetProcessInstanceAuditObject

#### getProcessInstanceAuditResponse :tibco.objectapi.ec.GetProcessInstanceAuditResponseObject

Response element for getProcessInstanceAudit operation This property holds the value of the 'Get Process Instance Audit Response' containment reference.

##### Type:

- tibco.objectapi.ec.GetProcessInstanceAuditResponseObject

#### getWorkItemAuditRequest :tibco.objectapi.ec.GetWorkItemAuditObject

Request element for getWorkItemAudit operation This property holds the value of the 'Get Work Item Audit Request' containment reference.

##### Type:

- tibco.objectapi.ec.GetWorkItemAuditObject

#### getWorkItemAuditResponse :tibco.objectapi.ec.GetWorkItemAuditResponseObject

Response element for getWorkItemAudit operation This property holds the value of the 'Get Work Item Audit Response' containment reference.

##### Type:

- tibco.objectapi.ec.GetWorkItemAuditResponseObject

#### isQueryRegisteredRequest :tibco.objectapi.ec.IsQueryRegisteredObject

Request element for isQueryRegistered operation. This property holds the value of the 'Is Query Registered Request' containment reference.

##### Type:

- tibco.objectapi.ec.IsQueryRegisteredObject

#### isQueryRegisteredResponse :tibco.objectapi.ec.QueryRegisteredResponseObject

Response element for isQueryRegistered operation. This property holds the value of the 'Is Query Registered Response' containment reference.

##### Type:

- tibco.objectapi.ec.QueryRegisteredResponseObject

#### lookupQueryByTagRequest :tibco.objectapi.ec.LookupQueryByTagObject

Request element for lookupQueryByTag operation. This property holds the value of the 'Lookup Query By Tag Request' containment reference.

##### Type:

- tibco.objectapi.ec.LookupQueryByTagObject

#### lookupQueryByTagResponse :tibco.objectapi.ec.LookupQueryByTagResponseObject

Response element for lookupQueryByTag operation. This property holds the value of the 'Lookup Query By Tag Response' containment reference.

##### Type:

- tibco.objectapi.ec.LookupQueryByTagResponseObject

#### registerAttributesRequest :tibco.objectapi.ec.RegisterAttributesObject

Request element for registerAttributes operation This property holds the value of the 'Register Attributes Request' containment reference.

##### Type:

- tibco.objectapi.ec.RegisterAttributesObject

#### registerAttributesResponse :tibco.objectapi.ec.RegisterAttributesResponseObject

Response element for registerAttributes operation This property holds the value of the 'Register Attributes Response' containment reference.

##### Type:

- tibco.objectapi.ec.RegisterAttributesResponseObject

#### registerComponentRequest :tibco.objectapi.ec.RegisterComponentObject

Request element for registerComponent operation This property holds the value of the 'Register Component Request' containment reference.

##### Type:

- tibco.objectapi.ec.RegisterComponentObject

#### registerComponentResponse :tibco.objectapi.ec.RegisterComponentResponseObject

Response element for registerComponent operation This property holds the value of the 'Register Component Response' containment reference.

##### Type:

- tibco.objectapi.ec.RegisterComponentResponseObject

#### registerEnvironmentRequest :tibco.objectapi.ec.RegisterEnvironmentObject

Request element for registerEnvironment operation This property holds the value of the 'Register Environment Request' containment reference.

##### Type:

- tibco.objectapi.ec.RegisterEnvironmentObject

#### registerEnvironmentResponse :tibco.objectapi.ec.RegisterEnvironmentResponseObject

Response element for registerEnvironment operation This property holds the value of the 'Register Environment Response' containment reference.

##### Type:

- tibco.objectapi.ec.RegisterEnvironmentResponseObject

#### registerMessagesRequest :tibco.objectapi.ec.RegisterMessagesObject

Request element for registerMessages operation This property holds the value of the 'Register Messages Request' containment reference.

##### Type:

- tibco.objectapi.ec.RegisterMessagesObject

#### registerMessagesResponse :tibco.objectapi.ec.RegisterMessagesResponseObject

Response element for registerMessages operation This property holds the value of the 'Register Messages Response' containment reference.

##### Type:

- tibco.objectapi.ec.RegisterMessagesResponseObject

#### registerQueryRequest :tibco.objectapi.ec.RegisterQueryObject

Request element for registerQuery operation. This property holds the value of the 'Register Query Request' containment reference.

##### Type:

- tibco.objectapi.ec.RegisterQueryObject

#### registerQueryResponse :tibco.objectapi.ec.RegisterQueryResponseObject

Response element for registerQuery operation. This property holds the value of the 'Register Query Response' containment reference.

##### Type:

- tibco.objectapi.ec.RegisterQueryResponseObject

#### requestGenericMeasureRequest :tibco.objectapi.ec.RequestGenericMeasureObject

**PRIVATE API - Reserved for internal use** This property holds the value of the 'Request Generic Measure Request' containment reference.

##### Type:

- tibco.objectapi.ec.RequestGenericMeasureObject

#### requestGenericMeasureResponse :tibco.objectapi.ec.RequestGenericMeasureResponseObject

**PRIVATE API - Reserved for internal use** This property holds the value of the 'Request Generic Measure Response' containment reference.

##### Type:

- tibco.objectapi.ec.RequestGenericMeasureResponseObject

#### requestMeasureRequest :tibco.objectapi.ec.RequestMeasureObject

**PRIVATE API - Reserved for internal use** This property holds the value of the 'Request Measure Request' containment reference.

##### Type:

- tibco.objectapi.ec.RequestMeasureObject

#### requestMeasureResponse :tibco.objectapi.ec.RequestMeasureResponseObject

**PRIVATE API - Reserved for internal use** This property holds the value of the 'Request Measure Response' containment reference.

##### Type:

- tibco.objectapi.ec.RequestMeasureResponseObject

#### requestProcessDurationMeasureRequest :tibco.objectapi.ec.RequestProcessDurationMeasureObject

Request element for requestProcessDurationMeasure operation. This property holds the value of the 'Request Process Duration Measure Request' containment reference.

##### Type:

- tibco.objectapi.ec.RequestProcessDurationMeasureObject

#### requestProcessDurationMeasureResponse :tibco.objectapi.ec.RequestProcessDurationMeasureResponseObject

Response element for requestProcessDurationMeasure operation. This property holds the value of the 'Request Process Duration Measure Response' containment reference.

##### Type:

- tibco.objectapi.ec.RequestProcessDurationMeasureResponseObject

#### requestProcessTemplateMeasureRequest :tibco.objectapi.ec.RequestProcessTemplateMeasureObject

Request element for requestProcessTemplateMeasure operation. This property holds the value of the 'Request Process Template Measure Request' containment reference.

##### Type:

- tibco.objectapi.ec.RequestProcessTemplateMeasureObject

#### requestProcessTemplateMeasureResponse :tibco.objectapi.ec.RequestProcessTemplateMeasureResponseObject

Response element for requestProcessTemplateMeasure operation. This property holds the value of the 'Request Process Template Measure Response' containment reference.

##### Type:

- tibco.objectapi.ec.RequestProcessTemplateMeasureResponseObject

#### requestWorkItemPerformanceForResourceRequest :tibco.objectapi.ec.RequestWorkItemPerformanceForResourceObject

Request element for requestWorkItemPerformanceForResourceMeasure operation. This property holds the value of the 'Request Work Item Performance For Resource Request' containment reference.

##### Type:

- tibco.objectapi.ec.RequestWorkItemPerformanceForResourceObject

#### requestWorkItemPerformanceForResourceResponse :tibco.objectapi.ec.RequestWorkItemPerformanceForResourceResponseObject

Response element for requestWorkItemPerformanceForResourceMeasure operation. This property holds the value of the 'Request Work Item Performance For Resource Response' containment reference.

##### Type:

- tibco.objectapi.ec.RequestWorkItemPerformanceForResourceResponseObject

#### requestWorkItemPerformanceForTemplateRequest :tibco.objectapi.ec.RequestWorkItemPerformanceForTemplateObject

Request element for requestWorkItemPerformanceForTemplateMeasure operation. This property holds the value of the 'Request Work Item Performance For Template Request' containment reference.

##### Type:

- tibco.objectapi.ec.RequestWorkItemPerformanceForTemplateObject

#### requestWorkItemPerformanceForTemplateResponse :tibco.objectapi.ec.RequestWorkItemPerformanceForTemplateResponseObject

Response element for requestWorkItemPerformanceForTemplateMeasure operation. This property holds the value of the 'Request Work Item Performance For Template Response' containment reference.

##### Type:

- tibco.objectapi.ec.RequestWorkItemPerformanceForTemplateResponseObject

#### setConfigurationRequest :tibco.objectapi.ec.SetConfigurationRequestObject

**PRIVATE API - Reserved for internal use** This property holds the value of the 'Set Configuration Request' containment reference.

##### Type:

- tibco.objectapi.ec.SetConfigurationRequestObject

#### setConfigurationResponse :tibco.objectapi.ec.SetConfigurationResponseObject

**PRIVATE API - Reserved for internal use** This property holds the value of the 'Set Configuration Response' containment reference.

##### Type:

- tibco.objectapi.ec.SetConfigurationResponseObject

#### stopAutoArchiveRequest :tibco.objectapi.ec.StopAutoArchiveRequestObject

Request element for the stopAutoArchive operation. This request takes no parameters. This property holds the value of the 'Stop Auto Archive Request' containment reference.

##### Type:

- tibco.objectapi.ec.StopAutoArchiveRequestObject

#### stopAutoArchiveResponse :tibco.objectapi.ec.StopAutoArchiveResponseObject

Response element for the stopAutoArchive operation. This property holds the value of the 'Stop Auto Archive Response' containment reference.

##### Type:

- tibco.objectapi.ec.StopAutoArchiveResponseObject

#### stopPurgeAuditRequest :tibco.objectapi.ec.StopPurgeAuditRequestObject

Request element for the stopPurgeAudit operation. This request takes no parameters. This property holds the value of the 'Stop Purge Audit Request' containment reference.

##### Type:

- tibco.objectapi.ec.StopPurgeAuditRequestObject

#### stopPurgeAuditResponse :tibco.objectapi.ec.StopPurgeAuditResponseObject

Response element for the stopPurgeAudit operation. This property holds the value of the 'Stop Purge Audit Response' containment reference.

##### Type:

- tibco.objectapi.ec.StopPurgeAuditResponseObject

#### triggerAutoArchiveRequest :tibco.objectapi.ec.TriggerAutoArchiveRequestObject

Request element for the triggerAutoArchive operation. This property holds the value of the 'Trigger Auto Archive Request' containment reference.

##### Type:

- tibco.objectapi.ec.TriggerAutoArchiveRequestObject

#### triggerAutoArchiveResponse :tibco.objectapi.ec.TriggerAutoArchiveResponseObject

Response element for the triggerAutoArchive operation. This property holds the value of the 'Trigger Auto Archive Response' containment reference.

##### Type:

- tibco.objectapi.ec.TriggerAutoArchiveResponseObject

#### unRegisterQueryRequest :tibco.objectapi.ec.UnRegisterQueryObject

Request element for unRegisterQuery operation. This property holds the value of the 'Un Register Query Request' containment reference.

##### Type:

- tibco.objectapi.ec.UnRegisterQueryObject

#### unRegisterQueryResponse :tibco.objectapi.ec.UnRegisterQueryResponseObject

Response element for unRegisterQuery operation. This property holds the value of the 'Un Register Query Response' containment reference.

##### Type:

- tibco.objectapi.ec.UnRegisterQueryResponseObject