15.1.5.1 元素 API

ElementResourceApi 提供对元素的查询、创建、更新和删除操作。

方法列表

Java 与 Python SDK 的方法名遵循各自语言的生成规则。调用时请使用对应语言列中的名称。

Java 方法	Python 方法	HTTP	说明
apiV1ElementsGet	api_v1_elements_get	GET /api/v1/elements	分页查询元素列表
apiV1ElementsElementIdGet	api_v1_elements_element_id_get	GET /api/v1/elements/{elementId}	根据 ID 获取单个元素
apiV1ElementsPost	api_v1_elements_post	POST /api/v1/elements	创建元素
apiV1ElementsElementIdPut	api_v1_elements_element_id_put	PUT /api/v1/elements/{elementId}	更新元素
apiV1ElementsElementIdDelete	api_v1_elements_element_id_delete	DELETE /api/v1/elements/{elementId}	删除元素

---

apiV1ElementsGet——查询元素列表

返回当前用户可访问的元素分页列表，支持按名称或父元素可选过滤。

参数

名称	类型	必填	默认值	说明
current	integer	否	1	页码，从 1 开始
size	integer	否	20	每页记录数
parentId	integer	否	—	按父元素 ID 过滤
keyword	string	否	—	按关键字过滤

返回： PageOfBasicElementDTO

示例

Java

ElementResourceApi elementApi = apiClient.buildClient(ElementResourceApi.class);
ApiV1ElementsGetQueryParams params = new ApiV1ElementsGetQueryParams()
    .current(1)
    .size(50);
PageOfBasicElementDTO result = elementApi.apiV1ElementsGet(params);
System.out.println("Total elements: " + result.getTotal());

Python

element_api = idmp_sdk.ElementResourceApi(api_client)
result = element_api.api_v1_elements_get(current=1, size=50)
print(f"Total elements: {result.total}")
for elem in result.rows or []:
    print(f"  {elem.id}: {elem.name}")

---

获取单个元素

参数

名称	类型	必填	说明
elementId	integer	是	元素 ID

返回： ElementDTO

抛出： ApiException(404)——元素未找到

示例

Java

ElementDTO element = elementApi.apiV1ElementsElementIdGet(123L);
System.out.println(element.getName());

Python

element = element_api.api_v1_elements_element_id_get(123)
print(element.name)

---

备注

创建、更新和删除方法的完整参数参考请查看 OpenAPI 规范文件，或在您的 IDMP 服务器上访问 /swagger-ui.html 浏览 Swagger UI。