Logo码如云文档中心

码如云官网 进入后台
通过自定义编号更新实例基本信息

通过自定义编号更新实例基本信息 #

功能描述 #

通过自定义编号更新实例的基本信息,对应编辑实例基本信息

调用方式 #

调用选项选项内容
HTTP方法PUT
URL路径https://api.mryqr.com/integration/apps/{appId}/qrs/custom/{customId}/base-setting
正常返回状态码200

URL参数 #

参数解释
appId应用ID
customId实例的自定义编号,有关实例自定义编号的内容,请参考编辑实例基本信息新建实例(高级方式)API

请求体 #

{
    "name": "XXX设备",
    "description": "",
    "headerImageUrl": "https://files.your-domain.com/HnDUnO77yQ/sUYb8fwoH6/abc.png",
    "directAttributeValues": {
        "a_-f2mSI9_Samzw7FNYJDw9A": "hello"
    },
    "geolocation": {
        "point": {
            "longitude": 114.94429,
            "latitude": 48.260643
        },
        "address": {
            "province": "江苏省",
            "city": "连云港市",
            "district": "灌南县",
            "address": "详细街道地址"
        },
        "note": null
    },
    "customId": "aFG1FFESTM6p6U52lOGnqQ"
}

请求体字段定义 #

字段解释必填备注
name实例名称最长50个字符
description实例简介,在实例首页中,实例简介将显示在实例名称的下方最长50000个字符
headerImageUrl实例首页图片的URL
directAttributeValues直接填入值类型的自定义属性值key为自定义属性的ID,value为填入值
geolocation实例定位信息,Geolocation类型
customId实例的自定义编号最长50个字符

返回体 #