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, page 46
• createExportArchive, page 69
• createImportArchive, page 73
• getArchiveContents, page 102
• getArchiveExportData, page 104
• getArchiveExportSettings, page 105
• getArchiveImportReport, page 106
• getArchiveImportSettings, page 108
• performArchiveImport, page 177
• updateArchiveExportSettings, page 196
• updateArchiveImportSettings, page 198

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, page 56
• executeNativeSql, page 86
• executeProcedure, page 89
• executeSql, page 92
• executeSqlScript, page 98
• getProceduralResult, page 143
• getResourcePlan, page 148
• getResultSetPlan, page 155
• getSqlPlan, page 159
• getTabularResult, page 161
• parseSqlQuery, page 176

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, page 54
— getCachedResourceStatisticsConfig, page 110
— getResourceCacheConfig, page 146
— getResourceStatsSummary, page 152
— refreshResourceCache, page 184
— updateCachedResourceStatisticsConfig, page 201
— updateResourceCacheConfig, page 225
• Connectors
— createConnector, page 64
— destroyConnector, page 81
— getConnectorGroup, page 113
— getConnectorGroupNames, page 113
— getConnectors, page 114
— testDataSourceConnection, page 193
— updateConnector, page 204
• Data services
— updateDataServicePort, page 205
— updateImplementationContainer, page 220
• Data sources
— createDataSource, page 65
— getUsedDataSources, page 163
— updateDataSource, page 207
— updateDataSourcePort, page 211

Attribute definitions

— getDataSourceAttributeDefs, page 115

Custom types

— createCustomDataSourceType, page 64
— destroyCustomDataSourceType, page 81
— updateCustomDataSourceType, page 205

Location and Dependencies

— getDataSourceChildResources, page 115 (deprecated)
— updateDataSourceChildInfos, page 208 (deprecated)
— updateDataSourceChildInfosWithFilter, page 209

Statistics

— getDataSourceStatisticsConfig, page 118
— updateDataSourceStatisticsConfig, page 213

Types

— getDataSourceTypeAttributeDefs, page 119
— getDataSourceTypeCustomCapabilities, page 119
— getDataSourceTypes, page 120
— getExtendableDataSourceTypes, page 125
— getParentDataSourceType, page 141
— updateDataSourceTypeCustomCapabilities, page 214
• Definition sets
— updateDefinitionSet, page 215
• Introspection
— clearIntrospectableResourceIdCache, page 53
— getIntrospectableResourceIdsResult, page 128
— getIntrospectableResourceIdsTask, page 130
— getIntrospectedResourceIdsResult, page 132
— getIntrospectedResourceIdsTask, page 134
— getIntrospectionAttributeDefs, page 135
— getIntrospectionAttributes, page 136
— getMostRecentIntrospectionStatus, page 139
— introspectResourcesResult, page 167
— introspectResourcesTask, page 169
• Links
— createLink, page 74
— createLinksRecursively, page 76
— updateLink, page 221
• Reintrospection
— cancelDataSourceReintrospect, page 48 (deprecated)
— getDataSourceReintrospectResult, page 117
— reintrospectDataSource, page 185 (deprecated)
• Resources
— copyResource, page 58
— copyResources, page 61
— createResource, page 78
— destroyResource, page 84
— destroyResources, page 85
— getResource, page 145
— getResources, page 150
— getResourceUpdates, page 153
— getUsedResources, page 164
— moveResource, page 173
— moveResources, page 175
— rebindResources, page 183
— renameResource, page 190
— resourceExists, page 192
— updateResourceAnnotation, page 224
— updateResourceEnabled, page 228
— updateResources, page 230
— updateResourcePrivileges, page 229

Location and Dependencies

— getAllResourcesByPath, page 101
— getAncestorResources, page 101
— getChildResources, page 111
— getDependentResources, page 120
— getParentResource, page 141

Locks

— getLockedResources, page 137
— lockResource, page 172
— lockResources, page 173
— unlockResource, page 194
— unlockResources, page 195
— updateUserLockState, page 241

Owner

— changeResourceOwner, page 51

Privileges

— copyResourcePrivileges, page 60
— getResourcePrivileges, page 149
— updateResourcePrivileges, page 229

Statistics

— cancelResourceStatistics, page 49
— clearResourceStatistics, page 55
— getResourceStatisticsConfig, page 151
— refreshResourceStatistics, page 185
— updateResourceStatisticsConfig, page 231
• SQL and SQL Script
— updateExternalSqlProcedure, page 217
— updateSqlScriptProcedure, page 234
— updateSqlTable, page 235
• Transformation
— getTransformFunctions, page 163
— updateBasicTransformProcedure, page 200
— updateStreamTransformProcedure, page 236
— updateTransformProcedure, page 237
— updateXQueryTransformProcedure, page 242
— updateXsltTransformProcedure, page 245
• Triggers
— updateTrigger, page 238
• XQuery
— updateXQueryProcedure, page 241
— updateXQueryTransformProcedure, page 242
• XSLT
— updateXSLTProcedure, page 244
— updateXsltTransformProcedure, page 245

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, page 39
• createCluster, page 63
• createDBHealthMonitorTable, page 67
• getClusterConfig, page 112
• getCreateDBHealthMonitorTableSQL, page 114
• getLicenses, page 137
• getServerActions, page 156
• getServerAttributeDefChildren, page 156
• getServerAttributeDefs, page 157
• getServerAttributes, page 158
• getServerName, page 159
• joinCluster, page 171
• performServerAction, page 178
• removeFromCluster, page 187
• removeLicenses, page 187
• repairCluster, page 191
• updateClusterName, page 203
• updateServerAttributes, page 233
• updateServerName, page 233

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, page 40
• addUserToGroups, page 41
• cancelCreateDomain, page 47
• createDomain, page 68
• createGroup, page 72
• createUser, page 80
• destroyDomain, page 82
• destroyGroup, page 83
• destroyUser, page 86
• getDomainGroups, page 121
• getDomains, page 122
• getDomainTypeAttributeDefs, page 123
• getDomainTypes, page 124
• getDomainUsers, page 124
• getGroups, page 127
• getGroupsByUser, page 127
• getUser, page 165
• getUsers, page 165
• getUsersByGroup, page 166
• removeUserFromGroups, page 189
• removeUsersFromGroup, page 190
• updateDomain, page 216
• updateGroup, page 219
• updateUser, page 240