物料中心

区块详情

基本信息

Path： /material-center/api/block/detail

Method： GET

接口描述：

区块的 unique_key 为 label + framework + tenant组合
通过同时传递三个键值即可查询到唯一区块
tenant 通过前端配置统一 x-lowcode-org 请求头传递，接口中不用填写

请求参数

Query

参数名称	是否必须	示例	备注
id	是	981	区块id
label	否	CrmSiteManage	区块名称
framework	否	Vue	区块技术栈

返回数据

名称	类型	是否必须	默认值	备注	其他信息
data	object	非必须
├─ id	number	非必须		区块id
├─ label	string	非必须		区块编码
├─ framework	string	非必须		前端框架
├─ content	object	非必须		区块内容
├─ componentName	string	非必须		组件名称
├─ fileName	string	非必须		页面名称
├─ css	string	非必须		全局 css 样式
├─ schema	object	非必须		数据结构
├─ properties	object []	非必须		属性	item 类型: object
├─ label	object	非必须
├─ zh_CN	string	非必须
├─ description	object	非必须
├─ zh_CN	string	非必须
├─ collapse	object	非必须
├─ number	number	非必须
├─ text	object	非必须
├─ zh_CN	string	非必须
├─ content	object []	非必须			item 类型: object
├─ property	string	必须
├─ type	string	必须
├─ defaultValue	object []	必须			item 类型: object
├─ field_id	string	必须
├─ field_value	string	必须
├─ field_type	string	必须
├─ percent	number	必须
├─ selected	boolean	必须
├─ label	object	必须
├─ text	object	非必须
├─ zh_CN	string	非必须
├─ description	object	必须
├─ zh_CN	string	非必须
├─ widget	object	必须
├─ component	string	非必须
├─ props	object	非必须
├─ handle	object	必须
├─ events	object	非必须		事件
├─ update	object	非必须
├─ label	object	非必须
├─ zh_CN	string	非必须
├─ description	object	非必须
├─ zh_CN	string	非必须
├─ methods	object	非必须		声明方法
├─ percentChange	object	非必须
├─ type	string	非必须
├─ value	string	非必须
├─ closeDialog	object	非必须
├─ type	string	非必须
├─ value	string	非必须
├─ confirm	object	非必须
├─ type	string	非必须
├─ value	string	非必须
├─ children	object []	非必须		子组件列表或字符串	item 类型: object
├─ componentName	string	非必须		组件名称
├─ props	object	非必须		属性
├─ className	string	非必须
├─ visible	object	非必须
├─ type	string	非必须
├─ value	string	非必须
├─ model	object	非必须
├─ prop	string	非必须
├─ title	object	非必须
├─ type	string	非必须
├─ key	string	非必须
├─ width	string	非必须
├─ onClosed	object	非必须
├─ type	string	非必须
├─ value	string	非必须
├─ children	object []	非必须		子组件列表或字符串	item 类型: object
├─ componentName	string	必须		组件名称
├─ props	object	必须		属性
├─ label-position	string	非必须
├─ label-width	string	非必须
├─ slot	string	非必须
├─ children	object []	必须		子组件列表或字符串	item 类型: object
├─ componentName	string	必须
├─ props	object	必须
├─ label	object,string	非必须
├─ key	object	非必须
├─ type	string	非必须
├─ value	string	非必须
├─ text	object	非必须
├─ type	string	非必须
├─ key	string	非必须
├─ type	object	非必须
├─ type	string	非必须
├─ value	string	非必须
├─ onClick	object	非必须
├─ type	string	非必须
├─ value	string	非必须
├─ children	object []	必须			item 类型: object
├─ componentName	string	必须
├─ props	object	必须
├─ className	string	非必须
├─ label	object	非必须
├─ type	string	非必须
├─ value	string	非必须
├─ children	object	必须
├─ type	string	非必须
├─ value	string	非必须
├─ id	string	必须
├─ condition	object	非必须
├─ type	string	非必须
├─ value	string	非必须
├─ id	string	必须
├─ loop	object	非必须
├─ type	string	非必须
├─ value	string	非必须
├─ loopArgs	string []	非必须			item 类型: string
├─		非必须
├─ id	string	非必须
├─ id	string	非必须
├─ configure	object	非必须		配置
├─ state	object	非必须
├─ total	number	非必须
├─ dialogVisible	object	非必须
├─ type	string	非必须
├─ value	string	非必须
├─ buttonType	string	非必须
├─ cloudData	object	非必须
├─ type	string	非必须
├─ value	string	非必须
├─ lifeCycles	object	非必须		生命周期
├─ setup	object	非必须
├─ type	string	非必须
├─ value	string	非必须
├─ onMounted	object	非必须
├─ type	string	非必须
├─ value	string	非必须
├─ type	string	非必须		类型
├─ component	string	非必须		组件
├─ label	string	非必须		标签
├─ published_at	string	非必须
├─ created_at	string	非必须		创建时间
├─ updated_at	string	非必须
├─ platform	null	非必须		关联设计器
├─ assets	null	非必须		构建资源
├─ last_build_info	null	非必须		最新一次构建信息
├─ tenant	number	非必须		所属组织
├─ description	null	非必须		描述
├─ tags	null	非必须		标签
├─ author	null	非必须		预留字段
├─ current_history	null	非必须		当前历史记录id
├─ screenshot	string	非必须		截图
├─ path	string	非必须		区块路径
├─ occupier	null	非必须		当前锁定人id

创建区块

基本信息

Path： /material-center/api/block/create

Method： POST

接口描述：

