获取协议脚本设备列表
POST
/api/v1/things/protocol/script/device/index
things/protocol/script/devicethingsProtocolScriptDevice
请求参数
Header 参数
Ithings-Project-Id
string
可选
默认值:
{{Ithings-Project-Id}}
Ithings-Token
string
可选
默认值:
{{iThings-token}}
app-code
string
可选
默认值:
{{appCode}}
device-id
string
可选
Body 参数application/json
page
object (PageInfo)
可选
page
integer <int64>
页码
size
integer <int64>
每页大小
orders
array[object (OrderBy) {2}]
排序
triggerSrc
integer <int64>
可选
productID
string
可选
deviceName
string
可选
status
integer <int64>
状态:是否启用
scriptID
string
可选
withScript
boolean
可选
withDevice
boolean
可选
示例
{
"page": {
"page": 0,
"size": 0,
"orders": [
{
"field": "string",
"sort": 0
}
]
},
"triggerSrc": 0,
"productID": "string",
"deviceName": "string",
"status": 0,
"scriptID": "string",
"withScript": true,
"withDevice": true
}示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/v1/things/protocol/script/device/index' \
--header 'Ithings-Project-Id: {{Ithings-Project-Id}}' \
--header 'Ithings-Token: {{iThings-token}}' \
--header 'app-code: {{appCode}}' \
--header 'device-id;' \
--header 'Content-Type: application/json' \
--data-raw '{
"page": {
"page": 0,
"size": 0,
"orders": [
{
"field": "string",
"sort": 0
}
]
},
"triggerSrc": 0,
"productID": "string",
"deviceName": "string",
"status": 0,
"scriptID": "string",
"withScript": true,
"withDevice": true
}'返回响应
🟢200成功
application/json
Body
code
integer
返回code
默认值:
200
msg
string
返回的消息
data
object (ProtocolScriptDeviceIndexResp)
可选
list
array[object (ProtocolScriptDevice) {11}]
自定义协议信息
total
integer <int64>
拥有的总数
示例
{
"code": "200",
"msg": "string",
"data": {
"list": [
{
"id": "string",
"triggerSrc": 0,
"productID": "string",
"deviceName": "string",
"scriptID": 0,
"priority": 0,
"status": 0,
"createdTime": 0,
"script": {
"id": "string",
"name": "string",
"desc": "string",
"triggerDir": 0,
"triggerTimer": 0,
"triggerHandle": "string",
"triggerType": "string",
"script": "string",
"status": 0,
"createdTime": 0
},
"product": {
"createdTime": "string",
"productID": "string",
"productName": "string",
"productImg": "string",
"isUpdateProductImg": true,
"authMode": 2,
"deviceType": 4,
"deviceSchemaMode": 4,
"categoryID": 0,
"netType": 10,
"protocolCode": "string",
"subProtocolCode": "string",
"autoRegister": 3,
"secret": "string",
"trialTime": "string",
"desc": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"sceneMode": "string",
"status": 0,
"bindLevel": 0,
"protocolConf": [
{
"key": "string",
"value": "string"
}
],
"subProtocolConf": [
{
"key": "string",
"value": "string"
}
],
"protocol": {
"id": 0,
"name": "string",
"code": "string",
"type": "string",
"transProtocol": "string",
"desc": "string",
"endpoints": [
"string"
],
"etcdKey": "string",
"isEnableSyncProduct": 0,
"isEnableSyncDevice": 0,
"configFields": [
{
"id": 0,
"group": "string",
"key": "string",
"label": "string",
"isRequired": true,
"sort": 0
}
],
"configInfos": [
{
"id": 0,
"config": {},
"desc": "string"
}
],
"productFields": [
{
"id": 0,
"group": "string",
"key": "string",
"label": "string",
"isRequired": true,
"sort": 0
}
],
"deviceFields": [
{
"id": 0,
"group": "string",
"key": "string",
"label": "string",
"isRequired": true,
"sort": 0
}
]
},
"category": {
"id": 0,
"parentID": 0,
"idPath": [
0
],
"name": "string",
"desc": "string",
"headImg": "string",
"isUpdateHeadImg": true,
"isLeaf": 0,
"deviceCount": 0,
"children": [
{}
]
},
"config": {
"productID": "string",
"devInit": {
"tenantCode": "string",
"projectID": "string",
"areaID": "string",
"deptID": "string"
}
},
"customUi": {}
},
"device": {
"id": 0,
"tenantCode": "string",
"productID": "string",
"projectID": "string",
"productName": "string",
"deviceType": 0,
"productImg": "string",
"areaID": "string",
"deviceName": "string",
"deviceAlias": "string",
"secret": "string",
"cert": "string",
"imei": "string",
"mac": "string",
"categoryID": 0,
"version": "string",
"hardInfo": "string",
"softInfo": "string",
"mobileOperator": 10,
"phone": "string",
"iccid": "string",
"position": {
"longitude": 180,
"latitude": 90
},
"address": "string",
"adcode": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"schemaAlias": {},
"isOnline": 2,
"firstLogin": "string",
"firstBind": "string",
"lastBind": "string",
"lastLogin": "string",
"expTime": "string",
"logLevel": 5,
"rssi": 0,
"createdTime": "string",
"status": 0,
"isEnable": 0,
"withProperties": {},
"protocolConf": [
{
"key": "string",
"value": "string"
}
],
"subProtocolConf": [
{
"key": "string",
"value": "string"
}
],
"profiles": {},
"owner": {
"userID": "string",
"userName": "string",
"email": "string",
"phone": "string",
"lastIP": "string",
"regIP": "string",
"nickName": "string",
"headImg": "string",
"createdTime": "string"
},
"ratedPower": 0,
"netType": 10,
"needConfirmVersion": "string",
"userID": "string",
"lastIp": "string",
"sort": 0,
"deviceImg": "string",
"isUpdateDeviceImg": true,
"file": "string",
"isUpdateFile": true,
"desc": "string",
"distributor": {
"id": 0,
"idPath": "string"
},
"gateway": {},
"area": {
"projectID": "string",
"areaID": "string",
"areaName": "string"
},
"groups": [
{
"id": 0,
"parentID": 0,
"name": "string",
"purpose": "string"
}
],
"groupPurpose": "string",
"groupIDs": [
"string"
]
}
}
],
"total": 0
}
}