AppAPI

class deepfos.api.app.AppAPI(header=None, sync=True)

应用服务接口

element: AppElementAPI

元素升级信息操作接口

element_upgrade(elementUpgradeInfoDtoList)	元素升级接口
upgrade_info(type, name, folderId)	元素升级信息查询接口
upgrade_info_batch(list)	元素升级信息批量查询接口
upgrade_log_by_id(id)	根据升级记录主表id查询元素升级记录接口

element_info: AppElementInfoAPI

元素信息

copy_element(copyElementDto[, …])	复制文件夹或元素
copy_folders_elements(copyElementDtoList[, …])	批量复制文件夹和元素
get_all_element([elementType])	查询所有元素基础信息
get_element_folder_by_folder_list(folderList)	根据文件夹id查询所有子集数据接口
get_element_folder_by_folder_list_relation(…)	根据文件夹id，元素id查询所有子集数据及关联元素接口
get_server_names(queryElementInfoByTypeDtoList)	批量获取组件服务名
get_server_names_v2(queryModuleServerNameDtoList)	批量获取组件服务名带错误信息
list([folderId, moduleIdList, path])	查询指定目录下元素列表接口
list_all()	查询所有元素列表信息
modify_element_name(modifyElementNameDto)	修改元素名称
move_element(moveElementDto)	移动文件夹或元素
move_folders_elements(moveElementDtoList)	批量移动文件夹和元素
register_usable(…)	查询元素是否可用

element_relation: AppElementRelatioinAPI

元素引用关系

by_cite(elementType, elementName[, …])	获取某元素关联引用的元素列表接口
by_cited(elementType, elementName[, …])	获取某元素关联被引用的元素列表接口
referenced_element(elementInfoBaseDtoList)	获取某元素关联被引用的元素列表接口-批量

elements: AppElementsAPI

元素相关接口

check_element_exist(elementType, elementName)	根据元素名称/类型/路径（或文件夹id）校验该元素是否已经存在
check_element_exist_by_list(…)	根据元素名称/类型/路径（或文件夹id）批量校验该元素是否已经存在
check_element_exist_v2(elementType, elementName)	根据元素名称/类型/路径（或文件夹id）/相对路径(或相对文件夹id)校验该元素是否已经存在
confirm_element(confirmElementInfoDto)	元素实例创建确认
create_element(createElementInfoDto)	元素实例创建
del_element(removeElementInfoDtoList[, confirm])	元素实例删除
list_element_infos(elementType)	根据元素类型查询元素信息
get_element_info_base_by_id(elementInfoIdList)	根据元素id批量查询元素基本信息（入参最大100，超过100返回空）
get_element_info_by_id(elementInfoIdList)	根据元素id批量查询元素信息（入参最大100，超过100返回空）
get_element_info_by_name(elementName[, …])	根据元素名称查询元素信息
get_element_info_by_type(…)	元素信息查询
get_element_permission_by_type(…)	元素权限查询
get_elements_by_protocol(…[, …])	根据组件使用的协议查询支持的元素实例接口
get_elements_by_protocol_list(…[, …])	根据组件使用的协议查询支持的元素实例(批量)接口
get_menu_list()	获取菜单列表接口
save_element(createElementInfoDto)	元素实例保存
update_element(modifyElementInfoDto)	元素实例更新
update_element_warning(elementWarningDefend)	维护元素信息警告标识接口

folder: AppFolderAPI

文件夹操作接口

create_folder(createFolderInfoDto)	创建文件夹
del_folder([confirm, ids])	删除文件夹
del_folder_element(delFolderElementDtoList)	批量删除文件夹和元素
edit_folder(modifyFolderInfoDto)	编辑文件夹
get_folder_full(folderId)	查询文件夹全路径
get_folder_id_by_full_path(fullPath)	根据全路径查询文件夹id
get_folder_info(folderId)	查询文件夹明细
get_folders([folderId])	查询文件夹列表
update_open_extend(folderInfoUpdateOpenExtendDto)	文件夹启用/禁用继承开关接口

permission: PermissionAPI

权限接口

add_group([groupId, pGroupId])	新增用户组关联的权限数据
delete_group([groupId])	删除用户组关联的权限数据
edit([requsetDto])	权限编辑
get_enterprise_group()	查询元素或文件夹中有配置 所有用户/企业所有用户组权限对应的组id