区块封面图为当前区块展示在画布中的外观，为 base64图片， 需要服务端解析上传到obs

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
path	string	非必须		区块路径
name_cn	string	非必须		区块名称
label	string	非必须		区块标签名(区块编码)
categories	number []	非必须		区块所属分类	item 类型: number
├─		非必须		分类id
public	number	非必须		是否公开, 私有: 0, 公开: 1, 半公开: 2	枚举: 0,1,2
framework	string	非必须		技术栈	枚举: Vue,Angular
content	object	非必须		区块内容
├─ state	object	非必须
├─ methods	object	非必须
├─ componentName	string	非必须
├─ fileName	string	非必须
├─ css	string	非必须
├─ props	object	非必须
├─ children	object []	非必须			item 类型: object
├─ componentName	string	必须
├─ props	object	必须
├─ text	string	非必须
├─ id	string	必须
├─ schema	object	非必须
├─ properties	object []	非必须			item 类型: object
├─ label	object	非必须
├─ zh_CN	string	非必须
├─ description	object	非必须
├─ zh_CN	string	非必须
├─ collapse	object	非必须
├─ number	number	非必须
├─ text	object	非必须
├─ zh_CN	string	非必须
├─ content	string []	非必须			item 类型: string
├─		非必须
├─ events	object	非必须
├─ slots	object	非必须
├─ dataSource	object	非必须
occupier	object	非必须		正在编辑区块的用户信息
├─ id	number	非必须
├─ username	string	非必须
├─ email	string	非必须
├─ provider	null	非必须
├─ password	null	非必须
├─ confirmationToken	string	非必须
├─ confirmed	boolean	非必须
├─ blocked	null	非必须
├─ role	null	非必须
├─ created_by	null	非必须
├─ updated_by	null	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ block	null	非必须
├─ is_admin	boolean	非必须
├─ is_public	null	非必须
├─ tenant	object	非必须
├─ id	string	非必须
├─ auths	object []	非必须			item 类型: object
├─ id	number	必须
├─ unit	object	必须
├─ type	string	非必须
├─ id	number	非必须
├─ name	string	非必须
├─ auth_type	number	必须
├─ expired_time	null	必须
├─ role	object	必须
├─ name	string	非必须
├─ id	number	非必须
├─ description	string	非必须
├─ tenants	object []	非必须			item 类型: object
├─ id	number	必须
├─ tenant_id	string	必须
├─ name_cn	string,null	必须
├─ name_en	string,null	必须
├─ description	string,null	必须
├─ created_by	null	必须
├─ updated_by	null,number	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ createdBy	null,number	必须
├─ updatedBy	number,null	必须
├─ w3	object	非必须
├─ cn	string	非必须
├─ displayName	string	非必须
├─ email	string	非必须
├─ employeeNumber	string	非必须
├─ employeeType	string	非必须
├─ givenName	string	非必须
├─ sn	string	非必须
├─ telephoneNumber	string	非必须
├─ uid	string	非必须
├─ uuid	string	非必须
screenshot	string	非必须		区块封面图
created_app	number	非必须		从哪个应用被创建的应用id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
data	object	非必须
├─ id	number	非必须		区块id
├─ label	string	非必须		区块编码
├─ framework	string	非必须		区块技术栈
├─ content	object	非必须		区块内容
├─ state	object	非必须
├─ methods	object	非必须		声明方法
├─ componentName	string	非必须		组件名称
├─ fileName	string	非必须		文件名称
├─ css	string	非必须		全局css样式
├─ props	object	非必须		属性
├─ children	object []	非必须		子组件列表或字符串	item 类型: object
├─ componentName	string	必须		组件名称
├─ props	object	必须		属性
├─ text	string	非必须
├─ id	string	必须
├─ schema	object	非必须		数据结构
├─ properties	object []	非必须		属性	item 类型: object
├─ label	object	非必须		标签
├─ zh_CN	string	非必须
├─ description	object	非必须		描述
├─ zh_CN	string	非必须
├─ collapse	object	非必须
├─ number	number	非必须
├─ text	object	非必须
├─ zh_CN	string	非必须
├─ content	string []	非必须		内容	item 类型: string
├─		非必须
├─ events	object	非必须		事件
├─ slots	object	非必须		定义插槽时使用，如： 默认页头
├─ dataSource	object	非必须		数据源
├─ created_at	string	非必须		创建时间
├─ updated_at	string	非必须		更新时间
├─ assets	null	非必须		区块发布后的资源信息
├─ createdBy	object	非必须		区块创建者
├─ id	number	非必须
├─ username	string	非必须		用户名
├─ email	string	非必须		邮箱
├─ blocked	null	非必须		是否被拉黑
├─ created_at	string	非必须		创建时间
├─ updated_at	string	非必须		更新时间
├─ block	null	非必须		预留字段
├─ is_admin	boolean	非必须		是否是超级管理员
├─ is_public	null	非必须		是否是公共账号
├─ last_build_info	null	非必须		区块最后一次发布信息
├─ description	null	非必须		区块描述
├─ tags	null	非必须		区块标签
├─ current_history	null	非必须		区块最后一次发布的数据信息
├─ screenshot	string	非必须		区块封面图
├─ path	string	非必须		区块路径
├─ occupier	object	非必须		正在编辑区块的用户
├─ id	number	非必须
├─ username	string	非必须		用户名
├─ email	string	非必须		邮箱
├─ blocked	null	非必须		是否被拉黑
├─ created_at	string	非必须		创建时间
├─ updated_at	string	非必须		更新时间
├─ block	null	非必须		预留字段
├─ is_admin	boolean	非必须		是否是超级管理员
├─ is_public	null	非必须		是否是公共账号
├─ isOfficial	boolean	非必须		是否为官方区块
├─ public	number	非必须		是否公开, 私有: 0, 公开: 1, 半公开: 2
├─ isDefault	boolean	非必须		是否为默认区块
├─ tiny_reserved	boolean	非必须		是否为tiny团队内置区块
├─ author	null	非必须		区块作者 - 预留字段
├─ name_cn	string	非必须		区块名称
├─ npm_name	null	非必须		区块发布的二方包名称
├─ created_app	null	非必须		区块被哪个应用创建 - 预留字段
├─ histories	string []	非必须		区块发布版本记录列表	item 类型: string
├─		非必须
├─ groups	string []	非必须		区块从属分组列表	item 类型: string
├─		非必须
├─ categories	object []	非必须		区块从属分类列表	item 类型: object
├─ id	number	非必须
├─ name	string	非必须		分类名称
├─ app	number	非必须		关联app
├─ desc	null	非必须		分类描述
├─ createdBy	number	非必须		创建人
├─ updatedBy	number	非必须		更新人
├─ created_at	string	非必须		创建时间
├─ updated_at	string	非必须		更新时间
├─ categoryId	string	非必须
├─ category_id	string	非必须		区块分类唯一id,业务用
├─ i18n_langs	string []	非必须		区块关联的国际化语言	item 类型: string
├─		非必须
├─ public_scope_tenants	string []	非必须		半公开区块 开放给的租户	item 类型: string
├─		非必须
locale	string	非必须

