Logo码如云文档中心

码如云官网 进入后台
附件一:自定义属性值类型定义

附件一:自定义属性值类型定义 #

自定义属性表示针对具体的业务场景而定义的实例属性项,具体详情请参考自定义属性

属性类型规定了其属性值的计算方式,属性值包含公共字段特定字段,其中公共字段表示所有类型的属性值均拥有的字段,而特定字段是特定于某种属性值类型才有的字段。

公共字段 #

所有属性值均包含以下公共字段:

{
  "attributeId": "a_xXGX7JjHSxmJklhSfEOOCg",
  "attributeType": "INSTANCE_NAME",
  "valueType":" "TEXT_VALUE",
  ......
}

字段含义:

字段 解释
attributeIdattributeId 属性ID
attributeType 属性类型
valueType 属性值类型

其中,valueTypeattributeType存在一对多的关系,即多种属性类型所计算出同一种属性值类型。在实际集成对接中,客户方应该以valueType来区分属性值的类型。

除了公共字段外,每种属性值还包含了特定于该类属性值的特定字段,以下列出了各种属性值所包含的特定字段:

单行文本 #

{
  "attributeId": "a_sYq7sMVoTeSxw06t4OXHhg",
  "attributeType": "INSTANCE_NAME",
  "valueType":" "TEXT_VALUE",
  "text": "some text"
}

字段含义:

字段 解释
text 文本内容

多行文本 #

{
  "attributeId": "a_JaO_Q4AyTt2FaVXKIqgtRw",
  "attributeType": "CONTROL_LAST",
  "valueType":" "MULTI_LINE_TEXT_VALUE",
  "content": "some content"
}

字段含义:

字段 解释
content 文本内容

时间戳 #

{
  "attributeId": "a_qtYSSiElTouwwyAOHSHyOA",
  "attributeType": "INSTANCE_CREATE_TIME",
  "valueType":" "TIMESTAMP_VALUE",
  "timestamp": "1667887565032"
}

字段含义:

字段 解释
timestamp 时间戳,格式为Epoch的毫秒数,即自1970年1月1日(UTC/GMT的午夜)开始所经过的毫秒数

本地日期 #

{
  "attributeId": "a_tMA0c95_SH-6mLwc_zZtzg",
  "attributeType": "CONTROL_LAST",
  "valueType":" "LOCAL_DATE_VALUE",
  "date": "2023-04-05"
}

字段含义:

字段 解释
date 日期

本地时间 #

{
  "attributeId": "a_yr4tFcA9R0ucpsIT4CO9yw",
  "attributeType": "CONTROL_LAST",
  "valueType":" "LOCAL_TIME_VALUE",
  "time": "10:12"
}

字段含义:

字段 解释
time 时间

双精度数值 #

{
  "attributeId": "a__8z4JaR6SIGzmBuqX34eqA",
  "attributeType": "CONTROL_LAST",
  "valueType":" "DOUBLE_VALUE",
  "number": 100.1
}

字段含义:

字段 解释
number 数值

整数数值 #

{
  "attributeId": "a_uaRhNUTvTymhcKEdhst0dQ",
  "attributeType": "INSTANCE_ACCESS_COUNT",
  "valueType":" "INTEGER_VALUE",
  "number": 100
}

字段含义:

字段 解释
number 数值

点检结果 #

{
  "attributeId": "a__IEMZNMBSy2tFgf0-O6Rrw",
  "attributeType": "CONTROL_LAST",
  "valueType":" "POINT_CHECK_VALUE",
  "pass": true
}

字段含义:

字段 解释
pass 点检是否通过

手机号 #

{
  "attributeId": "a_o6jk80kjRYqOUDXIIiZk_g",
  "attributeType": "CONTROL_LAST",
  "valueType":" "MOBILE_VALUE",
  "mobile": "18364756453"
}

字段含义:

字段 解释
mobile 手机号码

邮箱地址 #

{
  "attributeId": "a_aZ1e0LqKR-S_zI1-4av_tw",
  "attributeType": "CONTROL_LAST",
  "valueType":" "EMAIL_VALUE",
  "email": "some@somedomain.com"
}

字段含义:

字段 解释
email 邮箱

编号标识 #

{
  "attributeId": "a_o6jk80kjRYqOUDXIIiZk_g",
  "attributeType": "CONTROL_LAST",
  "valueType":" "IDENTIFIER_VALUE",
  "content": "abcd"
}

字段含义:

字段 解释
content 编号标识的内容

地址 #

{
  "attributeId": "a_p6YtHmgFTmKkUHGz1fxrQA",
  "attributeType": "CONTROL_LAST",
  "valueType":" "ADDRESS_VALUE",
  "address": {
    "province": "安徽省",
    "city": "淮北市",
    "district": "杜集区",
    "address": "街道地址"
  }
}

