更新时间:2025-03-10 GMT+08:00
分享

新建大屏

功能介绍

新建大屏。

URI

POST /v1/{project_id}/screens/create

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目唯一标识ID。获取方法请参考获取项目ID

约束限制

不涉及

取值范围

只能使用中英文字符,字符长度32位。

默认取值

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Workspace-Id

String

参数解释

工作空间ID。获取方法请参见获取工作空间ID

约束限制

不涉及

取值范围

只能使用中英文字符,字符长度32位。

默认取值

不涉及

X-Auth-Token

String

参数解释

用户Token。 通过调用IAM服务获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token 认证鉴权

约束限制

不涉及

取值范围

非空。

默认取值

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

参数解释

大屏名称。

约束限制

不涉及

取值范围

只允许输入长度为1到32位由数字、中文、英文、空格、下划线(_)或中划线(-)组成的字符,且开头和结尾不能有空格。

默认取值

不涉及

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

id

String

大屏ID。

name

String

大屏名称。

pages

Array of ScreenPageOpenApiVO objects

大屏Page列表。

表5 ScreenPageOpenApiVO

参数

参数类型

描述

id

String

Page ID。

name

String

Page名称。

nodes

Array of ScreenNodeOpenApiVO objects

Page内组件列表。

表6 ScreenNodeOpenApiVO

参数

参数类型

描述

id

String

组件ID。

name

String

组件名称。

type

String

组件类型。

hidden

Boolean

组件是否隐藏。

target_nodes

Array of target_nodes objects

交互事件关联组件。

表7 target_nodes

参数

参数类型

描述

id

String

关联组件ID。

field_id

String

关联组件字段ID。

请求示例

创建大屏。

https://{endpoint}/v1/{project_id}/screens/create

{
  "name" : "newScreen"
}

响应示例

状态码: 200

创建大屏成功。

{
  "id" : "xx",
  "name" : "空白大屏",
  "pages" : [ {
    "id" : "",
    "name" : "",
    "nodes" : [ ]
  } ],
  "status" : 0
}

状态码

状态码

描述

200

创建大屏成功。

错误码

请参见错误码

相关文档