更新区块

基本信息

Path： /material-center/api/block/update/:id

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
id	12	区块id

Query

参数名称	是否必须	示例	备注
appId	是	当前appId

Body

名称	类型	是否必须	默认值	备注	其他信息
appId	string	非必须		在哪个应用创建 应用id
content	object	非必须		区块内容
├─ state	object	非必须
├─ methods	object	非必须
├─ componentName	string	非必须
├─ fileName	string	非必须
├─ css	string	非必须
├─ props	object	非必须
├─ children	object []	非必须			item 类型: object
├─ componentName	string	必须
├─ props	object	必须
├─ text	string	非必须
├─ id	string	必须
├─ children	object []	非必须			item 类型: object
├─ componentName	string	非必须
├─ props	object	非必须
├─ placeholder	string	非必须
├─ modelValue	string	非必须
├─ id	string	非必须
├─ schema	object	非必须
├─ properties	object []	非必须			item 类型: object
├─ label	object	非必须
├─ zh_CN	string	非必须
├─ description	object	非必须
├─ zh_CN	string	非必须
├─ collapse	object	非必须
├─ number	number	非必须
├─ text	object	非必须
├─ zh_CN	string	非必须
├─ content	string []	非必须			item 类型: string
├─		非必须
├─ events	object	非必须
├─ slots	object	非必须
├─ dataSource	object	非必须
screenshot	string	非必须		区块封面图
path	string	非必须		区块路径
label	string	非必须		区块标签值
public_scope_tenants	integer []	非必须		半公开时公开给哪些租户	item 类型: integer
├─		非必须		租户id
public	number	非必须		是否公开, 私有: 0, 公开: 1, 半公开: 2	枚举: 0,1,2
tags	string []	非必须		区块标签	item 类型: string
├─		非必须
categories	integer []	非必须		区块从属区块分类	item 类型: integer
├─		非必须		区块分类id
description	null	非必须		区块描述

返回数据