字段含义:

字段 解释
address 地址信息,Address类型

定位 #

{
  "attributeId": "a_is_NDAR-Tcew-hprVL-4SA",
  "attributeType": "CONTROL_LAST",
  "valueType":" "GEOLOCATION_VALUE",
  "geolocation": {
        "point": {
            "longitude": 114.94429,
            "latitude": 48.260643
        },
        "address": {
            "province": "江苏省",
            "city": "连云港市",
            "district": "灌南县",
            "address": "详细街道地址"
        },
        "note": null
    }
}
字段 解释
geolocation 定位信息,Geolocation类型

分组 #

{
  "attributeId": "a_Sx7CQq8WS7SQELJevlP3-Q",
  "attributeType": "INSTANCE_GROUP",
  "valueType":" "GROUP_VALUE",
  "groupId": "GRP370517025530840064"
}

字段含义:

字段 解释
groupId 分组ID

成员 #

{
  "attributeId": "a_vmBapIhoQ9mdFyq3dAw3jg",
  "attributeType": "INSTANCE_CREATOR",
  "valueType":" "MEMBER_VALUE",
  "memberId": "MBR377684921235276800"
}

字段含义:

字段 解释
memberId 成员ID

成员+手机号 #

{
  "attributeId": "a_8wpMutXZSBSnau44bpsRmQ",
  "attributeType": "INSTANCE_CREATOR",
  "valueType":" "INSTANCE_CREATOR_AND_MOBILE",
  "memberId": "MBR377684921235276800"
}

字段含义:

字段 解释
memberId 成员ID

成员+邮箱 #

{
  "attributeId": "a_vrWzdPU3RjuZkJH-qFZV4A",
  "attributeType": "INSTANCE_CREATOR_AND_EMAIL",
  "valueType":" "MEMBER_EMAIL_VALUE",
  "memberId": "MBR377684921235276800"
}

字段含义:

字段 解释
memberId 成员ID

成员数组 #

{
  "attributeId": "a_xgUHy30dR5qcrWJnU5xOMw",
  "attributeType": "INSTANCE_GROUP_MANAGERS",
  "valueType":" "MEMBERS_VALUE",
  "memberIds": ["MBR377684921235276800"]
}

字段含义:

字段 解释
memberIds 成员ID数组

成员+手机号数组 #

{
  "attributeId": "a_xD9nxeIBQ42hc2ibbTm6dA",
  "attributeType": "INSTANCE_GROUP_MANAGERS_AND_MOBILE",
  "valueType":" "MEMBERS_MOBILE_VALUE",
  "memberIds": ["MBR377684921235276800"]
}

字段含义:

字段 解释
memberIds 成员ID数组

成员+邮箱数组 #

{
  "attributeId": "a_e8vXzlzMSyCLt6dkMfTqVQ",
  "attributeType": "INSTANCE_GROUP_MANAGERS_AND_EMAIL",
  "valueType":" "MEMBERS_EMAIL_VALUE",
  "memberIds": ["MBR377684921235276800"]
}

字段含义:

字段 解释
memberIds 成员ID数组

单选框 #

{
  "attributeId": "a_7tys_4s0RVGwh2FgISHLrA",
  "attributeType": "CONTROL_LAST",
  "valueType":" "RADIO_VALUE",
  "controlId": "c_-y-6h-15Sp6apr0GiSVV5g",
  "optionId": "pf2B_GwFRvKzXnOsQeh0lQ"
}

字段含义:

字段 解释
controlId 属性值所引用的控件ID
optionId 属性值所引用的控件选项ID

多选框 #

{
  "attributeId": "a_LAJ6oL6_QM2jAKDdnX2Qag",
  "attributeType": "CONTROL_LAST",
  "valueType":" "CHECKBOX_VALUE",
  "controlId": "c_XvCXofeJRzaPDLdRhLuf6g",
  "optionIds": ["fDu-aX6xST6lJPYkPoZS0w"]
}

字段含义:

字段 解释
controlId 属性值所引用的控件ID
optionIds 属性值所引用的控件选项ID数组

下拉框 #

{
  "attributeId": "a_W5E999KeQ7-XMKsa2LgysQ",
  "attributeType": "CONTROL_LAST",
  "valueType":" "DROPDOWN_VALUE",
  "controlId": "c_q4lwaVsSQz6WQrtEBwdTvg",
  "optionIds": ["SDfS1xhmRJ2r9ccukMUa0Q"]
}

字段含义:

字段 解释
controlId 属性值所引用的控件ID
optionIds 属性值所引用的控件选项ID数组

物品状态 #

