分析工作区管理 API

此 API 支持提取、创建、修改和删除 Tagetik 应用程序的分析工作区（Analytical Workspace）。


API 标题：	AIH Analytical Workspace swagger openapi 3.0.3
描述：	用于 AIH 数据库应用程序中分析工作区管理的 API
版本：	1.000
身份验证：	OAuth2、API Key、JWT、Basic Auth
基础 URL：	https://tenantxyz.api.saastagetik.com/basic https://tenantxyz.api.saastagetik.com/jwt https://tenantxyz.api.saastagetik.com/apikey https://tenantxyz.api.saastagetik.com/oauth2

前提条件¶

请求格式：JSON

响应格式：JSON

共享标头

Content-Type：application/json
Authorisation：Bearer 。

URL¶

/api/aih/datamodel/v1/{dbID}/workspaces

操作	Http 方法	请求体	路径变量	查询字符串参数	响应体	HTTP 响应体	响应状态（异常）
创建	POST	分析工作区			分析工作区	201（已创建）	405（方法不允许） 404（未找到） 403（访问未授权资源） 401（未授权） 400（无效请求）
读取	GET		分析工作区 ID		分析工作区	200（OK）	405（方法不允许） 404（未找到） 403（访问未授权资源） 401（未授权）
删除	DELETE		分析工作区 ID		分析工作区	200（OK）	405（方法不允许） 404（未找到） 403（访问未授权资源） 401（未授权）
替换	PUT	分析工作区	分析工作区 ID		分析工作区	200（OK） 201（已创建）	405（方法不允许） 404（未找到） 403（访问未授权资源） 401（未授权） 400（无效请求）
搜索	GET			filter sort skip take （可选参数）	分析工作区列表	200（OK）	405（方法不允许） 404（未找到） 403（访问未授权资源） 401（未授权） 400（无效请求）
搜索数量	GET			filter sort skip take （可选参数）	分析工作区数量	200（OK）	405（方法不允许） 404（未找到） 403（访问未授权资源） 401（未授权） 400（无效请求）
搜索属性	GET			properties filter sort skip take （properties 为必填，其他参数可选）	仅包含所选属性的分析工作区列表	200（OK）	405（方法不允许） 404（未找到） 403（访问未授权资源） 401（未授权） 400（无效请求）
更新	PATCH	分析工作区	分析工作区 ID		分析工作区	200（OK）	405（方法不允许） 404（未找到） 403（访问未授权资源） 401（未授权） 400（无效请求）
批量	POST	工作区			成功	200（OK）	405（方法不允许） 404（未找到） 403（访问未授权资源） 401（未授权） 400（无效请求）

"filter" 接受字段 "id、descriptions.[language]、online、version、updateInfo.user、updateInfo.date 和 updateInfo.origin"

"properties" 接受所有响应字段，以及显示数据库默认语言描述的 "description" 字段。（必填）

请求中支持的字段¶

oid	-	string
descriptions.[lingua]	-	string（一个必填）
dimensions	无限制	string
online	-	true/false
database	-	string
distributedExecution	-	true/false

¶

'descriptions' 字段由键值数组组成，其中键是语言的缩写形式，值是字符串

'dimension' 字段仅接受与现有维度对应的值

'database' 字段仅接受与现有数据库对应的值

响应中的附加字段¶

分析工作区字段	支持的值
gdpr.checkResult	NOT_CHECKED、NOT_PROTECTED、INCORRECTLY_PROTECTED、ALL_PROTECTED
gdpr.checkResultDate	date
updateInfo.user	string
updateInfo.date	date
updateInfo.origin	INPUT_WEB、

请求示例¶

所有用户的列表