名称	类型	是否必须	默认值	备注	其他信息
data	object	非必须		区块详情数据
├─ id	number	非必须		区块id
├─ label	string	非必须		区块编码
├─ framework	string	非必须		前端框架
├─ content	object	非必须		区块内容
├─ state	object	非必须
├─ methods	object	非必须		声明的方法
├─ componentName	string	非必须		组件名称
├─ fileName	string	非必须		文件名
├─ css	string	非必须		全局css样式
├─ props	object	非必须		组件的属性
├─ children	object []	非必须		假如为容器组件时，可以有子组件，该字段描述子组件的信息	item 类型: object
├─ componentName	string	必须		组件名称
├─ props	object	必须		属性
├─ text	string	非必须
├─ id	string	必须
├─ children	object []	非必须		假如为容器组件时，可以有子组件，该字段描述子组件的信息	item 类型: object
├─ componentName	string	非必须		组件名称
├─ props	object	非必须		属性
├─ placeholder	string	非必须
├─ modelValue	string	非必须
├─ id	string	非必须
├─ schema	object	非必须		数据结构
├─ properties	object []	非必须		属性	item 类型: object
├─ label	object	非必须		标签
├─ zh_CN	string	非必须
├─ description	object	非必须		描述
├─ zh_CN	string	非必须
├─ collapse	object	非必须
├─ number	number	非必须
├─ text	object	非必须
├─ zh_CN	string	非必须
├─ content	string []	非必须		内容	item 类型: string
├─		非必须
├─ events	object	非必须		事件
├─ slots	object	非必须		定义插槽时使用，如： 默认页头
├─ dataSource	object	非必须		数据源
├─ created_at	string	非必须		创建时间
├─ updated_at	string	非必须		更新时间
├─ assets	object	非必须		构建资源
├─ material	string []	非必须		物料	item 类型: string
├─		非必须
├─ scripts	string []	非必须		脚本	item 类型: string
├─		非必须
├─ styles	string []	非必须		样式	item 类型: string
├─		非必须
├─ createdBy	object	非必须		创建人
├─ id	number	非必须
├─ username	string	非必须		用户名
├─ email	string	非必须		邮箱
├─ blocked	null	非必须		是否被拉黑
├─ created_at	string	非必须		创建时间
├─ updated_at	string	非必须		更新时间
├─ block	null	非必须		预留字段
├─ is_admin	boolean	非必须		是否是超级管理员
├─ is_public	null	非必须		是否是公共账号
├─ last_build_info	object	非必须		最新一次构建信息
├─ result	boolean	非必须
├─ endTime	string	非必须
├─ description	null	非必须		描述
├─ tags	string []	非必须		标签	item 类型: string
├─		非必须
├─ current_history	object	非必须		当前历史记录id
├─ id	number	非必须
├─ message	string	非必须
├─ content	object	非必须
├─ state	object	非必须
├─ methods	object	非必须
├─ componentName	string	非必须
├─ fileName	string	非必须
├─ css	string	非必须
├─ props	object	非必须
├─ children	object []	非必须			item 类型: object
├─ componentName	string	必须
├─ props	object	必须
├─ text	string	非必须
├─ id	string	必须
├─ children	object []	非必须			item 类型: object
├─ componentName	string	非必须
├─ props	object	非必须
├─ placeholder	string	非必须
├─ modelValue	string	非必须
├─ id	string	非必须
├─ schema	object	非必须
├─ properties	object []	非必须			item 类型: object
├─ label	object	非必须
├─ zh_CN	string	非必须
├─ description	object	非必须
├─ zh_CN	string	非必须
├─ collapse	object	非必须
├─ number	number	非必须
├─ text	object	非必须
├─ zh_CN	string	非必须
├─ content	string []	非必须			item 类型: string
├─		非必须
├─ events	object	非必须
├─ slots	object	非必须
├─ dataSource	object	非必须
├─ assets	object	非必须
├─ material	string []	非必须			item 类型: string
├─		非必须
├─ scripts	string []	非必须			item 类型: string
├─		非必须
├─ styles	string []	非必须			item 类型: string
├─		非必须
├─ build_info	object	非必须
├─ result	boolean	非必须
├─ versions	string []	非必须			item 类型: string
├─		非必须
├─ endTime	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ screenshot	string	非必须
├─ path	string	非必须
├─ label	string	非必须
├─ description	null	非必须
├─ mode	null	非必须
├─ block_id	number	非必须
├─ version	string	非必须
├─ npm_name	string	非必须
├─ i18n	null	非必须
├─ created_app	null	非必须
├─ screenshot	string	非必须		截图
├─ path	string	非必须		区块路径
├─ occupier	object	非必须		当前锁定人id
├─ id	number	非必须
├─ username	string	非必须		用户名
├─ email	string	非必须		邮箱
├─ blocked	null	非必须		是否被拉黑
├─ created_at	string	非必须		创建时间
├─ updated_at	string	非必须		更新时间
├─ block	null	非必须
├─ is_admin	boolean	非必须		是否是超级管理员
├─ is_public	null	非必须		是否是公共账号
├─ isOfficial	boolean	非必须		是否是官方
├─ public	number	非必须		公开状态：0，1，2
├─ isDefault	boolean	非必须		是否是默认
├─ tiny_reserved	boolean	非必须		是否是tiny专有
├─ author	null	非必须		预留字段
├─ name_cn	null	非必须		区块名称
├─ npm_name	string	非必须		npm包名
├─ created_app	null	非必须		创建区块时所在appId
├─ histories	object []	非必须			item 类型: object
├─ id	number	必须
├─ message	string	必须
├─ content	object	必须
├─ state	object	非必须
├─ methods	object	非必须
├─ componentName	string	非必须
├─ fileName	string	非必须
├─ css	string	非必须
├─ props	object	非必须
├─ children	object []	非必须			item 类型: object
├─ componentName	string	必须
├─ props	object	必须
├─ placeholder	string	非必须
├─ modelValue	string	非必须
├─ type	string	非必须
├─ maxlength	string	非必须
├─ text	string	非必须
├─ id	string	必须
├─ children	object []	必须			item 类型: object
├─ componentName	string	必须
├─ props	object	必须
├─ text	string	非必须
├─ placeholder	string	非必须
├─ modelValue	string	非必须
├─ id	string	必须
├─ schema	object	非必须
├─ properties	object []	非必须			item 类型: object
├─ label	object	必须
├─ zh_CN	string	非必须
├─ description	object	必须
├─ zh_CN	string	非必须
├─ collapse	object	必须
├─ number	number	非必须
├─ text	object	非必须
├─ zh_CN	string	非必须
├─ content	string []	必须			item 类型: string
├─		非必须
├─ events	object	非必须
├─ slots	object	非必须
├─ dataSource	object	非必须
├─ assets	object	必须
├─ material	string []	非必须			item 类型: string
├─		非必须
├─ scripts	string []	非必须			item 类型: string
├─		非必须
├─ styles	string []	非必须			item 类型: string
├─		非必须
├─ build_info	object	必须
├─ result	boolean	非必须
├─ versions	string []	非必须			item 类型: string
├─		非必须
├─ endTime	string	非必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ screenshot	string	必须
├─ path	string	必须
├─ label	null,string	必须
├─ description	null	必须
├─ mode	null	必须
├─ block_id	number	必须
├─ version	null,string	必须
├─ npm_name	null,string	必须
├─ i18n	null	必须
├─ created_app	null	必须
├─ groups	object []	非必须		区块关联分组	item 类型: object
├─ id	number	必须
├─ name	string	必须
├─ app	number	必须
├─ desc	null	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ categories	object []	非必须		区块从属区块分类	item 类型: object
├─ id	number	非必须
├─ name	string	非必须		分类名称
├─ app	number	非必须		关联appid
├─ desc	null	非必须		描述
├─ createdBy	number	非必须		创建人
├─ updatedBy	number	非必须		更新人
├─ created_at	string	非必须		创建时间
├─ updated_at	string	非必须		更新时间
├─ categoryId	string	非必须
├─ category_id	string	非必须		区块分类唯一id
├─ i18n_langs	string []	非必须		国际化	item 类型: string
├─		非必须
├─ public_scope_tenants	string []	非必须		半公开时公开给哪些租户	item 类型: string
├─		非必须
locale	string	非必须

