Administrative Operations
Administrative operations can be found in two places in the resource tree:
| • | Desktop/Data Services/Web Services/system/admin/ |
| • | localhost/services/webservices/system/admin/ |
Administrative operations are grouped into five branches:
| • | The archive Branch |
| • | The execute Branch |
| • | The resource Branch |
| • | The server Branch |
| • | The user Branch |
The archive Branch
The archive branch of administrative operations lets Web Services clients monitor and manage archives.
The operations in this branch are:
| • | cancelArchive |
| • | createExportArchive |
| • | createImportArchive |
| • | getArchiveContents |
| • | getArchiveExportData |
| • | getArchiveExportSettings |
| • | getArchiveImportReport |
| • | getArchiveImportSettings |
| • | performArchiveImport |
| • | updateArchiveExportSettings |
| • | updateArchiveImportSettings |
The execute Branch
The execute branch of administrative operations lets Web Services clients execute SQL, SQL scripts and procedures, and get plans and results.
The operations in this branch are:
| • | closeResult |
| • | executeNativeSql |
| • | executeProcedure |
| • | executeSql |
| • | executeSqlScript |
| • | getProceduralResult |
| • | getResourcePlan |
| • | getResultSetPlan |
| • | getSqlPlan |
| • | getTabularResult |
| • | parseSqlQuery |
The resource Branch
The resource branch of administrative operations lets Web Services clients monitor and manage all TDV resources.
The operations in this branch are grouped by resource category and (in the case of data sources and resources) subcategory:
| • | Caching |
| — | clearResourceCache |
| — | getCachedResourceStatisticsConfig |
| — | getResourceCacheConfig |
| — | getResourceStatsSummary |
| — | refreshResourceCache |
| — | updateCachedResourceStatisticsConfig |
| — | updateResourceCacheConfig |
| • | Connectors |
| — | createConnector |
| — | destroyConnector |
| — | getConnectorGroup |
| — | getConnectorGroupNames |
| — | getConnectors |
| — | testDataSourceConnection |
| — | updateConnector |
| • | Data services |
| — | updateDataServicePort |
| — | updateImplementationContainer |
| • | Data sources |
| — | createDataSource |
| — | getUsedDataSources |
| — | updateDataSource |
| — | updateDataSourcePort |
| — | getDataSourceAttributeDefs |
| — | createCustomDataSourceType |
| — | destroyCustomDataSourceType |
| — | updateCustomDataSourceType |
| — | getDataSourceChildResources (deprecated) |
| — | updateDataSourceChildInfos (deprecated) |
| — | updateDataSourceChildInfosWithFilter |
| — | getDataSourceStatisticsConfig |
| — | updateDataSourceStatisticsConfig |
| — | getDataSourceTypeAttributeDefs |
| — | getDataSourceTypeCustomCapabilities |
| — | getDataSourceTypes |
| — | getExtendableDataSourceTypes |
| — | getParentDataSourceType |
| — | updateDataSourceTypeCustomCapabilities |
| • | Definition sets |
| — | updateDefinitionSet |
| • | Introspection |
| — | clearIntrospectableResourceIdCache |
| — | getIntrospectableResourceIdsResult |
| — | getIntrospectableResourceIdsTask |
| — | getIntrospectedResourceIdsResult |
| — | getIntrospectedResourceIdsTask |
| — | getIntrospectionAttributeDefs |
| — | getIntrospectionAttributes |
| — | getMostRecentIntrospectionStatus |
| — | introspectResourcesResult |
| — | introspectResourcesTask |
| • | Links |
| — | createLink |
| — | createLinksRecursively |
| — | updateLink |
| • | Reintrospection |
| — | cancelDataSourceReintrospect (deprecated) |
| — | getDataSourceReintrospectResult |
| — | reintrospectDataSource (deprecated) |
| • | Resources |
| — | copyResource |
| — | copyResources |
| — | createResource |
| — | destroyResource |
| — | destroyResources |
| — | getResource |
| — | getResources |
| — | getResourceUpdates |
| — | getUsedResources |
| — | moveResource |
| — | moveResources |
| — | rebindResources |
| — | renameResource |
| — | resourceExists |
| — | updateResourceAnnotation |
| — | updateResourceEnabled |
| — | updateResources |
| — | updateResourcePrivileges |
| — | getAllResourcesByPath |
| — | getAncestorResources |
| — | getChildResources |
| — | getDependentResources |
| — | getParentResource |
| — | getLockedResources |
| — | lockResource |
| — | lockResources |
| — | unlockResource |
| — | unlockResources |
| — | updateUserLockState |
| — | changeResourceOwner |
| — | copyResourcePrivileges |
| — | getResourcePrivileges |
| — | updateResourcePrivileges |
| — | cancelResourceStatistics |
| — | clearResourceStatistics |
| — | getResourceStatisticsConfig |
| — | refreshResourceStatistics |
| — | updateResourceStatisticsConfig |
| • | SQL and SQL Script |
| — | updateExternalSqlProcedure |
| — | updateSqlScriptProcedure |
| — | updateSqlTable |
| • | Transformation |
| — | getTransformFunctions |
| — | updateBasicTransformProcedure |
| — | updateStreamTransformProcedure |
| — | updateTransformProcedure |
| — | updateXQueryTransformProcedure |
| — | updateXsltTransformProcedure |
| • | Triggers |
| — | updateTrigger |
| • | XQuery |
| — | updateXQueryProcedure |
| — | updateXQueryTransformProcedure |
| • | XSLT |
| — | updateXSLTProcedure |
| — | updateXsltTransformProcedure |
The server Branch
The server branch of administrative operations lets Web Services clients manage licenses, clusters, server actions and attributes, and other server-level activities.
The operations in this branch are:
| • | addLicenses |
| • | createCluster |
| • | createDBHealthMonitorTable |
| • | getClusterConfig |
| • | getCreateDBHealthMonitorTableSQL |
| • | getLicenses |
| • | getServerActions |
| • | getServerAttributeDefChildren |
| • | getServerAttributeDefs |
| • | getServerAttributes |
| • | getServerName |
| • | joinCluster |
| • | performServerAction |
| • | removeFromCluster |
| • | removeLicenses |
| • | repairCluster |
| • | updateClusterName |
| • | updateServerAttributes |
| • | updateServerName |
The user Branch
The branch of administrative operations lets Web Services clients monitor and manage users, groups, and domains.
The operations in this branch are:
| • | addUsersToGroup |
| • | addUserToGroups |
| • | cancelCreateDomain |
| • | createDomain |
| • | createGroup |
| • | createUser |
| • | destroyDomain |
| • | destroyGroup |
| • | destroyUser |
| • | getDomainGroups |
| • | getDomains |
| • | getDomainTypeAttributeDefs |
| • | getDomainTypes |
| • | getDomainUsers |
| • | getGroups |
| • | getGroupsByUser |
| • | getUser |
| • | getUsers |
| • | getUsersByGroup |
| • | removeUserFromGroups |
| • | removeUsersFromGroup |
| • | updateDomain |
| • | updateGroup |
| • | updateUser |