AppElementInfoAPI

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

copy_element(copyElementDto, copyBusinessDataTag=None)

复制文件夹或元素

对目标文件夹无写入权限，无法复制；复制操作默认跳过无权限元素(含同名合 并)；合并文件夹下存在同名元素，根据用户选择的替换列表更新元素，不替换 _copy新增平台复制完成后根据组件登记时的后置通知配置信息，通知组件 处理后续业务；注：带业务数据标识的元素直接调用对应组件服务依赖组件复制

参数

• copyElementDto – CopyElementDto

• copyBusinessDataTag – Optional[bool]

返回类型

Union[int, Awaitable[int]]

copy_folders_elements(copyElementDtoList, copyBusinessDataTag=None)

批量复制文件夹和元素

对目标文件夹无写入权限，无法复制；复制操作默认跳过无权限元素(含同名合 并)；合并文件夹下存在同名元素，根据用户选择的替换列表更新元素，不替换 _copy新增平台复制完成后根据组件登记时的后置通知配置信息，通知组件 处理后续业务；批量复制发生异常时复制操作将停止，该异常前已复制成功的文 件夹/元素不受影响注：带业务数据标识的元素直接调用对应组件服务依赖组件 复制

参数

• copyElementDtoList – List[CopyElementDto]

• copyBusinessDataTag – Optional[bool]

返回类型

Union[int, Awaitable[int]]

get_all_element(elementType=None)

查询所有元素基础信息

参数

elementType – Optional[str]

返回类型

Union[List[ElementInfoPO], Awaitable[List[ElementInfoPO]]]

get_element_folder_by_folder_list(folderList)

根据文件夹id查询所有子集数据接口

查询某文件夹下所有文件夹及元素信息，返回树形结构

参数

folderList – List[FolderInfo]

返回类型

Union[List[ElementFolderTree], Awaitable[List[ElementFolderTree]]]

get_element_folder_by_folder_list_relation(folderInfoAddRelation)

根据文件夹id，元素id查询所有子集数据及关联元素接口

查询某文件夹下所有文件夹及元素信息以及关联元素，返回树形结构

参数

folderInfoAddRelation – FolderInfoAddRelation

返回类型

Union[List[ElementFolderTree], Awaitable[List[ElementFolderTree]]]

get_server_names(queryElementInfoByTypeDtoList)

批量获取组件服务名

根据元素名称，类型，路径/文件夹等条件查询元素对应组件id，再调用 space服务根据组件id查询组件详细信息（批量）接口(含服务名)

参数

queryElementInfoByTypeDtoList – List[QueryElementInfoByTypeDto]

返回类型

Union[List[ModuleServerNameVO], Awaitable[List[ModuleServerNameVO]]]

get_server_names_v2(queryModuleServerNameDtoList)

批量获取组件服务名带错误信息

根据元素名称，类型，路径/文件夹等条件查询元素对应组件id，再调用 space服务根据组件id查询组件详细信息（批量）接口(含服务名)

参数

queryModuleServerNameDtoList – List[QueryModuleServerNameDto]

返回类型

Union[List[ModuleServerNamesVO], Awaitable[List[ModuleServerNamesVO]]]

list(folderId=None, moduleIdList=None, path=None)

查询指定目录下元素列表接口

查询某文件夹下所有文件夹及元素，其中元素描述多语言信息 elementNameDes通过元素id和language从 app_element_name_des表取

参数

• folderId – Optional[str]

• moduleIdList – Optional[List[str]]

• path – Optional[str]

返回类型

Union[List[FolderListVO], Awaitable[List[FolderListVO]]]

list_all()

查询所有元素列表信息

查询当前app下所有文件夹及元素列表，其中元素描述多语言信息 elementNameDes通过元素id和language从 app_element_name_des表取

返回类型

Union[List[FolderListVO], Awaitable[List[FolderListVO]]]

modify_element_name(modifyElementNameDto)

修改元素名称

修改元素名称,存在关联元素时也需修改关联元素名称

参数

modifyElementNameDto – ModifyElementNameDto

返回类型

Union[int, Awaitable[int]]

move_element(moveElementDto)

移动文件夹或元素

对目标文件夹无写入权限，无法移动；移动操作默认跳过无权限元素(含同名合 并)；合并文件夹下存在同名元素，根据用户选择的替换列表更新元素

参数

moveElementDto – MoveElementDto

返回类型

Union[int, Awaitable[int]]

move_folders_elements(moveElementDtoList)

批量移动文件夹和元素

对目标文件夹无写入权限，无法移动；移动操作默认跳过无权限元素(含同名合 并)；合并文件夹下存在同名元素，根据用户选择的替换列表更新元素

参数

moveElementDtoList – List[MoveElementDto]

返回类型

Union[int, Awaitable[int]]

register_usable(elementRegisterUsableQueryDtoList)

查询元素是否可用

根据元素名称、类型、文件夹id拿到元素对应组件id，再根据组件id分别 调用space获取其可用状态、system服务获取服务基本信息

参数

elementRegisterUsableQueryDtoList – List[ElementRegisterUsableQueryDto]

返回类型

Union[List[ElementRegisterStatusInfoVo], Awaitable[List[ElementRegisterStatusInfoVo]]]