AppElementsAPI

class deepfos.api.app.AppElementsAPI(root: deepfos.api.base.RootAPI)

check_element_exist(elementType, elementName, folderId=None, path=None)

根据元素名称/类型/路径（或文件夹id）校验该元素是否已经存在

若path绝对路径有传参数，则以路径为准，通过路径去 folder_info表拿folderId，再通过元素名称/类型/文件 夹id查询元素是否存在

参数

• elementType – str

• elementName – str

• folderId – Optional[str]

• path – Optional[str]

返回类型

Union[bool, Awaitable[bool]]

check_element_exist_by_list(checkElementExistDtoList)

根据元素名称/类型/路径（或文件夹id）批量校验该元素是否已经存在

若path绝对路径有传参数，则以路径为准，通过路径去 folder_info表拿folderId，再通过元素名称/类型 /folderId查询element_info元素是否存在

参数

checkElementExistDtoList – List[ElementExistsDto]

返回类型

Union[List[ElementExistsVo], Awaitable[List[ElementExistsVo]]]

check_element_exist_v2(elementType, elementName, folderId=None, path=None, toFolderId=None, toPath=None)

根据元素名称/类型/路径（或文件夹id）/相对路径(或相对文件夹id)校验该元素是否已经存在

若path绝对/相对路径有传参数，则以路径为准，根据路径去 folder_info表拿文件夹id，再通过元素名称/类型/文件夹 id查询元素是否存在

参数

• elementType – str

• elementName – str

• folderId – Optional[str]

• path – Optional[str]

• toFolderId – Optional[str]

• toPath – Optional[str]

返回类型

Union[ElementBaseInfoVO, Awaitable[ElementBaseInfoVO]]

confirm_element(confirmElementInfoDto)

元素实例创建确认

元素表保存了元素创建完成标识confirm，未创建完成的数据不显示，元 素实例创建完成可通过该接口更改为已确认

参数

confirmElementInfoDto – ConfirmElementInfoDto

返回类型

Union[int, Awaitable[int]]

create_element(createElementInfoDto)

元素实例创建

参数

createElementInfoDto – CreateElementInfoDto

返回类型

Union[ElementVO, Awaitable[ElementVO]]

del_element(removeElementInfoDtoList, confirm=None)

元素实例删除

参数

• removeElementInfoDtoList – List[RemoveElementInfoDto]

• confirm – Optional[bool]

返回类型

Union[int, Awaitable[int]]

get_element_info_base_by_id(elementInfoIdList)

根据元素id批量查询元素基本信息（入参最大100，超过100返回空）

参数

elementInfoIdList – List[str]

返回类型

Union[List[ElementInfoBaseVO], Awaitable[List[ElementInfoBaseVO]]]

get_element_info_by_id(elementInfoIdList)

根据元素id批量查询元素信息（入参最大100，超过100返回空）

参数

elementInfoIdList – List[str]

返回类型

Union[List[ElementInfoVO], Awaitable[List[ElementInfoVO]]]

get_element_info_by_name(elementName, elementType=None)

根据元素名称查询元素信息

参数

• elementName – str

• elementType – Optional[str]

返回类型

Union[List[ElementRelationInfo], Awaitable[List[ElementRelationInfo]]]

get_element_info_by_type(queryElementInfoByTypeDtoList)

元素信息查询

参数

queryElementInfoByTypeDtoList – List[QueryElementInfoByTypeDto]

返回类型

Union[List[ElementInfoVO], Awaitable[List[ElementInfoVO]]]

get_element_permission_by_type(queryElementPermissionByTypeDtoList)

元素权限查询

根据元素类型，名称，路径/文件夹id查询元素的权限

参数

queryElementPermissionByTypeDtoList – List[QueryElementPermissionByTypeDto]

返回类型

Union[List[ElementPermissionVO], Awaitable[List[ElementPermissionVO]]]

get_elements_by_protocol(queryElementInfoByProtocolDto, eqElementTypeChild=None, includeElementType=None)

根据组件使用的协议查询支持的元素实例接口

调用space服务获取使用该协议和版本的所有组件，再通过组件id获取元 素信息

参数

• queryElementInfoByProtocolDto – QueryElementInfoByProtocolDto

• eqElementTypeChild – Optional[List[str]]

• includeElementType – Optional[str]

返回类型

Union[List[ElementInfoForProtocolVO], Awaitable[List[ElementInfoForProtocolVO]]]

get_elements_by_protocol_list(queryElementInfoByProtocolDtoList, elementType=None, eqElementTypeChild=None)

根据组件使用的协议查询支持的元素实例(批量)接口

调用space服务获取使用该协议和版本的所有组件，再通过组件id获取元 素信息(批量)

参数

• queryElementInfoByProtocolDtoList – List[QueryElementInfoByProtocolDto]

• elementType – Optional[List[str]]

• eqElementTypeChild – Optional[List[str]]

返回类型

Union[List[ElementInfoForProtocolVO], Awaitable[List[ElementInfoForProtocolVO]]]

get_menu_list()

获取菜单列表接口

查询element-type为MEN的元素信息

返回类型

Union[List[ElementVO], Awaitable[List[ElementVO]]]

list_element_infos(elementType)

根据元素类型查询元素信息

参数

elementType – str

返回类型

Union[List[ElementInfoVO], Awaitable[List[ElementInfoVO]]]

save_element(createElementInfoDto)

元素实例保存

元素不存在创建元素，该元素所在文件夹不存在先创建文件夹再创建元素；否则 修改元素信息

参数

createElementInfoDto – CreateElementInfoDto

返回类型

Union[int, Awaitable[int]]

update_element(modifyElementInfoDto)

元素实例更新

参数

modifyElementInfoDto – ModifyElementInfoDto

返回类型

Union[int, Awaitable[int]]

update_element_warning(elementWarningDefend)

维护元素信息警告标识接口

根据path和folderId获取最终有效的folderId,根据 elementName、elementType、folderId更新 element_info表对应元素el_warning字段值

参数

elementWarningDefend – ElementWarningDefend

返回类型

Union[Any, Awaitable[Any]]