虚拟数据集字段管理 API

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


API 标题：	AIH Virtual Dataset Fields 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/{virtualdatasetID}/fields

操作	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], updateInfo.user, updateInfo.date 和 updateInfo.origin"

请求中支持的字段¶

虚拟数据集字段	支持的基数	支持的值
id	-	string（必填）
oid	-	string
descriptions.[lingua]	-	string（一个必填）
fieldType	-	FORMULA, DATASET_FIELD（必填）
formula	-	string（fieldType=formula 时必填）
sortType	-	ASC, DESC
sortPosition	-	integer
sourceField.id	-	string
sourceField.sourceDataset.id	-	string

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

响应中的附加字段¶


虚拟数据集字段	支持的值
values.dictionary.id	string
values.dictionary.queryCodeField	string
values.dictionary.queryDescriptionField	string
values.dictionary.outOfDictionaryAllowed	true/false
values.dictionary.displayMode	CODE, DESCRIPTION, CODE_AND_DESCRIPTION
updateInfo.user	string
updateInfo.date	date
updateInfo.origin	INPUT_WEB

请求示例¶

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


方法	GET
URL	/api/aih/datamodel/v1/{dbID}/workspaces/{awID}/virtualdatasets/{virtualdatasetID}/fields
请求体	-
响应示例	[ { "sortType": null, "sortPosition": null, "id": "ANDIM", "oid": "CGFJAHKFSYFTGLI", "descriptions": { "it": "Andim", "en": "Andim", "ja": null, "aa": null }, "fieldType": "DATASET_FIELD", "updateInfo": { "user": "USERT", "date": "2024-12-18T16:45:28.900+0000", "origin": "INPUT_WEB" }, "sourceField": { "id": "ANDIM", "sourceDataset": { "id": "345678" } }, "values": { "dictionary": { "id": null, "queryCodeField": null, "queryDescriptionField": null, "outOfDictionaryAllowed": false }, "displayMode": "CODE" } }, { "sortType": null, "sortPosition": null, "id": "DAT", "oid": "KFJBQSDVUYKEFKO", "descriptions": { "it": "FORMULA", "en": "FORMULA", "ja": null, "aa": null }, "fieldType": "FORMULA", "updateInfo": { "user": "USERT", "date": "2024-12-18T16:51:26.407+0000", "origin": "INPUT_WEB" }, "formula": ".", "timeDimensionRollup": "LAST", "conversionType": "PERIOD_AVERAGE" } ]

显示特定的虚拟数据集


方法	GET
URL	/api/aih/datamodel/v1/{dbID}/workspaces/{awID}/virtualdatasets/{virtualdatasetID}/fields/FIELD
请求体	-
响应示例	`{ "sortType": "ASC", "sortPosition": "20", "id": "FIELD", "oid": "NLOLREXNRMACLOK", "descriptions": { "it": "Internal Field", "en": "Campo Interno", "ja": "Campo Interno", "aa": "Campo Interno" }, "fieldType": "FORMULA", "updateInfo": { "user": "USERT", "date": "2025-10-28T16:11:32.762+0000", "origin": "INPUT_WEB" }, "formula": ".", "timeDimensionRollup": "LAST", "conversionType": "FINAL" }`

显示虚拟数据集的数量


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

创建新的虚拟数据集


方法	POST
URL	/api/aih/datamodel/v1/{dbID}/workspaces/{awID}/virtualdatasets/{virtualdatasetID}/fields
请求体	`{ "id": "FIEL", "oid": "DXKZFNPRJJABH01", "descriptions": { "it": "Campo", "en": "Field" }, "fieldType": "DATASET_FIELD", "sourceField": { "id": "FIEL", "sourceDataset": { "id": "345608" } } }`
响应示例	{ "sortType": null, "sortPosition": null, "id": "FIEL", "oid": "DXKZFNPRJJABH01", "descriptions": { "it": "Campo", "en": "Field", "ja": null, "aa": null }, "fieldType": "DATASET_FIELD", "updateInfo": { "user": "USERT", "date": "2026-01-19T14:58:21.539+0000", "origin": "INPUT_WEB" }, "sourceField": { "id": "FIEL", "sourceDataset": { "id": "345608" } }, "values": { "dictionary": { "id": null, "queryCodeField": null, "queryDescriptionField": null, "outOfDictionaryAllowed": false }, "displayMode": "CODE" } }

编辑虚拟数据集


方法	PATCH
URL	/api/aih/datamodel/v1/{dbID}/workspaces/{awID}/virtualdatasets/{virtualdatasetID}/fields/FIEL
请求体	`{ "id": "FIEL", "descriptions": { "it": "Campo Modificato", "en": "Edited Field" }, "fieldType": "DATASET_FIELD", "sourceField": { "id": "FIEL", "sourceDataset": { "id": "345608" } } }`
响应示例	{ "sortType": null, "sortPosition": null, "id": "FIEL", "oid": "DXKZFNPRJJABH01", "descriptions": { "it": "Campo", "en": "Field", "ja": null, "aa": null }, "fieldType": "DATASET_FIELD", "updateInfo": { "user": "USERT", "date": "2026-01-19T14:58:21.539+0000", "origin": "INPUT_WEB" }, "sourceField": { "id": "FIEL", "sourceDataset": { "id": "345608" } }, "values": { "dictionary": { "id": null, "queryCodeField": null, "queryDescriptionField": null, "outOfDictionaryAllowed": false }, "displayMode": "CODE" } }

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


方法	POST
URL	/api/aih/datamodel/v1/{dbID}/workspaces/{awID}/virtualdatasets/{virtualdatasetID}/fields-bulk
请求体	{ "saveMode": "LOOSE", "post": [ { "id": "POSTBU", "descriptions": { "en": "Post Bulk", "it": "Bulk Post" }, "fieldType": "DATASET_FIELD", "sourceField": { "id": "ENT", "sourceDataset": { "id": "345678" } } } ], "patch": [ { "key": { "id": "PATCHB" }, "data": { "descriptions": { "en": "Patch Bulk", "it": "Bulk Patch" }, "fieldType": "DATASET_FIELD", "sourceField": { "id": "READONLY", "sourceDataset": { "id": "345678" } } } } ], "delete": [ { "id": "DELETB" } ] }
响应示例	`{ "code": "SUCCESS" }`