区块查询

基本信息

Path： /api/block

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
platform	否	1	平台id
label	否
id	否
groups	否		组块关联的分组

返回数据

名称	类型	是否必须	默认值	备注	其他信息
data	object []	非必须			item 类型: object
├─ id	number	非必须		区块id
├─ label	string	非必须		区块编码
├─ framework	string	非必须		前端技术栈
├─ content	object	非必须		区块内容
├─ state	object	非必须		状态
├─ methods	object	非必须		声明方法
├─ componentName	string	非必须		组件名称
├─ fileName	string	非必须		文件名称
├─ css	string	非必须		css样式
├─ props	object	非必须		属性
├─ children	object []	非必须		子组件列表或字符串	item 类型: object
├─ componentName	string	非必须		组件名称
├─ props	object	非必须		属性
├─ id	string	非必须
├─ children	object []	非必须		子组件列表或字符串	item 类型: object
├─ componentName	string	非必须
├─ props	object	非必须
├─ name	string	非必须
├─ params	object []	非必须			item 类型: object
├─ name	string	必须
├─ value	object,number	必须
├─ id	string	非必须
├─ children	object []	非必须			item 类型: object
├─ componentName	string	非必须
├─ props	object	非必须
├─ text	string	非必须
├─ id	string	非必须
├─ schema	object	非必须		数据结构
├─ properties	object []	非必须		属性	item 类型: object
├─ label	object	非必须
├─ zh_CN	string	非必须
├─ description	object	非必须
├─ zh_CN	string	非必须
├─ collapse	object	非必须
├─ number	number	非必须
├─ text	object	非必须
├─ zh_CN	string	非必须
├─ content	string []	非必须			item 类型: string
├─		非必须
├─ events	object	非必须		事件
├─ slots	object	非必须		插槽
├─ content	object	非必须
├─ label	object	非必须
├─ zh_CN	string	非必须
├─ params	string []	非必须			item 类型: string
├─		非必须
├─ dataSource	object	非必须		数据源
├─ created_by	null	非必须
├─ updated_by	null	非必须
├─ created_at	string	非必须		创建时间
├─ updated_at	string	非必须		更新时间
├─ assets	object	非必须		构建资源
├─ material	string []	非必须		物料	item 类型: string
├─		非必须
├─ scripts	string []	非必须		脚本	item 类型: string
├─		非必须
├─ styles	string []	非必须		样式	item 类型: string
├─		非必须
├─ createdBy	object	非必须		创建人信息
├─ id	number	非必须		用户id
├─ username	string	非必须		用户信息
├─ updatedBy	number	非必须		更新人信息
├─ last_build_info	object	非必须		最新一次构建信息
├─ result	boolean	非必须		结果
├─ versions	string []	非必须		版本	item 类型: string
├─		非必须
├─ endTime	string	非必须		时间
├─ description	null	非必须		描述
├─ tags	string []	非必须		标签	item 类型: string
├─		非必须
├─ current_history	number	非必须		当前历史记录id
├─ screenshot	string	非必须		截图
├─ path	string	非必须		路径
├─ occupier	object	非必须		区块锁定人信息
├─ id	number	非必须
├─ username	string	非必须
├─ isOfficial	boolean	非必须		是否是官方
├─ public	number	非必须		公开状态：0，1，2
├─ isDefault	boolean	非必须		是否是默认
├─ tiny_reserved	boolean	非必须		是否是tiny专有
├─ author	null	非必须		预留字段
├─ name_cn	string	非必须		区块名称
├─ npm_name	string	非必须		npm包名
├─ created_app	number	非必须		创建区块的应用id
├─ content_blocks	null	非必须		预留字段
├─ histories	object []	非必须		区块历史记录	item 类型: object
├─ id	number	非必须
├─ message	string	非必须
├─ content	object	非必须
├─ state	object	非必须
├─ methods	object	非必须
├─ componentName	string	非必须
├─ fileName	string	非必须
├─ css	string	非必须
├─ props	object	非必须
├─ children	object []	非必须			item 类型: object
├─ componentName	string	非必须
├─ props	object	非必须
├─ id	string	非必须
├─ children	object []	非必须			item 类型: object
├─ componentName	string	非必须
├─ props	object	非必须
├─ name	string	非必须
├─ params	object []	非必须			item 类型: object
├─ name	string	必须
├─ value	object,number	必须
├─ id	string	非必须
├─ children	object []	非必须			item 类型: object
├─ componentName	string	非必须
├─ props	object	非必须
├─ text	string	非必须
├─ id	string	非必须
├─ schema	object	非必须
├─ properties	object []	非必须			item 类型: object
├─ label	object	非必须
├─ zh_CN	string	非必须
├─ description	object	非必须
├─ zh_CN	string	非必须
├─ collapse	object	非必须
├─ number	number	非必须
├─ text	object	非必须
├─ zh_CN	string	非必须
├─ content	string []	非必须			item 类型: string
├─		非必须
├─ events	object	非必须
├─ slots	object	非必须
├─ content	object	非必须
├─ label	object	非必须
├─ zh_CN	string	非必须
├─ params	string []	非必须			item 类型: string
├─		非必须
├─ dataSource	object	非必须
├─ assets	object	非必须
├─ material	string []	非必须			item 类型: string
├─		非必须
├─ scripts	string []	非必须			item 类型: string
├─		非必须
├─ styles	string []	非必须			item 类型: string
├─		非必须
├─ build_info	object	非必须
├─ result	boolean	非必须
├─ versions	string []	非必须			item 类型: string
├─		非必须
├─ endTime	string	非必须
├─ created_by	null	非必须
├─ updated_by	null	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ screenshot	string	非必须
├─ path	string	非必须
├─ label	string	非必须
├─ description	null	非必须
├─ mode	null	非必须
├─ block_id	number	非必须
├─ version	string	非必须
├─ npm_name	string	非必须
├─ i18n	object	非必须
├─ zh_CN	object	非必须
├─ lowcode.9316fcff	string	非必须
├─ en_US	object	非必须
├─ lowcode.9316fcff	string	非必须
├─ created_app	number	非必须
├─ content_blocks	null	非必须
├─ categories	object []	非必须		分类	item 类型: object
├─ id	number	非必须
├─ name	string	非必须
├─ app	number	非必须
├─ desc	null	非必须
├─ createdBy	number	非必须
├─ updatedBy	number	非必须
├─ created_by	null	非必须
├─ updated_by	null	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ category_id	string	非必须
├─ public_scope_tenants	string []	非必须			item 类型: string
├─		非必须
├─ histories_length	number	非必须		历史记录数量
locale	string	非必须

