
# 更新大屏 - UpdateScreen
#### 功能介绍
更新大屏。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dataartsinsight/abcd.html)。
#### URI
PUT /v1/{project_id}/screens/update
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                                                            |
|:---|:---|:---|:---|
| project_id | 是    | String | **参数解释：** 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-dataartsinsight/dataartsinsight_projectid.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
#### 请求参数
表2请求Header参数 
| 参数             | 是否必选 | 参数类型   | 描述                                                                                                                                                                  |
|:---|:---|:---|:---|
| X-Workspace-Id | 是    | String | **参数解释：** 工作空间ID。获取方法请参见[获取工作空间ID](https://support.huaweicloud.com/api-dataartsinsight/dataartsinsight_workspaceid.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
| X-Auth-Token   | 是    | String | **参数解释：** 用户Token。通过调用IAM服务获取IAM用户Token接口获取，接口返回的响应消息头中"X-Subject-Token"就是需要获取的用户Token。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                                   |
   
表3请求Body参数 
| 参数   | 是否必选 | 参数类型   | 描述                            |
|:---|:---|:---|:---|
| id   | 是    | String | **参数解释**： 大屏主键。 **取值范围**： 不涉及 |
| name | 是    | String | **参数解释**： 大屏名称。 **取值范围**： 不涉及 |
   
#### 响应参数
**状态码：200**
表4响应Body参数 
| 参数    | 参数类型                                                                                | 描述                            |
|:---|:---|:---|
| id    | String                                                                              | **参数解释：** 大屏ID。 **取值范围：** 不涉及 |
| name  | String                                                                              | **参数解释：** 大屏名称。 **取值范围：** 不涉及 |
| pages | Array of [ScreenPageOpenApiVO] objects | 大屏Page列表。                     |
   
 表5ScreenPageOpenApiVO 
| 参数    | 参数类型                                                                                | 描述                               |
|:---|:---|:---|
| id    | String                                                                              | **参数解释：** Page ID。 **取值范围：** 不涉及 |
| name  | String                                                                              | **参数解释：** Page名称。 **取值范围：** 不涉及  |
| nodes | Array of [ScreenNodeOpenApiVO] objects | Page内组件列表。                       |
   
 表6ScreenNodeOpenApiVO 
| 参数           | 参数类型                                                                  | 描述                              |
|:---|:---|:---|
| id           | String                                                                | **参数解释：** 组件ID。 **取值范围：** 不涉及   |
| name         | String                                                                | **参数解释：** 组件名称。 **取值范围：** 不涉及   |
| type         | String                                                                | **参数解释：** 组件类型。 **取值范围：** 不涉及   |
| hidden       | Boolean                                                               | **参数解释：** 组件是否隐藏。 **取值范围：** 不涉及 |
| target_nodes | Array of [target_nodes] objects | 交互事件关联组件。                       |
   
 表7target_nodes 
| 参数       | 参数类型   | 描述                                |
|:---|:---|:---|
| id       | String | **参数解释：** 关联组件ID。 **取值范围：** 不涉及   |
| field_id | String | **参数解释：** 关联组件字段ID。 **取值范围：** 不涉及 |
   
#### 请求示例
更新大屏。
```
https://{endpoint}/v1/{project_id}/screens/update
{
  "id" : "00xxxx3e-45e5-4cc3-847c-dcxxxx42424d",
  "name" : "updateScreen"
}
```
#### 响应示例
**状态码：200**
更新大屏成功。
- 示例 1
  ```
  {
    "id" : "xx",
    "name" : "空白大屏",
    "pages" : [ {
      "id" : "",
      "name" : "",
      "nodes" : [ ]
    } ],
    "status" : 0
  }
  ```
- 示例 2
  ```
  ```
#### 状态码
| 状态码 | 描述      |
|:---|:---|
| 200 | 更新大屏成功。 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-dataartsinsight/ErrorCode.html)。
