Administrative Operations

Application Programming Interface Guide > Introduction > Groups of Operations > Administrative Operations

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

• executeSqlScript

• getProceduralResult

• getResourcePlan

• getResultSetPlan

• 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

Attribute definitions

— getDataSourceAttributeDefs

Custom types

— createCustomDataSourceType

— destroyCustomDataSourceType

— updateCustomDataSourceType

Location and Dependencies

— getDataSourceChildResources (deprecated)

— updateDataSourceChildInfos (deprecated)

— updateDataSourceChildInfosWithFilter

Statistics

— getDataSourceStatisticsConfig

— updateDataSourceStatisticsConfig

Types

— getDataSourceTypeAttributeDefs

— getDataSourceTypeCustomCapabilities

— getDataSourceTypes

— getExtendableDataSourceTypes

— getParentDataSourceType

— updateDataSourceTypeCustomCapabilities

• Definition sets

— updateDefinitionSet

• Introspection

— clearIntrospectableResourceIdCache

— getIntrospectableResourceIdsResult

— getIntrospectableResourceIdsTask

— getIntrospectedResourceIdsResult

— getIntrospectedResourceIdsTask

— getIntrospectionAttributeDefs

— getIntrospectionAttributes

— getMostRecentIntrospectionStatus

— introspectResourcesResult

— introspectResourcesTask

• Links

— createLinksRecursively

• 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

Location and Dependencies

— getAllResourcesByPath

— getAncestorResources

— getChildResources

— getDependentResources

— getParentResource

Locks

— getLockedResources

— lockResource

— lockResources

— unlockResource

— unlockResources

— updateUserLockState

Owner

— changeResourceOwner

Privileges

— copyResourcePrivileges

— getResourcePrivileges

— updateResourcePrivileges

Statistics

— 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

• destroyDomain

• destroyGroup

• destroyUser

• getDomainGroups

• getDomainTypeAttributeDefs

• getDomainTypes

• getDomainUsers

• getGroupsByUser

• getUsersByGroup

• removeUserFromGroups

• removeUsersFromGroup

• updateDomain

• updateGroup