区块综合筛选列表

基本信息

Path： /material-center/api/block/list

Method： GET

接口描述：

query参数：
除了 appId、public_scope_mode 为特殊的query参数外，其余参数和strapi 的查询参数、表数据字段一致， appId、public_scope_mode 不能用strapi的方式加筛选条件
筛选参数有哪些看文档   https://blog.csdn.net/weixin_40326107/article/details/105817870

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
appId	否	1	应用id 用于筛选某个应用下的区块
public_scope_mode	否	1	不传将只显示公开的区块，传入1， 可根据public进行公开性筛选，默认展示全部私有/公开区块

返回数据

名称	类型	是否必须	默认值	备注	其他信息
data	object []	非必须			item 类型: object
├─ id	number	非必须		区块id
├─ label	string	非必须		区块编码
├─ framework	string	非必须		前端框架
├─ content	object	非必须		区块内容
├─ blockName	string	非必须		区块名称
├─ id	string	非必须
├─ props	object	非必须		属性
├─ __style__	string	非必须
├─ lifeCycles	object	非必须		生命周期
├─ ngOnChanges	object	非必须
├─ type	string	非必须
├─ compiled	string	非必须
├─ source	string	非必须
├─ css	string	非必须		全局css样式
├─ i18n	object	非必须		国际化
├─ zh_CN	object	非必须
├─ i18n-kv6bz5m1	string	非必须
├─ i18n-kv6bz5m2	string	非必须
├─ i18n-kv6bz5m3	string	非必须
├─ en_US	object	非必须
├─ i18n-kv6bz5m1	string	非必须
├─ i18n-kv6bz5m2	string	非必须
├─ i18n-kv6bz5m3	string	非必须
├─ methods	object	非必须		声明的方法
├─ __initMethods__	object	非必须
├─ type	string	非必须
├─ source	string	非必须
├─ compiled	string	非必须
├─ children	object []	非必须		子组件列表或字符串	item 类型: object
├─ componentName	string	非必须
├─ id	string	非必须
├─ props	object	非必须
├─ __style__	string	非必须
├─ className	string	非必须
├─ children	object []	非必须			item 类型: object
├─ id	string	非必须
├─ componentName	string	非必须
├─ props	object	非必须
├─ type	string	非必须
├─ __style__	string	非必须
├─ className	string	非必须
├─ ngClass	object	非必须
├─ type	string	非必须
├─ variable	string	非必须
├─ click	object	非必须
├─ type	string	非必须
├─ value	string	非必须
├─ events	object []	非必须			item 类型: object
├─ name	string	非必须
├─ id	string	非必须
├─ params	object	非必须
├─ type	string	非必须
├─ args	string []	非必须			item 类型: string
├─		非必须
├─ value	string	非必须
├─ loop	object	非必须
├─ type	string	非必须
├─ variable	string	非必须
├─ loopArgs	string []	非必须			item 类型: string
├─		非必须
├─ schema	object	非必须		数据结构
├─ type	string	非必须
├─ properties	object	非必须
├─ FilterButtonsizk3	object	非必须
├─ type	string	非必须
├─ properties	object	非必须
├─ dataSource	object	非必须
├─ title	string	非必须
├─ type	string	非必须
├─ searchKey	object	非必须
├─ title	string	非必须
├─ type	string	非必须
├─ default	string	非必须
├─ onSelect	object	非必须
├─ title	string	非必须
├─ type	string	非必须
├─ default	string	非必须
├─ dataSource	object	非必须		数据源
├─ list	object []	非必须			item 类型: object
├─ name	string	必须
├─ protocal	string	必须
├─ initialData	object	必须
├─ variable	array,string	非必须
├─ type	string	非必须
├─ value	string	非必须
├─ actions	object	非必须
├─ module	object	非必须
├─ compiled	string	非必须
├─ source	string	非必须
├─ type	string	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	非必须
├─ title	string	非必须
├─ published_at	string	非必须
├─ created_at	string	非必须		创建时间
├─ updated_at	string	非必须		修改时间
├─ platform	null	非必须		区块关联设计器id
├─ assets	null	非必须		区块构建资源
├─ last_build_info	null	非必须		最新一次构建信息
├─ tenant	null	非必须		区块所属组织
├─ block_history	null	非必须		区块历史
├─ description	null	非必须		描述
├─ tags	null	非必须		标签
├─ block_histories	string []	非必须			item 类型: string
├─		非必须
├─ block_groups	string []	非必须		区块关联分组	item 类型: string
├─		非必须

基本信息

