虚拟数据集管理 API

此 API 支持提取信息、创建、修改和删除 Tagetik 应用程序的虚拟数据集。


API 标题：	AIH Virtual Dataset 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/{awID}/virtualdatasets

操作	Http 方法	请求体	路径变量	查询字符串参数	应答体	HTTP 响应体	响应状态（异常）
Create	POST	虚拟数据集			虚拟数据集	201 (Created)	405（方法不允许） 404（未找到） 403（访问未授权资源） 401（未授权） 400（无效请求）
Read	GET		虚拟数据集 ID		虚拟数据集	200 (OK)	405（方法不允许） 404（未找到） 403（访问未授权资源） 401（未授权）
Delete	DELETE		虚拟数据集 ID		虚拟数据集	200 (OK)	405（方法不允许） 404（未找到） 403（访问未授权资源） 401（未授权）
Replace	PUT	虚拟数据集	虚拟数据集 ID		虚拟数据集	200 (OK) 201 (Created)	405（方法不允许） 404（未找到） 403（访问未授权资源） 401（未授权） 400（无效请求）
Search	GET			filter sort skip take （可选参数）	虚拟数据集列表	200 (OK)	405（方法不允许） 404（未找到） 403（访问未授权资源） 401（未授权） 400（无效请求）
Search Size	GET			filter sort skip take （可选参数）	虚拟数据集的数量	200 (OK)	405（方法不允许） 404（未找到） 403（访问未授权资源） 401（未授权） 400（无效请求）
Update	PATCH	虚拟数据集	虚拟数据集 ID		虚拟数据集	200 (OK)	405（方法不允许） 404（未找到） 403（访问未授权资源） 401（未授权） 400（无效请求）
Bulk	POST	虚拟数据集			成功	200 (OK)	405（方法不允许） 404（未找到） 403（访问未授权资源） 401（未授权） 400（无效请求）

"filter" 接受字段 "id 和 descriptions.[language]"

请求中支持的字段¶

虚拟数据集字段	支持的基数	支持的值
id	-	string（必填）
oid	-	string
descriptions.[lingua]	-	string（一个必填）
sort.field	-	string
sort.sortPositions	-	string
sort.sortType	-	ASC, DESC
relationships.order	-	integer
relationships.leftDataset.id	-	string
relationships.leftDataset.inculdeAllFields	-	true/false
relationships.leftDataset.id	-	string
relationships.leftDataset.inculdeAllFields	-	true/false
joinFields.leftField	-	string
joinFields.rightField	-	string

¶

'descriptions' 字段由一个键值数组组成，其中键是某种语言的缩写措辞，值是一个字符串

响应中的附加字段¶

虚拟数据集字段	支持的值
updateInfo.user	string
updateInfo.date	date
updateInfo.origin	INPUT_WEB

请求示例¶

显示所有虚拟数据集的列表


方法	GET
URL	/api/aih/datamodel/v1/{dbID}/workspaces/{awID}/virtualdatasets
请求体	-
响应示例	[ { "id": "000007", "oid": "IHGJBNPVEYXPZAV", "sort": [ { "field": "INTERNAL", "sortPosition": "20", "sortType": "ASC" }, { "field": "TEXT", "sortPosition": "10", "sortType": "ASC" } ], "relationships": [ { "order": 14, "leftDataset": { "id": "345678", "includeAllFields": false }, "rightDataset": { "id": "000008", "includeAllFields": false }, "joinFields": [ { "leftField": "ANDIM", "rightField": "CC" }, { "leftField": "DIMSW", "rightField": "CC" } ] } ], "updateInfo": { "user": "USERT", "date": "2025-10-28T16:11:32.762+0000", "origin": "INPUT_WEB" }, "descriptions": { "it": "VirtualDataset1", "en": "VirtualDataset1", "ja": "VirtualDataset1", "aa": "VirtualDataset1", "zh": "VirtualDataset1" } }, { "id": "000009", "oid": "RTGWVGDKWFZZLXW", "sort": [], "relationships": [ { "order": 13, "leftDataset": { "id": "000008", "includeAllFields": false }, "rightDataset": { "id": "000006", "includeAllFields": false }, "joinFields": [ { "leftField": "CC", "rightField": "ENT" } ] } ], "updateInfo": { "user": "USERT", "date": "2024-10-29T15:23:24.991+0000", "origin": "INPUT_WEB" }, "descriptions": { "it": "VirtualDatase2", "en": "VirtualDatase2", "ja": null, "aa": null, "zh": null } } ]

显示特定的虚拟数据集


方法	GET
URL	/api/aih/datamodel/v1/{dbID}/workspaces/{awID}/virtualdatasets/123459
请求体	-
响应示例	{ "id": "123459", "oid": "IHGJBNVJEYXPZAV", "sort": [ { "field": "INTERNAL", "sortPosition": "20", "sortType": "ASC" }, { "field": "TEXT", "sortPosition": "10", "sortType": "ASC" } ], "relationships": [ { "order": 14, "leftDataset": { "id": "345678", "includeAllFields": false }, "rightDataset": { "id": "000008", "includeAllFields": false }, "joinFields": [ { "leftField": "ANDIM", "rightField": "CC" }, { "leftField": "DIMSW", "rightField": "CC" } ] } ], "updateInfo": { "user": "USERT", "date": "2025-10-28T16:11:32.762+0000", "origin": "INPUT_WEB" }, "descriptions": { "it": "VirtualDataset1", "en": "VirtualDataset1", "ja": "VirtualDataset1", "aa": "VirtualDataset1", "zh": "VirtualDataset1" } }

