更新时间:2021-03-18 GMT+08:00
分享

修改大屏名称

功能介绍

修改某一个大屏的名称。

URI

  • URI格式
    PUT /v1/{project_id}/screens/{screen_id}
  • 参数说明
    表1 URI参数说明

    参数

    是否必选

    参数类型

    描述

    project_id

    String

    项目编号,获取方法请参见获取项目ID

    screen_id

    String

    大屏ID,获取方法请参见查询大屏列表

请求消息

参数说明:如表2所示。
表2 请求参数

参数

是否必选

参数类型

描述

name

String

大屏名称,由中文、字母、数字组成,长度为1~32字符。

workspaceId

String

工作空间ID,长度为32个字符,获取方法请参见获取workspaceId

响应消息

参数说明:如表3所示。

表3 响应参数

参数

参数类型

描述

is_success

Boolean

操作是否成功。true:成功,false:失败

statusCode

Integer

状态码

message

String

返回消息

示例

修改大屏ID为ff80808167813a360167819d5b640045的名称,新的名称为screen_01_change。

  • 请求示例
    PUT https://{dlv_endpoint}/v1/{project_id}/screens/ff80808167813a360167819d5b640045
    {请求消息头}
    
    {
        "name":"screen_01_change",
        "workspaceId":"86ce107974ce4f93b618acb232863027"}
  • 成功响应示例
    {
        "is_success": true,
        "statusCode": 200,
        "message": null
    }
  • 失败响应示例
    {
        "errors": [
            {
                "error_code": "1004",
                "error_msg": "The operation with the resource entity occur some error."
            }
        ]
    }

状态码

状态码请参见状态码

分享:

    相关文档

    相关产品