Path： /material-center/api/block/deploy

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
block	object	非必须		区块数据
├─ id	number	非必须
├─ label	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ last_build_info	object	非必须
├─ result	boolean	非必须
├─ versions	string []	非必须			item 类型: string
├─		非必须
├─ endTime	string	非必须
├─ screenshot	string	非必须
├─ occupier	null	非必须
├─ author	null	非必须
├─ name_cn	string	非必须
├─ is_published	boolean	非必须
├─ framework	string	非必须
├─ content	object	非必须
├─ state	object	非必须
├─ methods	object	非必须
├─ componentName	string	非必须
├─ fileName	string	非必须
├─ css	string	非必须
├─ props	object	非必须
├─ children	object []	非必须			item 类型: object
├─ componentName	string	必须
├─ props	object	必须
├─ id	string	必须
├─ children	object []	必须			item 类型: object
├─ componentName	string	必须
├─ props	object	必须
├─ text	string	非必须
├─ id	string	必须
├─ schema	object	非必须
├─ properties	object []	非必须			item 类型: object
├─ label	object	非必须
├─ zh_CN	string	非必须
├─ description	object	非必须
├─ zh_CN	string	非必须
├─ collapse	object	非必须
├─ number	number	非必须
├─ text	object	非必须
├─ zh_CN	string	非必须
├─ content	string []	非必须			item 类型: string
├─		非必须
├─ events	object	非必须
├─ slots	object	非必须
├─ dataSource	object	非必须
├─ assets	object	非必须
├─ material	string []	非必须			item 类型: string
├─		非必须
├─ scripts	string []	非必须			item 类型: string
├─		非必须
├─ styles	string []	非必须			item 类型: string
├─		非必须
├─ createdBy	object	非必须
├─ id	number	非必须
├─ username	string	非必须
├─ email	string	非必须
├─ blocked	null	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ block	null	非必须
├─ is_admin	boolean	非必须
├─ is_public	null	非必须
├─ description	null	非必须
├─ tags	string []	非必须			item 类型: string
├─		非必须
├─ current_history	object	非必须
├─ id	number	非必须
├─ message	string	非必须
├─ content	object	非必须
├─ state	object	非必须
├─ methods	object	非必须
├─ componentName	string	非必须
├─ fileName	string	非必须
├─ css	string	非必须
├─ props	object	非必须
├─ children	object []	非必须			item 类型: object
├─ componentName	string	必须
├─ props	object	必须
├─ id	string	必须
├─ children	object []	必须			item 类型: object
├─ componentName	string	必须
├─ props	object	必须
├─ text	string	非必须
├─ id	string	必须
├─ schema	object	非必须
├─ properties	object []	非必须			item 类型: object
├─ label	object	非必须
├─ zh_CN	string	非必须
├─ description	object	非必须
├─ zh_CN	string	非必须
├─ collapse	object	非必须
├─ number	number	非必须
├─ text	object	非必须
├─ zh_CN	string	非必须
├─ content	string []	非必须			item 类型: string
├─		非必须
├─ events	object	非必须
├─ slots	object	非必须
├─ dataSource	object	非必须
├─ assets	object	非必须
├─ material	string []	非必须			item 类型: string
├─		非必须
├─ scripts	string []	非必须			item 类型: string
├─		非必须
├─ styles	string []	非必须			item 类型: string
├─		非必须
├─ build_info	object	非必须
├─ result	boolean	非必须
├─ versions	string []	非必须			item 类型: string
├─		非必须
├─ endTime	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ screenshot	string	非必须
├─ path	string	非必须
├─ label	string	非必须
├─ description	null	非必须
├─ mode	null	非必须
├─ block_id	number	非必须
├─ version	string	非必须
├─ npm_name	string	非必须
├─ i18n	object	非必须
├─ created_app	null	非必须
├─ path	string	非必须
├─ isOfficial	boolean	非必须
├─ public	number	非必须
├─ isDefault	boolean	非必须
├─ tiny_reserved	boolean	非必须
├─ npm_name	string	非必须
├─ created_app	null	非必须
├─ histories	object []	非必须			item 类型: object
├─ id	number	必须
├─ message	string	必须
├─ content	object	必须
├─ state	object	非必须
├─ methods	object	非必须
├─ componentName	string	非必须
├─ fileName	string	非必须
├─ css	string	非必须
├─ props	object	非必须
├─ children	object []	非必须			item 类型: object
├─ componentName	string	必须
├─ props	object	必须
├─ id	string	必须
├─ children	object []	必须			item 类型: object
├─ componentName	string	必须
├─ props	object	必须
├─ text	string	非必须
├─ id	string	必须
├─ schema	object	非必须
├─ properties	object []	非必须			item 类型: object
├─ label	object	必须
├─ zh_CN	string	非必须
├─ description	object	必须
├─ zh_CN	string	非必须
├─ collapse	object	必须
├─ number	number	非必须
├─ text	object	非必须
├─ zh_CN	string	非必须
├─ content	string []	必须			item 类型: string
├─		非必须
├─ events	object	非必须
├─ slots	object	非必须
├─ dataSource	object	非必须
├─ assets	object	必须
├─ material	string []	非必须			item 类型: string
├─		非必须
├─ scripts	string []	非必须			item 类型: string
├─		非必须
├─ styles	string []	非必须			item 类型: string
├─		非必须
├─ build_info	object	必须
├─ result	boolean	非必须
├─ versions	string []	非必须			item 类型: string
├─		非必须
├─ endTime	string	非必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ screenshot	string	必须
├─ path	string	必须
├─ label	string	必须
├─ description	null	必须
├─ mode	null	必须
├─ block_id	number	必须
├─ version	string	必须
├─ npm_name	string	必须
├─ i18n	object	必须
├─ created_app	null	必须
├─ groups	string []	非必须			item 类型: string
├─		非必须
├─ categories	string []	非必须			item 类型: string
├─		非必须
├─ i18n_langs	string []	非必须			item 类型: string
├─		非必须
├─ public_scope_tenants	number []	非必须			item 类型: number
├─		非必须
├─ isAnimation	boolean	非必须
├─ isShowProgress	boolean	非必须
├─ publishProgress	number	非必须
├─ deployStatus	number	非必须
is_compile	boolean	非必须		是否为线上发布 网页版总是true
deploy_info	string	非必须		发布信息
version	string	非必须		发布版本号 x.y.z
needToSave	boolean	必须		发布成功后是否保存区块数据