显示虚拟数据集的数量


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

创建新的虚拟数据集


方法	POST
URL	/api/aih/datamodel/v1/{dbID}/workspaces/{awID}/virtualdatasets
请求体	`{ "id": "00001A", "oid": "XYH6HH99RHHV1234", "descriptions": { "en": "Virtual Dataset", "it": "Dataset Virtuale" }, "relationships": [ { "order": 0, "leftDataset": { "id": "345678", "includeAllFields": false }, "rightDataset": { "id": "000008", "includeAllFields": false }, "joinFields": [ { "leftField": "ANDIM", "rightField": "CC" } ] } ] }`
响应示例	{ "id": "00001A", "oid": "XYH6HH99RHHV1234", "sort": [], "relationships": [ { "order": 0, "leftDataset": { "id": "345678", "includeAllFields": false }, "rightDataset": { "id": "000008", "includeAllFields": false }, "joinFields": [ { "leftField": "ANDIM", "rightField": "CC" } ] } ], "updateInfo": { "user": "USERT", "date": "2026-01-19T13:55:08.861+0000", "origin": "INPUT_WEB" }, "descriptions": { "it": "Dataset Virtuale Normale", "en": "Normal Virtual Dataset", "ja": null, "aa": null, "zh": null } }

编辑虚拟数据集


方法	PATCH
URL	/api/aih/datamodel/v1/{dbID}/workspaces/{awID}/virtualdatasets/00001A
请求体	`{ "id": "00001A", "oid": "XYH6HH99RHHV1234", "descriptions": { "en": "Modified Virtual Dataset", "it": "Dataset Virtuale Modificato" }, "relationships": [ { "order": 0, "leftDataset": { "id": "345678", "includeAllFields": false }, "rightDataset": { "id": "000008", "includeAllFields": false }, "joinFields": [ { "leftField": "ANDIM", "rightField": "CC" } ] } ] }`
响应示例	{ "id": "00001A", "oid": "XYH6HH99RHHV1234", "sort": [], "relationships": [ { "order": 0, "leftDataset": { "id": "345678", "includeAllFields": false }, "rightDataset": { "id": "000008", "includeAllFields": false }, "joinFields": [ { "leftField": "ANDIM", "rightField": "CC" } ] } ], "updateInfo": { "user": "USERT", "date": "2026-01-19T13:55:08.861+0000", "origin": "INPUT_WEB" }, "descriptions": { "it": "Dataset Virtuale Modificato", "en": "Modified Virtual Dataset", "ja": null, "aa": null, "zh": null } }

创建一个虚拟数据集、编辑另一个虚拟数据集并删除另一个虚拟数据集


方法	POST
URL	/api/aih/datamodel/v1/{dbID}/workspaces/{awID}/virtualdatasets-bulk
请求体	{ "saveMode": "LOOSE", "post": [ { "id": "POSTBU", "oid": "UYH6HH199HHG1234", "descriptions": { "en": "Post Bulk", "it": "Bulk Post" }, "sort": [], "relationships": [ { "order": 0, "leftDataset": { "id": "345678", "includeAllFields": false }, "rightDataset": { "id": "000008", "includeAllFields": false }, "joinFields": [ { "leftField": "ANDIM", "rightField": "CC" }, { "leftField": "DIMSW", "rightField": "CC" } ] }, { "order": 2, "leftDataset": { "id": "345678", "includeAllFields": false }, "rightDataset": { "id": "000006", "includeAllFields": false }, "joinFields": [ { "leftField": "ANDIM", "rightField": "ENT" }, { "leftField": "DIMSW", "rightField": "ENT" } ] } ] } ], "patch": [ { "key": { "id": "PATCHB" }, "data": { "descriptions": { "en": "Patch Bulk", "it": "Bulk Patch" }, "sort": [ { "field": "NUMB", "sortPosition": "20", "sortType": "ASC" }, { "field": "ENT", "sortPosition": "10", "sortType": "ASC" } ], "relationships": [ { "order": 0, "leftDataset": { "id": "345678", "includeAllFields": false }, "rightDataset": { "id": "000008", "includeAllFields": false }, "joinFields": [ { "leftField": "ANDIM", "rightField": "CC" }, { "leftField": "DIMSW", "rightField": "CC" } ] }, { "order": 2, "leftDataset": { "id": "345678", "includeAllFields": false }, "rightDataset": { "id": "000006", "includeAllFields": false }, "joinFields": [ { "leftField": "ANDIM", "rightField": "ENT" }, { "leftField": "DIMSW", "rightField": "ENT" } ] } ] } } ], "delete": [ { "id": "DELETB" } ] }
响应示例	`{ "code": "SUCCESS" }`