{
  "attributeId": "a_XHkQ2TdcRqWY9ypvfcL4Pg",
  "attributeType": "CONTROL_LAST",
  "valueType":" "ITEM_STATUS_VALUE",
  "controlId": "c_m8EAc5qWRFiVIk3VbJyNOA",
  "optionId": "RWsJbdGROakQTrxgINnQQ"
}

字段含义:

字段 解释
controlId 属性值所引用的控件ID
optionId 属性值所引用的控件选项ID

物品明细 #

{
  "attributeId": "a_7JboGozMTWq__L06UAbPtg",
  "attributeType": "CONTROL_LAST",
  "valueType":" "ITEM_COUNT_VALUE",
  "controlId": "c_Yu-EZ8rIQJmSQxXba3ngBA",
  "items": [
     {
         "id": "hbd-nFCcSQCtlF2Z1HsAGg",
         "optionId": "RqEAIWQYToSakCliCxITYw",
         "number": 2
     }
  ]
}

字段含义:

字段 解释
controlId 属性值所引用的控件ID
items 物品明细项数组
items[].id 物品明细项ID
items[].optionId 物品明细项的选项ID
items[].number 物品明细项的数量

文件 #

{
  "attributeId": "a_9pOcRcZ8Sye-gtknmm1cXQ",
  "attributeType": "CONTROL_LAST",
  "valueType":" "FILES_VALUE",
  "files": [
    {
      "id": "epioNjCVezCqcGqtqWue8N",
      "name": "xuKW567F9xfZmgGpYiRrcz.jpeg",
      "type": "image/jpeg",
      "fileUrl": "https://files.mryqr.com/TNT369363343011480576/APP369363402021143552/QRC371852660661289984/_QR_MANAGE/2023-05-23/xuKW567F9xfZmgGpYiRrcz.jpeg",
      "ossKey": "TNT369363343011480576/APP369363402021143552/QRC371852660661289984/_QR_MANAGE/2023-05-23/xuKW567F9xfZmgGpYiRrcz.jpeg"
    }
  ]
}

字段含义:

字段 解释
files 文件信息,UploadedFile数组

图片 #

{
  "attributeId": "a_RV85lZbTSpiRUKeVlKGiaQ",
  "attributeType": "CONTROL_LAST",
  "valueType":" "IMAGES_VALUE",
  "images": [
    {
      "id": "epioNjCVezCqcGqtqWue8N",
      "name": "xuKW567F9xfZmgGpYiRrcz.jpeg",
      "type": "image/jpeg",
      "fileUrl": "https://files.mryqr.com/TNT369363343011480576/APP369363402021143552/QRC371852660661289984/_QR_MANAGE/2023-05-23/xuKW567F9xfZmgGpYiRrcz.jpeg",
      "ossKey": "TNT369363343011480576/APP369363402021143552/QRC371852660661289984/_QR_MANAGE/2023-05-23/xuKW567F9xfZmgGpYiRrcz.jpeg"
    }
  ]
}

字段含义:

字段 解释
images 图片信息,UploadedFile数组

签名 #

{
  "attributeId": "a_WbO4itriQQKaGmqzc0ZU4A",
  "attributeType": "CONTROL_LAST",
  "valueType":" "SIGNATURE_VALUE",
  "signature": {
      "id": "epioNjCVezCqcGqtqWue8N",
      "name": "xuKW567F9xfZmgGpYiRrcz.jpeg",
      "type": "image/jpeg",
      "fileUrl": "https://files.mryqr.com/TNT369363343011480576/APP369363402021143552/QRC371852660661289984/_QR_MANAGE/2023-05-23/xuKW567F9xfZmgGpYiRrcz.jpeg",
      "ossKey": "TNT369363343011480576/APP369363402021143552/QRC371852660661289984/_QR_MANAGE/2023-05-23/xuKW567F9xfZmgGpYiRrcz.jpeg"
  }
}

字段含义:

字段 解释
signature 签名信息,UploadedFile类型

多级下拉 #

{
  "attributeId": "a_sPpRVvGdSQ-BpmNMUNTsDQ",
  "attributeType": "CONTROL_LAST",
  "valueType":" "MULTI_LEVEL_SELECTION_VALUE",
  "selection": {
    "level1": "广东省",
    "level2": "深圳市",
    "level3": "坂田区"
  }
}

字段含义:

字段 解释
selection 所选数据
selection.level1 第一级数据
selection.level2 第二级数据
selection.level3 第三级数据

布尔值 #

{
  "attributeId": "a_Aqf7dgolR5ma1f1EFMM6Fg",
  "attributeType": "INSTANCE_ACTIVE_STATUS",
  "valueType":" "BOOLEAN_VALUE",
  "yes": true
}

字段含义:

字段 解释
yes 是否为真