返回数据

名称	类型	是否必须	默认值	备注	其他信息
data	object	非必须		构建任务通用数据
├─ id	number	非必须
├─ teamId	number	非必须		团队id
├─ taskTypeId	number	非必须		任务类型
├─ uniqueId	number	非必须		构建资源id
├─ taskName	null	非必须		构建任务名称
├─ taskStatus	number	非必须		任务状态：0 init ,1 running , 2 stopped ,3 finished
├─ taskResult	null	非必须		当前执行进度结果信息
├─ progress	null	非必须		当前进行的子任务名
├─ created_at	string	非必须		创建时间
├─ updated_at	string	非必须		更新时间
├─ ratio	null	非必须		预留字段
├─ progress_percent	number	非必须		构建进度百分比数
├─ indicator	null	非必须		构建指标
locale	string	非必须

删除区块

基本信息

Path： /material-center/api/block/delete/:id

Method： GET

接口描述：

区块只有自己创建的才能删除

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
id	12	区块id

Body

名称	类型	是否必须	默认值	备注	其他信息

返回数据

名称	类型	是否必须	默认值	备注	其他信息
data	object	非必须
├─ id	number	非必须		区块id
├─ label	string	非必须		区块代码
├─ framework	string	非必须		前端框架
├─ content	object	非必须		区块内容
├─ state	object	非必须
├─ methods	object	非必须		声明的方法
├─ componentName	string	非必须		组件名称
├─ fileName	string	非必须		文件名
├─ css	string	非必须		全局css样式
├─ props	object	非必须		属性
├─ children	object []	非必须		子组件列表或字符串	item 类型: object
├─ componentName	string	必须		组件名称
├─ props	object	必须		属性
├─ text	string	非必须
├─ id	string	必须
├─ schema	object	非必须		数据结构
├─ properties	object []	非必须		属性	item 类型: object
├─ label	object	非必须		标签
├─ zh_CN	string	非必须
├─ description	object	非必须		描述
├─ zh_CN	string	非必须
├─ collapse	object	非必须
├─ number	number	非必须
├─ text	object	非必须
├─ zh_CN	string	非必须
├─ content	string []	非必须		内容	item 类型: string
├─		非必须
├─ events	object	非必须		事件
├─ slots	object	非必须		插槽
├─ dataSource	object	非必须		数据源
├─ created_at	string	非必须		创建时间
├─ updated_at	string	非必须		更新时间
├─ assets	null	非必须		构建资源
├─ createdBy	object	非必须		创建人
├─ id	number	非必须
├─ username	string	非必须		用户名
├─ email	string	非必须		邮箱
├─ blocked	null	非必须		是否被拉黑
├─ created_at	string	非必须		创建时间
├─ updated_at	string	非必须		更新时间
├─ block	null	非必须
├─ is_admin	boolean	非必须		是否是超级管理员
├─ is_public	null	非必须		是否是公共账号
├─ last_build_info	null	非必须		最新一次构建信息
├─ description	null	非必须		描述
├─ tags	null	非必须		标签
├─ current_history	null	非必须		当前历史记录id
├─ screenshot	string	非必须		截图
├─ path	string	非必须		区块路径
├─ occupier	object	非必须		当前锁定人id
├─ id	number	非必须
├─ username	string	非必须		用户名
├─ email	string	非必须		邮箱
├─ blocked	null	非必须		是否被拉黑
├─ created_at	string	非必须		创建时间
├─ updated_at	string	非必须		更新时间
├─ block	null	非必须
├─ is_admin	boolean	非必须		是否是超级管理员
├─ is_public	null	非必须		是否是公共账号
├─ isOfficial	boolean	非必须		是否是官方
├─ public	number	非必须		公开状态：0，1，2
├─ isDefault	boolean	非必须		是否是默认
├─ tiny_reserved	boolean	非必须		是否是tiny专有
├─ author	null	非必须		预留字段
├─ name_cn	string	非必须		区块名称
├─ npm_name	null	非必须		npm包名
├─ created_app	null	非必须		创建区块所在app
├─ histories	string []	非必须			item 类型: string
├─		非必须
├─ groups	string []	非必须		区块关联分组	item 类型: string
├─		非必须
├─ categories	object []	非必须		区块关联分区	item 类型: object
├─ id	number	非必须
├─ name	string	非必须		区块名称
├─ app	number	非必须		关联app
├─ desc	null	非必须		描述
├─ createdBy	number	非必须		创建人
├─ updatedBy	number	非必须		更新人
├─ created_at	string	非必须		创建时间
├─ updated_at	string	非必须		更新时间
├─ categoryId	string	非必须		区块分区id
├─ category_id	string	非必须		区块分区唯一id
├─ i18n_langs	string []	非必须		国际化	item 类型: string
├─		非必须
├─ public_scope_tenants	string []	非必须			item 类型: string
├─		非必须
locale	string	非必须

物料同步接口

基本信息

Path： /material-center/api/component/bundle/create

Method： POST

接口描述：

处理物料同步上传bundle.json文件创建或更新组件

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	multipart/form-data	是

路径参数

参数名称	示例	备注
file	bundle.json	bundle.json文件

Body

名称	类型	是否必须	默认值	备注	其他信息

返回数据

名称	类型	是否必须	默认值	备注	其他信息
data	object	非必须
├─ insertNum	number	非必须		新增组件数
├─ updateNum	number	非必须		更新组件数