Logo码如云文档中心

码如云官网 进入后台
通过自定义编号获取实例详情

通过自定义编号获取实例详情 #

功能描述 #

通过自定义编号获取某个实例的详情信息。

调用方式 #

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

URL参数 #

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

请求体 #

返回体 #

{
    "id": "QRC377684928629834752",
    "name": "XXX设备",
    "plateId": "MRY377684928629834753",
    "appId": "APP377684927816139776",
    "groupId": "GRP377684927832916993",
    "template": false,
    "headerImage": null,
    "description": null,
    "attributeValues": {
        "a_lSCbmzDSTP-D6Qw2HWi6_A": {
            "attributeId": "a_lSCbmzDSTP-D6Qw2HWi6_A",
            "attributeType": "INSTANCE_CREATOR",
            "valueType": "MEMBER_VALUE",
            "memberId": "MBR377684921235276800"
        }
    },
    "accessCount": 0,
    "lastAccessedAt": null,
    "geolocation": null,
    "customId": null,
    "createdAt": 1667887565032,
    "createdBy": "MBR377684921235276800",
    "active": true
}

返回体字段定义 #

字段 解释
id 实例ID
name 实例名称
plateId 实例的码牌编号
appId 应用ID
groupId 实例所在分组的ID
template 实例是否为模板
headerImage 实例首页图片,UploadedFile类型
description 实例简介
attributeValues 自定义属性值的数组
accessCount 实例被访问的次数
lastAccessedAt 实例上次被访问的时间,格式为Epoch的毫秒数,即自1970年1月1日(UTC/GMT的午夜)开始所经过的毫秒数
geolocation 实例定位信息,格式为Geolocation类型
customId 实例的自定义编号,可通过编辑实例基本信息或调用新建实例(高级方式)API进行设置
createdAt 实例创建时间,格式为Epoch的毫秒数,即自1970年1月1日(UTC/GMT的午夜)开始所经过的毫秒数
createdBy 实例创建者的成员ID
active 实例是否启用,关于实例的启用与禁用请参考实例管理