方法	GET
URL	/api/aih/datamodel/v1/{dbID}/workspaces
请求体	-
响应示例	[ { "id": "BXE", "oid": "ALGKYCEPHPESLCH", "dimensions": [], "online": true, "database": null, "gdpr": { "checkResult": "NOT_CHECKED", "checkResultDate": null }, "distributedExecution": false, "updateInfo": { "user": "UTENTE2", "date": "2025-11-28T16:37:49.269+0000", "origin": "INPUT_WEB" }, "descriptions": { "en": "AW Dataset", "it": null, "ja": null, "aa": null, "zh": null, "sq": null, "hy": null, "be": null, "ar": null, "am": null, "as": null } }, { "id": "061", "oid": "MXYZPIFUFSDHUBU", "dimensions": [], "online": true, "database": null, "gdpr": { "checkResult": "NOT_CHECKED", "checkResultDate": null }, "distributedExecution": false, "updateInfo": { "user": "UTENTEPROVA", "date": "2025-06-19T12:57:17.509+0000", "origin": "INPUT_WEB" }, "descriptions": { "en": "DESC1", "it": "DESC2", "ja": null, "aa": null, "zh": null, "sq": null, "hy": null, "be": null, "ar": null, "am": null, "as": null } }, ]

显示特定的分析工作区


方法	GET
URL	/api/aih/datamodel/v1/{dbID}/workspaces/UUU
请求体	-
响应示例	{ "id": "UUU", "oid": "SORXILAQRQKRKMQ", "dimensions": [], "online": true, "database": null, "gdpr": { "checkResult": "NOT_CHECKED", "checkResultDate": null }, "distributedExecution": false, "updateInfo": { "user": "USER2", "date": "2026-01-15T15:18:20.792+0000", "origin": "INPUT_WEB" }, "descriptions": { "it": "TEST", "en": "TEST", "ja": null, "aa": null, "zh": null } }

显示分析工作区的数量


方法	GET
URL	/api/aih/datamodel/v1/{dbID}/workspaces-count
请求体	-
响应示例	`12`

显示所有分析工作区的 ID


方法	GET
URL	/api/aih/datamodel/v1/{dbID}/workspaces-fetch?properties:id
请求体	-
响应示例	`[ { "id": "UUU" }, { "id": "UUV" }, { "id": "UUX" } ]`

创建新的分析工作区


方法	POST
URL	/api/aih/datamodel/v1/{dbID}/workspaces
请求体	`{ "id": "UUU", "descriptions": { "it": "TEST2", "en": "TEST2" }, "online": true }`
响应示例	{ "id": "UUU", "oid": "SORXILAQRQKRKMQ", "dimensions": [], "online": true, "database": null, "gdpr": { "checkResult": "NOT_CHECKED", "checkResultDate": null }, "distributedExecution": false, "updateInfo": { "user": "USER2", "date": "2026-01-15T15:18:20.792+0000", "origin": "INPUT_WEB" }, "descriptions": { "it": "TEST2", "en": "TEST2", "ja": null, "aa": null, "zh": null } }

编辑分析工作区


方法	PATCH
URL	/api/aih/datamodel/v1/{dbID}/workspaces/UUU
请求体	`{ "id": "UUU", "descriptions": { "it": "TEST", "en": "TESTMODIF" }, "distributedExecution": true }`
响应示例	{ "id": "UUU", "oid": "SORXILAQRQKRKMQ", "dimensions": [], "online": true, "database": null, "gdpr": { "checkResult": "NOT_CHECKED", "checkResultDate": null }, "distributedExecution": true, "updateInfo": { "user": "USER2", "date": "2026-01-15T15:18:20.792+0000", "origin": "INPUT_WEB" }, "descriptions": { "it": "TEST", "en": "TESTMODIF", "ja": null, "aa": null, "zh": null } }

创建分析工作区、编辑另一个分析工作区并删除另一个分析工作区


方法	POST
URL	/api/aih/datamodel/v1/{dbID}/workspaces-bulk
请求体	{ "saveMode": "LOOSE", "post": [ { "id": "UUU", "descriptions": { "it": "CREA", "en": "CREATE" }, "online": true } ], "patch": [ { "key": { "id": "UUX" }, "data": { "descriptions": { "it": "MODIFICA", "en": "EDIT" }, "dimensions": [], "online": true, "distributedExecution": false } } ], "delete": [ { "id": "UXV" } ] }
响应示例	`{ "code": "SUCCESS" }`