5.3 应用图层模板

请求参数

Header 参数

Content-Type

string

必需

示例值:

application/json

Body 参数application/json

templateId

number

使用的模板唯一ID

必需

screenId

number

必需

模板应用的屏幕唯一ID

sceneType

number

必需

模板应用屏幕的sceneType,同于图层中sceneType字段定义

moduleType

number

可选

所属模块 0:预监 1:图层 (从v1.4版本开始使用,旧版本不传递,不影响功能)

templateType

number

可选

模板类型 1:内置模板 2:自定义模板 3:老化模板(从v1.4版本开始使用,旧版本不传递,不影响功能)

locked

number

图层纵横比锁定状态

必需

锁定状态 0：未锁定 1：锁定

示例

{
    "templateId": 0,
    "screenId": 0,
    "sceneType": 0,
    "moduleType": 0,
    "templateType": 0,
    "locked": 0
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PUT 'http://prod-cn.your-api-server.com/v1/layers/template/select' \
--header 'Content-Type: application/json' \
--data-raw '{
    "templateId": 0,
    "screenId": 0,
    "sceneType": 0,
    "moduleType": 0,
    "templateType": 0,
    "locked": 0
}'

返回响应

🟢200成功

application/json

Body

code

integer

响应码

必需

message

string

响应消息内容

必需

data

array [object {4}]

图层数据

必需

templateId

number

使用的模板唯一ID

必需

screenId

string

必需

模板应用的屏幕唯一ID

sceneType

string

必需

模板应用屏幕的sceneType,同于图层中sceneType字段定义

position

array [object {2}]

必需

示例

{
    "code": 0,
    "message": "string",
    "data": [
        {
            "templateId": 0,
            "screenId": "string",
            "sceneType": "string",
            "position": [
                {
                    "window": {
                        "width": 0,
                        "height": 0,
                        "x": 0,
                        "y": 0
                    },
                    "source": {
                        "general": {
                            "sourceId": 0,
                            "sourceType": 0,
                            "connectorType": 0,
                            "sourceName": "string",
                            "connectCapacityNum": 0
                        }
                    }
                }
            ]
        }
    ]
}