REST API
鉴权流程
获取 AccessToken
基本信息
Path：/openapi/v1/organization/application/token
Method：POST
接口描述：
- 访问
openapi/v1路径下接口时，需要将本接口获取的加入到 headers 参数中：X-MG-Authentication :
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 |
|---|---|---|---|---|
| app_id | string | 必须 | 需要企业管理员在企业管理后台的应用管理界面获取 | |
| app_secret | string | 必须 | app_id 对应的 secret |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 |
|---|---|---|---|---|
| code | string | 非必须 | ||
| data | object | 非必须 | ||
| ├─ expire | number | 非必须 | token 剩余可用时间，单位秒 | |
| ├─ token | string | 非必须 | 用于其他接口的鉴权 | |
| meta | object | 非必须 | ||
| ├─ time | number | 非必须 | ||
| ├─ trace | string | 非必须 |
用户信息
查询企业用户
基本信息
Path： /openapi/v1/users
Method： GET
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| X-MG-Authentication | 是 |
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| keyword | 是 | 邮箱，用户名 | |
| size | 否 | 返回数据量，默认10 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | |||
| data | object | 必须 | |||
| ├─ users | object [] | 必须 | item 类型: object | ||
| ├─ id | number | 必须 | 用户id | ||
| string | 必须 | 用户邮箱 | |||
| ├─ name | string | 必须 | 用户名 | ||
| ├─ avatar | string | 必须 | 用户头像 | ||
| meta | object | 必须 | |||
| ├─ time | number | 必须 | |||
| ├─ trace | string | 必须 |
获取企业成员
基本信息
Path： /openapi/v1/organization/users
Method： GET
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| X-MG-Authentication | 是 |
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| pageNum | 是 | ||
| pageSize | 否 | 最大500 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | |||
| data | object [] | 必须 | item 类型: object | ||
| ├─ id | string | 必须 | 用户ID | ||
| ├─ name | string | 必须 | 用户昵称 | ||
| string | 必须 | 邮箱 | |||
| meta | object | 必须 | |||
| ├─ trace | string | 必须 | |||
| ├─ time | string | 必须 | |||
| ├─ total | string | 必须 | 用户总数 |
获取团队成员
基本信息
Path： /openapi/v1/team/:teamId/users
Method： GET
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| X-MG-Authentication | 是 | |||
| X-MG-INT-Authentication | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| teamId |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | |||
| data | object [] | 必须 | item 类型: object | ||
| ├─ id | string | 必须 | 用户ID | ||
| ├─ openId | string | 非必须 | 第三方id | ||
| ├─ name | string | 必须 | 用户昵称 | ||
| string | 必须 | 邮箱 | |||
| ├─ teamRole | object | 必须 | 团队角色 | ||
| ├─ documentPermission | string | 必须 | 文档默认权限 | ||
| ├─ role | string | 必须 | 团队角色 | ||
| meta | object | 必须 | |||
| ├─ trace | string | 必须 | |||
| ├─ time | string | 必须 |
获取用户信息
基本信息
Path： /openapi/v1/users/:userId
Method： GET
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| X-MG-Authentication | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| userId |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | |||
| data | object | 必须 | |||
| ├─ id | number | 必须 | 用户id | ||
| ├─ name | string | 必须 | 用户名字 | ||
| string | 必须 | 用户邮件 | |||
| ├─ avatar | string | 必须 | 用户头像 | ||
| meta | object | 必须 | |||
| ├─ time | number | 必须 | |||
| ├─ trace | string | 必须 |
企业
停用用户
基本信息
Path： /openapi/v1/organization/users/status
Method： PUT
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| status | string | 必须 | enable开启 disable关闭 | ||
| userIds | number [] | 必须 | 用户id数组 | item 类型: number |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | |||
| data | object | 必须 |
获取企业信息
基本信息
Path： /openapi/v1/organization
Method： GET
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 非必须 | |||
| data | object | 非必须 | |||
| ├─ id | number | 非必须 | 企业id | ||
| ├─ createAt | string | 非必须 | 创建时间 | ||
| ├─ updateAt | string | 非必须 | 更新时间 | ||
| ├─ name | string | 非必须 | 企业名称 | ||
| ├─ abbr | string | 非必须 | |||
| ├─ logo | string | 非必须 | 企业logo | ||
| ├─ creatorId | number | 非必须 | 创建者ID | ||
| ├─ ownerId | number | 非必须 | 企业所有者ID | ||
| ├─ description | string | 非必须 | 企业信息 | ||
| ├─ openOrganizationEmail | number | 非必须 | 是否开启企业邮箱检查，0不开启，1开启 | ||
| ├─ organizationEmail | string | 非必须 | 企业邮箱 | ||
| ├─ organizationSaml | number | 非必须 | saml信息是否设置完成. 0:否,1:是 | ||
| ├─ organizationOauth | number | 非必须 | oauth信息是否设置完成. 0:否,1:是 | ||
| ├─ openOrganizationSSO | number | 非必须 | sso是否开启. 0:否,1:是 | ||
| ├─ OrganizationSSOType | number | 非必须 | 企业sso登录类型. 0:saml 1:oauth | ||
| ├─ organizationLogin | number | 非必须 | 是否允许匿名未登录账号参与企业文件协作，是：1，否：0 | ||
| ├─ openSharingTimeLimit | number | 非必须 | 打开文件分享时间限制 | ||
| ├─ openForbidAnonymousAccess | number | 非必须 | 是否禁止匿名访问1打开，0关闭 | ||
| ├─ openOrganizationSpace | number | 非必须 | 打开企业空间 | ||
| ├─ isPublic | boolean | 非必须 | 是否公开邀请链接 | ||
| ├─ ext | number | 非必须 | // 从右至左// 第1位: 0: 官网申请 1: 工作台开通试用 // 第2位: 0: CMS 后台开通(暂未实现) // 第3位: // 第4位: 是否允许企业成员绑定非邮箱域的邮箱 0:允许 1:不允许 // 第5位: 是否允许企业成员解绑符合企业邮箱域的邮箱 0:不允许 1:允许 | ||
| meta | object | 非必须 | |||
| ├─ time | number | 非必须 | |||
| ├─ trace | string | 非必须 | |||
| msg | string | 非必须 |
团队信息
创建团队
基本信息
Path： /openapi/v1/users/:userId/team
Method： POST
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | ||
| X-MG-Authentication | 是 | |||
| X-MG-INT-Authentication | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| userId | 创建者id |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| name | string | 非必须 | 团队名 | ||
| description | string | 非必须 | 团队表述 | ||
| siteLink | string | 非必须 | 团队图标 | ||
| isHidden | boolean | 非必须 | 是否是隐藏团队 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 非必须 | |||
| data | object | 非必须 | |||
| ├─ id | number | 非必须 | 团队ID | ||
| ├─ createAt | string | 非必须 | 创建时间 | ||
| ├─ updateAt | string | 非必须 | 更新时间 | ||
| ├─ name | string | 非必须 | 团队名称 | ||
| ├─ description | string | 非必须 | 团队描述 | ||
| ├─ siteLink | string | 非必须 | 团队网址 | ||
| ├─ isPersonal | boolean | 非必须 | 是否为私有团队 | ||
| ├─ logo | string | 非必须 | Logo 地址 | ||
| ├─ projects | null | 非必须 | |||
| ├─ teamIndex | number | 非必须 | |||
| ├─ teamFracDex | string | 非必须 | |||
| ├─ roleName | string | 非必须 | |||
| ├─ publicTeamRole | string | 非必须 | |||
| ├─ creatorId | number | 非必须 | 创建者ID | ||
| ├─ ownerId | number | 非必须 | 团队所有者ID | ||
| ├─ organizationId | number | 非必须 | 组织id | ||
| ├─ sourceId | string | 非必须 | 第三方侧用团队id | ||
| ├─ sourceType | string | 非必须 | 第三方侧来源类型 | ||
| ├─ ext | number | 非必须 | |||
| ├─ isHidden | boolean | 非必须 | 是否隐藏团队状态 | ||
| ├─ isMyProject | boolean | 非必须 | 是否初始化的我的团队 | ||
| ├─ isPublic | boolean | 非必须 | 否是公开团队 | ||
| ├─ isDingTeam | boolean | 非必须 | 是否关联钉钉企业的团队 | ||
| meta | object | 非必须 | |||
| ├─ time | number | 非必须 | |||
| ├─ trace | string | 非必须 | |||
| msg | string | 非必须 |
获取企业下团队
基本信息
Path： /openapi/v1/organization/teams
Method： GET
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| X-MG-Authentication | 是 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | |||
| data | object [] | 必须 | item 类型: object | ||
| ├─ createdAt | string | 非必须 | 创建时间 | ||
| ├─ description | null,string | 非必须 | 描述 | ||
| ├─ id | number | 非必须 | 团队ID | ||
| ├─ logo | string | 非必须 | Logo 地址 | ||
| ├─ name | string | 非必须 | 名称 | ||
| ├─ ownerId | number | 非必须 | 团队所有者ID | ||
| ├─ updatedAt | string | 非必须 | 更新时间 | ||
| meta | object | 必须 | |||
| ├─ time | number | 必须 | |||
| ├─ trace | string | 必须 | |||
| msg | string | 必须 |
获取用户团队列表
基本信息
Path： /openapi/v1/users/:userId/teams
Method： GET
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| X-MG-Authentication | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| userId |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | |||
| data | object [] | 必须 | item 类型: object | ||
| ├─ createdAt | string | 非必须 | |||
| ├─ description | null,string | 非必须 | |||
| ├─ id | number | 非必须 | 团队id | ||
| ├─ logo | string | 非必须 | Logo 地址 | ||
| ├─ name | string | 非必须 | 名称 | ||
| ├─ ownerId | number | 非必须 | 团队所有者ID | ||
| ├─ updatedAt | string | 非必须 | 创建时间 | ||
| ├─ ext | string | 必须 | 0:否;1:是，是否为公开团队 | ||
| meta | object | 必须 | |||
| ├─ time | number | 必须 | |||
| ├─ trace | string | 必须 | |||
| msg | string | 必须 |
获取团队下项目
基本信息
Path： /openapi/v1/team/:teamId/projects
Method： GET
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| X-MG-Authentication | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| teamId |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | |||
| data | object [] | 必须 | item 类型: object | ||
| ├─ createdAt | string | 非必须 | 创建时间 | ||
| ├─ id | number | 非必须 | 项目id | ||
| ├─ name | string | 非必须 | 项目名称 | ||
| ├─ updatedAt | string | 非必须 | 更新时间 | ||
| meta | object | 必须 | |||
| ├─ time | number | 必须 | |||
| ├─ trace | string | 必须 | |||
| msg | string | 必须 |
获取团队下文件
基本信息
Path： /openapi/v1/team/:teamId/documents
Method： GET
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| X-MG-Authentication | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| teamId |
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| page[number] | 否 | 页码 | |
| page[size] | 否 | 每页大小 | |
| userId | 否 | 用户id | |
| sort | 否 | name -name created_at -created_at updated_at -updated_at |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | |||
| data | object [] | 必须 | item 类型: object | ||
| ├─ createdAt | string | 非必须 | 创建时间 | ||
| ├─ creatorId | number | 非必须 | 创建人用户ID | ||
| ├─ id | number | 非必须 | 文档id | ||
| ├─ name | string | 非必须 | 文档名称 | ||
| ├─ ownerId | number | 非必须 | 所有者用户ID | ||
| ├─ type | number | 非必须 | 文档类型.默认:0.0:普通文件;1:新人引导文件;2:sketch上传3:figma上传4:管理员上传;5:资源广场副本;6:playgroud文件;7:资源池文件;8:共享型playgroud文件9:初始化团队库文件 | ||
| ├─ updatedAt | string | 非必须 | 更新时间 | ||
| ├─ cover | string | 必须 | 封面 | ||
| ├─ coverBgColor | string | 必须 | 封面背景 | ||
| ├─ permissions | object | 必须 | |||
| ├─ action | boolean | 必须 | 权限点： 如 edit: true / false | ||
| ├─ openId | string | 必须 | ！！仅集成返回！！ | ||
| meta | object | 必须 | |||
| ├─ time | number | 必须 | |||
| ├─ trace | string | 必须 | |||
| ├─ page | string | 必须 | 文件页ma | ||
| ├─ total | string | 必须 | 文件总数量 | ||
| msg | string | 必须 |
获取项目下文件
基本信息
Path： /openapi/v1/project/:projectId/documents
Method： GET
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| X-MG-Authentication | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| projectId |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | |||
| data | object [] | 必须 | item 类型: object | ||
| ├─ createdAt | string | 非必须 | |||
| ├─ creatorId | number | 非必须 | |||
| ├─ id | number | 非必须 | |||
| ├─ name | string | 非必须 | |||
| ├─ ownerId | number | 非必须 | |||
| ├─ type | number | 非必须 | |||
| ├─ updatedAt | string | 非必须 | |||
| meta | object | 必须 | |||
| ├─ time | number | 必须 | |||
| ├─ trace | string | 必须 | |||
| msg | string | 必须 |
获取团队下已经发布的文件
基本信息
Path： /openapi/v1/team/:teamId/lib/documents
Method： GET
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| X-MG-Authentication | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| teamId |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | |||
| data | object [] | 必须 | item 类型: object | ||
| ├─ createdAt | string | 非必须 | 创建时间 | ||
| ├─ creatorId | number | 非必须 | 创建文档者id | ||
| ├─ id | number | 非必须 | 文档id | ||
| ├─ libraryId | string | 非必须 | 团队库id | ||
| ├─ name | string | 非必须 | 文档id | ||
| ├─ ownerId | number | 非必须 | 文档所有者id | ||
| ├─ type | number | 非必须 | 文档类型.默认:0.0:普通文件;1:新人引导文件;2:sketch上传3:figma上传4:管理员上传;5:资源广场副本;6:playgroud文件;7:资源池文件;8:共享型playgroud文件9:初始化团队库文件 | ||
| ├─ updatedAt | string | 非必须 | 文档更新时间 | ||
| meta | object | 必须 | |||
| ├─ time | number | 必须 | |||
| ├─ trace | string | 必须 | |||
| msg | string | 必须 |
项目信息
创建项目
基本信息
Path： /openapi/v1/users/:userId/project
Method： POST
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | ||
| X-MG-Authentication | 是 | |||
| X-MG—INT-Authentication | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| userId | 创建者id |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| name | string | 必须 | 项目名 | ||
| teamId | number | 必须 | 项目所属团队 | ||
| visitControl | number | 非必须 | 1: 当前团队成员可访问（默认） 3: 仅受邀协作者可访问 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 非必须 | |||
| data | object | 非必须 | |||
| ├─ id | number | 非必须 | 项目ID | ||
| ├─ createAt | string | 非必须 | 创建时间 | ||
| ├─ updateAt | string | 非必须 | 更新时间 | ||
| ├─ name | string | 非必须 | 名称 | ||
| ├─ isPersonal | boolean | 非必须 | 是否为私有项目 | ||
| ├─ teamId | number | 非必须 | 所属团队ID | ||
| ├─ documents | null | 非必须 | |||
| ├─ projectIndex | number | 非必须 | |||
| ├─ projectFracDex | string | 非必须 | |||
| ├─ content_moderation | null | 非必须 | 内容审查字段 | ||
| ├─ visitControl | number | 非必须 | 1: 当前团队可访问, 3: 仅邀请者可访问 | ||
| ├─ isPublic | number | 非必须 | 0: 不公开, 1: 公开 | ||
| ├─ shareCode | string | 非必须 | 分享码 | ||
| ├─ groups | null | 非必须 | |||
| meta | object | 非必须 | |||
| ├─ time | number | 非必须 | |||
| ├─ trace | string | 非必须 | |||
| msg | string | 非必须 |
删除项目
基本信息
Path： /openapi/v1/users/:userId/project/:projectId
Method： DELETE
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 | ||
| X-MG-Authentication | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| userId | 创建者id | |
| projectId | 项目id |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| name | string | 必须 | 项目名 | ||
| teamId | number | 必须 | 项目所属团队 | ||
| visitControl | number | 非必须 | 1: 当前团队成员可访问（默认） 3: 仅受邀协作者可访问 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | |||
| data | object | 必须 | |||
| ├─ id | number | 必须 | 项目id | ||
| ├─ name | string | 必须 | |||
| meta | object | 必须 | |||
| ├─ time | number | 必须 | |||
| ├─ trace | string | 必须 | |||
| msg | string | 必须 |
更新项目
基本信息
Path： /openapi/v1/users/:userId/project/:projectId
Method： PUT
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | ||
| X-MG-Authentication | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| userId | 创建者id | |
| projectId | 项目id |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| name | string | 非必须 | 项目名 | ||
| teamId | number | 必须 | 项目所属团队 | ||
| visitControl | number | 非必须 | 1: 当前团队成员可访问（默认） 3: 仅受邀协作者可访问 | ||
| IsPublic | string | 非必须 | 是否公开 | ||
| projectId | number | 必须 | 项目ID |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | |||
| data | object | 必须 | |||
| ├─ id | number | 必须 | 项目id | ||
| ├─ name | string | 必须 | |||
| meta | object | 必须 | |||
| ├─ time | number | 必须 | |||
| ├─ trace | string | 必须 | |||
| msg | string | 必须 |
获取用户项目列表
基本信息
Path： /openapi/v1/users/:userId/projects
Method： GET
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| X-MG-Authentication | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| userId |
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| teamId | 是 | 团队id |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | |||
| data | object [] | 必须 | item 类型: object | ||
| ├─ createdAt | string | 非必须 | |||
| ├─ id | number | 非必须 | 项目id | ||
| ├─ name | string | 非必须 | 项目名称 | ||
| ├─ updatedAt | string | 非必须 | |||
| meta | object | 必须 | |||
| ├─ time | number | 必须 | |||
| ├─ trace | string | 必须 | |||
| msg | string | 必须 |
获取项目下已经发布的文件
基本信息
Path： /openapi/v1/project/:projectId/lib/documents
Method： GET
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| X-MG-Authentication | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| projectId |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | |||
| data | object [] | 必须 | item 类型: object | ||
| ├─ createdAt | string | 非必须 | 文档创建时间 | ||
| ├─ creatorId | number | 非必须 | 创建者Id | ||
| ├─ id | number | 非必须 | 文档id | ||
| ├─ libraryId | string | 非必须 | 团队库id | ||
| ├─ name | string | 非必须 | 文档名称 | ||
| ├─ ownerId | number | 非必须 | 文件所有者id | ||
| ├─ type | number | 非必须 | 文档类型 | ||
| ├─ updatedAt | string | 非必须 | 文档更新时间 | ||
| meta | object | 必须 | |||
| ├─ time | number | 必须 | |||
| ├─ trace | string | 必须 | |||
| msg | string | 必须 |
文件分组信息
获取分组下文件
基本信息
Path： /openapi/v1/project/:projectId/group/:groupId/documents
Method： GET
请求参数
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| projectId | ||
| groupId |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 非必须 | |||
| data | object [] | 非必须 | item 类型: object | ||
| ├─ id | number | 非必须 | 文档id | ||
| ├─ name | string | 非必须 | 文档名称 | ||
| ├─ ownerId | number | 非必须 | 文档拥有者 | ||
| ├─ updatedAt | string | 非必须 | 更新时间 | ||
| ├─ createdAt | string | 非必须 | 创建时间 | ||
| ├─ creatorId | number | 非必须 | 创建者ID | ||
| ├─ type | number | 非必须 | 文档类型.默认:0.0:普通文件;1:新人引导文件;2:sketch上传3:figma上传4:管理员上传;5:资源广场副本;6:playgroud文件;7:资源池文件;8:共享型playgroud文件9:初始化团队库文件 | ||
| meta | object | 非必须 | |||
| ├─ time | number | 非必须 | |||
| ├─ trace | string | 非必须 | |||
| msg | string | 非必须 |
获取项目下所有分组
基本信息
Path： /openapi/v1/project/:projectId/group
Method： GET
请求参数
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| projectId |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 非必须 | |||
| data | object [] | 非必须 | item 类型: object | ||
| ├─ id | number | 必须 | 分组id | ||
| ├─ createAt | string | 必须 | 创建时间 | ||
| ├─ updateAt | string | 必须 | 更新时间 | ||
| ├─ projectId | number | 必须 | 项目id | ||
| ├─ category | string | 必须 | 标签分类，doc_group-文件组 | ||
| ├─ name | string | 必须 | 分组名称 | ||
| meta | object | 非必须 | |||
| ├─ time | number | 非必须 | |||
| ├─ trace | string | 非必须 | |||
| msg | string | 非必须 |
文件信息
删除文件到回收站
基本信息
Path： /openapi/v1/users/:userId/document
Method： DELETE
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | ||
| X-MG-Authentication | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| userId |
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| documentId | 是 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | |||
| data | object | 非必须 | |||
| meta | object | 非必须 | |||
| ├─ time | string | 必须 | |||
| ├─ trace | string | 必须 | |||
| msg | string | 必须 |
批量获取文件详情信息
基本信息
Path： /openapi/v1/documents
Method： POST
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | ||
| X-MG-Authentication | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| ids | number [] | 必须 | 文档id列表（最多支持100个） | item 类型: number |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | |||
| data | object [] | 必须 | item 类型: object | ||
| ├─ createdAt | string | 非必须 | 更新时间 | ||
| ├─ creatorId | number | 非必须 | 创建人用户ID | ||
| ├─ id | number | 非必须 | 文档ID | ||
| ├─ name | string | 非必须 | 文档名称 | ||
| ├─ ownerId | number | 非必须 | 所有者用户ID | ||
| ├─ type | number | 非必须 | 文档类型.默认:0.0:普通文件;1:新人引导文件;2:sketch上传3:figma上传4:管理员上传;5:资源广场副本;6:playgroud文件;7:资源池文件;8:共享型playgroud文件9:初始化团队库文件 | ||
| ├─ cover | string | 非必须 | 封面 | ||
| ├─ coverBGColor | string | 非必须 | 文档封面背景色 | ||
| ├─ updatedAt | string | 非必须 | 更新时间 | ||
| meta | object | 必须 | |||
| ├─ time | number | 必须 | |||
| ├─ trace | string | 必须 | |||
| msg | string | 必须 |
根据文件名搜索文件
基本信息
Path： /openapi/v1/searchDocs
Method： GET
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| key | 是 | 文件名关键词 | |
| teamId | 否 | 在指定团队下搜索文件 | |
| projectId | 否 | 在指定项目下搜索文件 | |
| userId | 否 | 在指定用户下搜索文件 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 非必须 | |||
| data | object [] | 非必须 | item 类型: object | ||
| ├─ id | number | 必须 | 文档id | ||
| ├─ name | string | 必须 | 文档名称 | ||
| ├─ cover | string | 必须 | 文档封面 | ||
| ├─ owner_Id | number | 必须 | 文档拥有者id | ||
| ├─ updated_at | string | 必须 | 更新时间 | ||
| meta | object | 非必须 | |||
| ├─ time | number | 非必须 | |||
| ├─ trace | string | 非必须 |
用户新建文件
基本信息
Path： /openapi/v1/users/:userId/document
Method： POST
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | ||
| X-MG-Authentication | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| userId |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| projectId | number | 非必须 | 项目id(不传默认建到草稿箱) | ||
| name | string | 非必须 | 文件名 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 非必须 | |||
| data | object | 非必须 | |||
| ├─ id | number | 非必须 | 文档id | ||
| ├─ createAt | string | 非必须 | 创建时间 | ||
| ├─ updateAt | string | 非必须 | 更新时间 | ||
| ├─ name | string | 非必须 | 文档名字 | ||
| ├─ projectId | number | 非必须 | 项目id | ||
| ├─ teamId | number | 非必须 | 团队id | ||
| ├─ deleteUserId | number | 非必须 | 删除文档操作id | ||
| ├─ isPublic | boolean | 非必须 | 是否公共可访问 | ||
| ├─ allowCopy | boolean | 非必须 | 是否允许复制 | ||
| ├─ allowCopyRole | string | 非必须 | 允许复制的角色 | ||
| ├─ cover | string | 非必须 | 封面 | ||
| ├─ coverBgColor | string | 非必须 | 封面背景颜色 | ||
| ├─ creator | number | 非必须 | 创建者id | ||
| ├─ owner | number | 非必须 | 拥有者id | ||
| ├─ updateUserId | number | 非必须 | 删除文档操作者id | ||
| ├─ docType | number | 非必须 | 文档类型.默认:0.0:普通文件;1:新人引导文件;2:sketch上传3:figma上传4:管理员上传;5:资源广场副本;6:playgroud文件;7:资源池文件;8:共享型playgroud文件9:初始化团队库文件' | ||
| ├─ originDoc | number | 非必须 | 允许复制操作的角色.默认:member.member:成员 onlooker:查看者 | ||
| ├─ publicFileRole | string | 非必须 | 公开文档加入角色.默认为空.设置为公开后赋值.member:成员 onlooker:查看者 | ||
| ├─ components | string | 非必须 | |||
| ├─ styles | string | 非必须 | |||
| ├─ allowOnlookerCopy | boolean | 非必须 | |||
| ├─ roleName | string | 非必须 | 角色名称 | ||
| ├─ fileKey | string | 非必须 | |||
| ├─ accessId | number | 非必须 | 文档访问序列 | ||
| ├─ containerId | string | 非必须 | 封面绑定的容器ID | ||
| ├─ batchVersion | number | 非必须 | 资源池文件批次版本 | ||
| ├─ ext | number | 非必须 | 扩展字段.bit位信息.0:否;1:是.由右到左:是否展示协作者,链接邀请是否同步邀请到团队 | ||
| ├─ recycleBinTeamId | number | 非必须 | 回收站团队ID（被删除时的团队ID） | ||
| ├─ hidePartner | boolean | 非必须 | |||
| ├─ inviteTeam | boolean | 非必须 | |||
| ├─ content_comderation | null | 非必须 | 内容审查字段 | ||
| ├─ isSecret | boolean | 非必须 | |||
| ├─ isTeamLib | boolean | 非必须 | |||
| ├─ projectGroupTagId | number | 非必须 | |||
| ├─ srcProjectGroupTagId | number | 非必须 | |||
| ├─ visitControl | number | 非必须 | 文档访问控制，1团队成员可访问 2企业成员可访问 3仅文件协作者可访问 | ||
| ├─ visitControlPerm | string | 非必须 | 文档访问控制权限，view可查看 edit可编辑 | ||
| meta | object | 非必须 | |||
| ├─ time | number | 非必须 | |||
| ├─ trace | string | 非必须 |
用户更新文件
基本信息
Path： /openapi/v1/users/:userId/document/:documentId
Method： PUT
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | ||
| X-MG-Authentication | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| userId | 用户id，uint64 | |
| documentId | 文档id，uint64 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| name | string | 非必须 | 文件名 | ||
| isPublic | string | 非必须 | 是否公开 | ||
| allowCopy | string | 非必须 | 是否允许复制 | ||
| allowOnlookerCopy | string | 非必须 | true ：容许onlooker复制文件; false：不容许onlooker复制文件 | ||
| cover | string | 非必须 | 封面 | ||
| coverBgColor | string | 非必须 | 封面背景 | ||
| versionId | string | 非必须 | 版本号 | ||
| publicFileRole | string | 非必须 | 【废弃】如果需要修改值则必须和isPublic一起传递；字段值：view/edit | ||
| publicDocPermission | string | 非必须 | view可查看 edit可编辑 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | |||
| meta | object | 非必须 | |||
| ├─ time | string | 非必须 | |||
| ├─ trace | string | 非必须 | |||
| data | object | 非必须 | |||
| msg | string | 非必须 |
获取用户文件列表
基本信息
Path： /openapi/v1/users/:userId/documents
Method： GET
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| X-MG-Authentication | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| userId |
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| projectId | 否 | 项目id（不传默认获取草稿箱文件） |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | |||
| data | object [] | 必须 | item 类型: object | ||
| ├─ createdAt | string | 非必须 | 创建时间 | ||
| ├─ creatorId | number | 非必须 | 创建人用户ID | ||
| ├─ id | number | 非必须 | 文档ID | ||
| ├─ name | string | 非必须 | 文档名称 | ||
| ├─ ownerId | number | 非必须 | 所有者用户ID | ||
| ├─ type | number | 非必须 | 文档类型.默认:0. 0:普通文件;1:新人引导文件;2:sketch上传3:figma上传4:管理员上传;5:资源广场副本;6:playgroud文件;7:资源池文件;8:共享型playgroud文件9:初始化团队库文件 | ||
| ├─ cover | string | 非必须 | 封面 | ||
| ├─ coverBGColor | string | 非必须 | 文档封面背景色 | ||
| ├─ updatedAt | string | 非必须 | 更新时间 | ||
| meta | object | 必须 | |||
| ├─ time | number | 必须 | |||
| ├─ trace | string | 必须 | |||
| msg | string | 必须 |
团队库
获取该文件下所有已经发布的内容
基本信息
Path： /openapi/v1/document/:documentId/library
Method： GET
接口描述：
- 后续重复结构，不再给出备注信息
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| X-MG-Authentication | 是 | 值为鉴权token接口获取到的token |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| documentId | 79932944518710 | 文件id |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | |||
| data | object [] | 必须 | item 类型: object | ||
| ├─ documentId | number | 非必须 | 文件ID | ||
| ├─ documentName | string | 非必须 | 文件名称 | ||
| ├─ projectId | number | 非必须 | 项目ID | ||
| ├─ teamId | number | 非必须 | 团队ID | ||
| ├─ creator | object | 非必须 | 文件创建者信息 | ||
| ├─ id | number | 非必须 | 用户id | ||
| ├─ name | string | 非必须 | 用户名称 | ||
| ├─ avatar | string | 非必须 | 用户头像链接 | ||
| ├─ createdAt | string | 非必须 | 文件创建时间 | ||
| ├─ updatedAt | string | 非必须 | 文件最后更新时间 | ||
| ├─ publishedScope | string | 非必须 | 发布范围，发布到当前团队:team; 发布到多团队:multiTeam; 发布到企业:orgnization. | ||
| ├─ components | object [] | 非必须 | 组件信息 | item 类型: object | |
| ├─ ukey | string | 非必须 | 组件唯一标识 | ||
| ├─ documentId | number | 非必须 | 组件所属的文件id | ||
| ├─ layerId | string | 非必须 | 组件所属图层id | ||
| ├─ name | string | 非必须 | 组件名称 | ||
| ├─ cover | string | 非必须 | 组件缩略图地址 | ||
| ├─ description | string | 非必须 | 描述 | ||
| ├─ componentSetUkey | string | 非必须 | 组件所属的组件集唯一标识，当组件集不存在时为空 | ||
| ├─ lastUpdator | object | 非必须 | 最后一个更新者信息 | ||
| ├─ id | number | 非必须 | |||
| ├─ name | string | 非必须 | |||
| ├─ avatar | string | 非必须 | |||
| ├─ pageInfo | object | 非必须 | 组件所属页面信息 | ||
| ├─ pageId | string | 非必须 | 页面id | ||
| ├─ pageName | string | 非必须 | 页面名称 | ||
| ├─ layerId | string | 非必须 | 图层id | ||
| ├─ frameName | string | 非必须 | 容器名称 | ||
| ├─ backgroundColor | string | 非必须 | 背景颜色 | ||
| ├─ createdAt | string | 非必须 | 组件创建时间 | ||
| ├─ updatedAt | string | 非必须 | 组件最后更新时间 | ||
| ├─ componentSets | object [] | 非必须 | 组件集信息 | item 类型: object | |
| ├─ ukey | string | 非必须 | 组件集唯一标识 | ||
| ├─ documentId | number | 非必须 | 组件所属的文件id | ||
| ├─ layerId | string | 非必须 | 组件所属图层id | ||
| ├─ name | string | 非必须 | 组件名称 | ||
| ├─ cover | string | 非必须 | 组件封面 | ||
| ├─ description | string | 非必须 | 描述 | ||
| ├─ lastUpdator | object | 非必须 | 最后更新者信息 | ||
| ├─ id | number | 非必须 | |||
| ├─ name | string | 非必须 | |||
| ├─ avatar | string | 非必须 | |||
| ├─ pageInfo | object | 非必须 | 组件所属页面信息 | ||
| ├─ pageId | string | 非必须 | 页面id | ||
| ├─ pageName | string | 非必须 | 页面名称 | ||
| ├─ layerId | string | 非必须 | 图层id | ||
| ├─ frameName | string | 非必须 | 容器名称 | ||
| ├─ backgroundColor | string | 非必须 | 背景颜色 | ||
| ├─ createdAt | string | 非必须 | 创建时间 | ||
| ├─ updatedAt | string | 非必须 | 更新时间 | ||
| ├─ styles | object [] | 非必须 | item 类型: object | ||
| ├─ ukey | string | 非必须 | 组件集唯一标识 | ||
| ├─ documentId | number | 非必须 | 组件所属的文件id | ||
| ├─ name | string | 非必须 | 名字 | ||
| ├─ cover | string | 非必须 | 封面 | ||
| ├─ description | string | 非必须 | 描述 | ||
| ├─ styleType | string | 非必须 | 样式类型 | ||
| ├─ sortIndex | string | 非必须 | 排序标识 | ||
| ├─ styleSubType | number | 非必须 | 样式子类型 | ||
| ├─ lastUpdator | object | 非必须 | 最后更新者信息 | ||
| ├─ id | number | 非必须 | |||
| ├─ name | string | 非必须 | |||
| ├─ avatar | string | 非必须 | |||
| ├─ createdAt | string | 非必须 | 创建时间 | ||
| ├─ updatedAt | string | 非必须 | 更新时间 | ||
| meta | object | 必须 | |||
| ├─ time | number | 必须 | |||
| ├─ trace | string | 必须 | |||
| msg | string | 必须 |
获取该团队下所有已经发布的内容
基本信息
Path： /openapi/v1/team/:teamId/libraries
Method： GET
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| X-MG-Authentication | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| teamId | 79932816592431 | 团队id |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | |||
| data | object [] | 必须 | item 类型: object | ||
| ├─ documentId | number | 非必须 | 文档id | ||
| ├─ documentName | string | 非必须 | 文档名称 | ||
| ├─ projectId | number | 非必须 | 项目id | ||
| ├─ teamId | number | 非必须 | 团队id | ||
| ├─ creator | object | 非必须 | |||
| ├─ id | number | 非必须 | 创建者id | ||
| ├─ name | string | 非必须 | 创建者名字 | ||
| ├─ avatar | string | 非必须 | 创建者头像 | ||
| ├─ createdAt | string | 非必须 | 创建时间 | ||
| ├─ updatedAt | string | 非必须 | 更新时间 | ||
| ├─ publishedScope | string | 非必须 | 1.团队组件库(即发布到团队的组件库) 2.企业组件库(发布到企业的组件库) | ||
| ├─ components | object [] | 非必须 | 组件信息 | item 类型: object | |
| ├─ ukey | string | 非必须 | 组件唯一标识 | ||
| ├─ documentId | number | 非必须 | 组件所属文件id | ||
| ├─ layerId | string | 非必须 | 组件所属图层id | ||
| ├─ name | string | 非必须 | 组件名称 | ||
| ├─ cover | string | 非必须 | 组件缩略图地址 | ||
| ├─ description | string | 非必须 | 描述 | ||
| ├─ componentSetUkey | string | 非必须 | 组件所属的组件集唯一标识，当组件集不存在时为空 | ||
| ├─ lastUpdator | object | 非必须 | 最后一个更新者信息 | ||
| ├─ id | number | 非必须 | |||
| ├─ name | string | 非必须 | |||
| ├─ avatar | string | 非必须 | |||
| ├─ pageInfo | object | 非必须 | 组件所属页面信息 | ||
| ├─ pageId | string | 非必须 | 页面id | ||
| ├─ pageName | string | 非必须 | 页面名称 | ||
| ├─ layerId | string | 非必须 | 图层id | ||
| ├─ frameName | string | 非必须 | 容器名称 | ||
| ├─ backgroundColor | string | 非必须 | 背景颜名 | ||
| ├─ createdAt | string | 非必须 | 创建时间 | ||
| ├─ updatedAt | string | 非必须 | 更新时间 | ||
| ├─ componentSets | object [] | 非必须 | item 类型: object | ||
| ├─ ukey | string | 非必须 | 组件唯一标识 | ||
| ├─ documentId | number | 非必须 | 组件所属文件id | ||
| ├─ layerId | string | 非必须 | 图层id | ||
| ├─ name | string | 非必须 | 组件名称 | ||
| ├─ cover | string | 非必须 | 组件缩略图地址 | ||
| ├─ description | string | 非必须 | 描述 | ||
| ├─ lastUpdator | object | 非必须 | 最后一位更新者信息 | ||
| ├─ id | number | 非必须 | |||
| ├─ name | string | 非必须 | |||
| ├─ avatar | string | 非必须 | |||
| ├─ pageInfo | object | 非必须 | |||
| ├─ pageId | string | 非必须 | 页面id | ||
| ├─ pageName | string | 非必须 | 页面名称 | ||
| ├─ layerId | string | 非必须 | 图层id | ||
| ├─ frameName | string | 非必须 | 容器名称 | ||
| ├─ backgroundColor | string | 非必须 | 背景颜名 | ||
| ├─ createdAt | string | 非必须 | 创建时间 | ||
| ├─ updatedAt | string | 非必须 | 更新时间 | ||
| ├─ styles | object [] | 非必须 | item 类型: object | ||
| ├─ ukey | string | 非必须 | 组件集唯一标识 | ||
| ├─ documentId | number | 非必须 | 组件所属的文件id | ||
| ├─ name | string | 非必须 | 名字 | ||
| ├─ cover | string | 非必须 | 封面 | ||
| ├─ description | string | 非必须 | 描述 | ||
| ├─ styleType | string | 非必须 | 样式类型 | ||
| ├─ sortIndex | string | 非必须 | 排序标识 | ||
| ├─ styleSubType | number | 非必须 | 样式子类型 | ||
| ├─ lastUpdator | object | 非必须 | 最后一个更新者信息 | ||
| ├─ id | number | 非必须 | |||
| ├─ name | string | 非必须 | |||
| ├─ avatar | string | 非必须 | |||
| ├─ createdAt | string | 非必须 | 创建时间 | ||
| ├─ updatedAt | string | 非必须 | 更新时间 | ||
| meta | object | 必须 | |||
| ├─ time | number | 必须 | |||
| ├─ trace | string | 必须 | |||
| msg | string | 必须 |
获取文件下已经发布的组件详情
基本信息
Path： /openapi/v1/document/:documentId/components
Method： GET
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| X-MG-Authentication | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| documentId |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | |||
| data | object [] | 必须 | item 类型: object | ||
| ├─ ukey | string | 非必须 | 组件唯一标识 | ||
| ├─ documentId | number | 非必须 | 组件所属的文件id | ||
| ├─ layerId | string | 非必须 | 组件所属图层id | ||
| ├─ name | string | 非必须 | 组件名称 | ||
| ├─ cover | string | 非必须 | 组件缩略图地址 | ||
| ├─ description | string | 非必须 | 描述 | ||
| ├─ componentSetUkey | string | 非必须 | 组件所属的组件集唯一标识，当组件集不存在时为空 | ||
| ├─ lastUpdator | object | 非必须 | 最后更新者信息 | ||
| ├─ id | number | 非必须 | |||
| ├─ name | string | 非必须 | |||
| ├─ avatar | string | 非必须 | |||
| ├─ pageInfo | object | 非必须 | |||
| ├─ pageId | string | 非必须 | 页面id | ||
| ├─ pageName | string | 非必须 | 页面名称 | ||
| ├─ layerId | string | 非必须 | 图层id | ||
| ├─ frameName | string | 非必须 | 容器名称 | ||
| ├─ backgroundColor | string | 非必须 | 背号颜名 | ||
| ├─ createdAt | string | 非必须 | |||
| ├─ updatedAt | string | 非必须 | |||
| meta | object | 必须 | |||
| ├─ time | number | 必须 | |||
| ├─ trace | string | 必须 | |||
| msg | string | 必须 |
获取文件下已经发布的组件集详情
基本信息
Path： /openapi/v1/document/:documentId/componentSets
Method： GET
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| X-MG-Authentication | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| documentId |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | |||
| data | object [] | 必须 | item 类型: object | ||
| ├─ ukey | string | 非必须 | 组件唯一标识 | ||
| ├─ documentId | number | 非必须 | 组件所属的文件id | ||
| ├─ layerId | string | 非必须 | 组件所属图层id | ||
| ├─ name | string | 非必须 | 组件名称 | ||
| ├─ cover | string | 非必须 | 组件缩略图地址 | ||
| ├─ description | string | 非必须 | 描述 | ||
| ├─ lastUpdator | object | 非必须 | 最后更新者信息 | ||
| ├─ id | number | 非必须 | |||
| ├─ name | string | 非必须 | |||
| ├─ avatar | string | 非必须 | |||
| ├─ pageInfo | object | 非必须 | 组件所属页面信息 | ||
| ├─ pageId | string | 非必须 | 页面id | ||
| ├─ pageName | string | 非必须 | 页面名称 | ||
| ├─ layerId | string | 非必须 | 图层id | ||
| ├─ frameName | string | 非必须 | 容器名称 | ||
| ├─ backgroundColor | string | 非必须 | 背号颜名 | ||
| ├─ createdAt | string | 非必须 | |||
| ├─ updatedAt | string | 非必须 | |||
| meta | object | 必须 | |||
| ├─ time | number | 必须 | |||
| ├─ trace | string | 必须 | |||
| msg | string | 必须 |
获取文件下已经发布的样式详情
基本信息
Path： /openapi/v1/document/:documentId/styles
Method： GET
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| X-MG-Authentication | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| documentId |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | |||
| data | object [] | 必须 | item 类型: object | ||
| ├─ ukey | string | 非必须 | 样式唯一标识 | ||
| ├─ documentId | number | 非必须 | 所属的文件id | ||
| ├─ name | string | 非必须 | 名字 | ||
| ├─ cover | string | 非必须 | 封面 | ||
| ├─ description | string | 非必须 | 描述 | ||
| ├─ styleType | string | 非必须 | 样式类型 | ||
| ├─ sortIndex | string | 非必须 | 排序标识 | ||
| ├─ styleSubType | number | 非必须 | 样式子类型 | ||
| ├─ lastUpdator | object | 非必须 | 最后更新者信息 | ||
| ├─ id | number | 非必须 | |||
| ├─ name | string | 非必须 | |||
| ├─ avatar | string | 非必须 | |||
| ├─ createdAt | string | 非必须 | |||
| ├─ updatedAt | string | 非必须 | |||
| meta | object | 必须 | |||
| ├─ time | number | 必须 | |||
| ├─ trace | string | 必须 | |||
| msg | string | 必须 |
获取团队下所有组件详情
基本信息
Path： /openapi/v1/team/:teamId/components
Method： GET
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| X-MG-Authentication | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| teamId |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | |||
| data | object [] | 必须 | item 类型: object | ||
| ├─ ukey | string | 非必须 | 组件唯一标识 | ||
| ├─ documentId | number | 非必须 | 组件所属的文件id | ||
| ├─ layerId | string | 非必须 | 组件所属图层id | ||
| ├─ name | string | 非必须 | 组件名称 | ||
| ├─ cover | string | 非必须 | 封面 | ||
| ├─ description | string | 非必须 | 描述 | ||
| ├─ componentSetUkey | string | 非必须 | 组件所属的组件集唯一标识，当组件集不存在时为空 | ||
| ├─ lastUpdator | object | 非必须 | 最后更新者信息 | ||
| ├─ id | number | 非必须 | |||
| ├─ name | string | 非必须 | |||
| ├─ avatar | string | 非必须 | |||
| ├─ pageInfo | object | 非必须 | 组件所属页面信息 | ||
| ├─ pageId | string | 非必须 | 页面id | ||
| ├─ pageName | string | 非必须 | 页面名称 | ||
| ├─ layerId | string | 非必须 | 图层id | ||
| ├─ frameName | string | 非必须 | 容器名称 | ||
| ├─ backgroundColor | string | 非必须 | 背号颜名 | ||
| ├─ createdAt | string | 非必须 | |||
| ├─ updatedAt | string | 非必须 | |||
| meta | object | 必须 | |||
| ├─ time | number | 必须 | |||
| ├─ trace | string | 必须 | |||
| msg | string | 必须 |
获取团队下已经发布的组件集详情
基本信息
Path： /openapi/v1/team/:teamId/componentSets
Method： GET
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| X-MG-Authentication | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| teamId |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | |||
| data | object [] | 必须 | item 类型: object | ||
| ├─ ukey | string | 非必须 | 组件唯一标识 | ||
| ├─ documentId | number | 非必须 | 组件所属的文件id | ||
| ├─ layerId | string | 非必须 | 组件所属图层id | ||
| ├─ name | string | 非必须 | 组件名称 | ||
| ├─ cover | string | 非必须 | 组件缩略图地址 | ||
| ├─ description | string | 非必须 | 描述 | ||
| ├─ lastUpdator | object | 非必须 | 最后更新者信息 | ||
| ├─ id | number | 非必须 | |||
| ├─ name | string | 非必须 | |||
| ├─ avatar | string | 非必须 | |||
| ├─ pageInfo | object | 非必须 | 组件所属页面信息 | ||
| ├─ pageId | string | 非必须 | 页面id | ||
| ├─ pageName | string | 非必须 | 页面名称 | ||
| ├─ layerId | string | 非必须 | 图层id | ||
| ├─ frameName | string | 非必须 | 容器名称 | ||
| ├─ backgroundColor | string | 非必须 | 背号颜名 | ||
| ├─ createdAt | string | 非必须 | |||
| ├─ updatedAt | string | 非必须 | |||
| meta | object | 必须 | |||
| ├─ time | number | 必须 | |||
| ├─ trace | string | 必须 | |||
| msg | string | 必须 |
获取团队下已经发布的样式详情
基本信息
Path： /openapi/v1/team/:teamId/styles
Method： GET
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| X-MG-Authentication | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| teamId |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | |||
| data | object [] | 必须 | item 类型: object | ||
| ├─ ukey | string | 非必须 | 样式唯一标识 | ||
| ├─ documentId | number | 非必须 | 所属的文件id | ||
| ├─ name | string | 非必须 | 名称 | ||
| ├─ cover | string | 非必须 | 封面地址 | ||
| ├─ description | string | 非必须 | 描述信息 | ||
| ├─ styleType | string | 非必须 | 样式类型 | ||
| ├─ sortIndex | string | 非必须 | 排序标识 | ||
| ├─ styleSubType | number | 非必须 | 样式子类型 | ||
| ├─ lastUpdator | object | 非必须 | 最后更新者信息 | ||
| ├─ id | number | 非必须 | |||
| ├─ name | string | 非必须 | |||
| ├─ avatar | string | 非必须 | |||
| ├─ createdAt | string | 非必须 | |||
| ├─ updatedAt | string | 非必须 | |||
| meta | object | 必须 | |||
| ├─ time | number | 必须 | |||
| ├─ trace | string | 必须 | |||
| msg | string | 必须 |
获取特定组件详情
基本信息
Path： /openapi/v1/component
Method： GET
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| X-MG-Authentication | 是 |
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| ukey | 是 | 79932944518710%2B79%3A2 | ukey是组件、组件集、样式的唯一标识，请求时需要对ukey进行url-encode |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | |||
| data | object | 必须 | |||
| ├─ ukey | string | 非必须 | 组件唯一标识 | ||
| ├─ documentId | number | 非必须 | 组件所属的文件id | ||
| ├─ layerId | string | 非必须 | 所属图层id | ||
| ├─ name | string | 非必须 | 组件名称 | ||
| ├─ cover | string | 非必须 | 组件缩略图地址 | ||
| ├─ description | string | 非必须 | 描述 | ||
| ├─ componentSetUkey | string | 非必须 | 组件所属的组件集唯一标识，当组件集不存在时为空 | ||
| ├─ lastUpdator | object | 非必须 | 最后更新者信息 | ||
| ├─ id | number | 非必须 | |||
| ├─ name | string | 非必须 | |||
| ├─ avatar | string | 非必须 | |||
| ├─ pageInfo | object | 非必须 | 组件所属页面信息 | ||
| ├─ pageId | string | 非必须 | 页面id | ||
| ├─ pageName | string | 非必须 | 页面名称 | ||
| ├─ layerId | string | 非必须 | 图层id | ||
| ├─ frameName | string | 非必须 | 容器名称 | ||
| ├─ backgroundColor | string | 非必须 | 背景颜色 | ||
| ├─ createdAt | string | 非必须 | |||
| ├─ updatedAt | string | 非必须 | |||
| meta | object | 必须 | |||
| ├─ time | number | 必须 | |||
| ├─ trace | string | 必须 | |||
| msg | string | 必须 |
获取特定组件集详情
基本信息
Path： /openapi/v1/componentSet
Method： GET
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| X-MG-Authentication | 是 |
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| ukey | 是 | 79932944518710%2B81%3A8 | 需要对ukey进行url-encode |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | |||
| data | object | 必须 | |||
| ├─ ukey | string | 非必须 | 组件唯一标识 | ||
| ├─ documentId | number | 非必须 | 组件所属的文件id | ||
| ├─ layerId | string | 非必须 | 组件所属图层id | ||
| ├─ name | string | 非必须 | 组件名称 | ||
| ├─ cover | string | 非必须 | 组件缩略图地址 | ||
| ├─ description | string | 非必须 | 描述 | ||
| ├─ lastUpdator | object | 非必须 | 最后更新者信息 | ||
| ├─ id | number | 非必须 | |||
| ├─ name | string | 非必须 | |||
| ├─ avatar | string | 非必须 | |||
| ├─ pageInfo | object | 非必须 | 组件所属页面信息 | ||
| ├─ pageId | string | 非必须 | 页面id | ||
| ├─ pageName | string | 非必须 | 页面名称 | ||
| ├─ layerId | string | 非必须 | 图层id | ||
| ├─ frameName | string | 非必须 | 容器名称 | ||
| ├─ backgroundColor | string | 非必须 | 背号颜名 | ||
| ├─ createdAt | string | 非必须 | |||
| ├─ updatedAt | string | 非必须 | |||
| meta | object | 必须 | |||
| ├─ time | number | 必须 | |||
| ├─ trace | string | 必须 | |||
| msg | string | 必须 |
获取特定样式详情
基本信息
Path： /openapi/v1/style
Method： GET
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| X-MG-Authentication | 是 |
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| ukey | 是 | 79932944518710%2B79%3A2 | 需要对ukey进行url-encode |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | |||
| data | object | 必须 | |||
| ├─ ukey | string | 非必须 | 唯一标识 | ||
| ├─ documentId | number | 非必须 | 所属的文件id | ||
| ├─ name | string | 非必须 | 名称 | ||
| ├─ cover | string | 非必须 | 封面地址 | ||
| ├─ description | string | 非必须 | 描述 | ||
| ├─ styleType | string | 非必须 | 样式类型 | ||
| ├─ sortIndex | string | 非必须 | 排序标识 | ||
| ├─ styleSubType | number | 非必须 | 样式子类型 | ||
| ├─ lastUpdator | object | 非必须 | |||
| ├─ id | number | 非必须 | |||
| ├─ name | string | 非必须 | |||
| ├─ avatar | string | 非必须 | |||
| ├─ createdAt | string | 非必须 | |||
| ├─ updatedAt | string | 非必须 | |||
| meta | object | 必须 | |||
| ├─ time | number | 必须 | |||
| ├─ trace | string | 必须 | |||
| msg | string | 必须 |
其他
根据 userCode 获取用户 id
基本信息
Path： /openapi/v1/user
Method： GET
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| X-MG-Authentication | 是 |
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| userCode | 是 | xxxxxxx |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | |||
| data | object | 必须 | |||
| ├─ userId | number | 必须 | MG用户id | ||
| meta | object | 必须 | |||
| ├─ trace | string | 必须 | |||
| ├─ time | string | 必须 |