ThingsKit物联网平台API文档-规则引擎(TCP转换脚本)

创建 | 编辑

接口地址:/api/yt/js

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

请求示例:

{
  "convertJs": "",
  "createTime": "",
  "creator": "",
  "dataType": "",
  "description": "",
  "id": "",
  "name": "",
  "saveOriginalData": false,
  "status": 0,
  "tenantId": "",
  "updateTime": "",
  "updater": ""
}

请求参数:

参数名称参数说明请求类型是否必须数据类型
tkDeviceScriptDTOTkDeviceScriptDTObodytrueTkDeviceScriptDTO
convertJs解析脚本方法体内容falsestring
createTime创建时间falsestring(date-time)
creator创建用户falsestring
dataType脚本编数据编码类型:HEX ASCII,可用值:ASCII,HEX,JSONfalsestring
description脚本描述falsestring
idIDfalsestring
name解析脚本名称falsestring
saveOriginalData保存原始数据:默认falsefalseboolean
status状态:0禁用 1启用falseinteger(int32)
tenantId租户IDfalsestring
updateTime更新时间falsestring(date-time)
updater更新用户falsestring

响应参数:

参数名称参数说明类型
convertJs解析脚本方法体内容string
createTime创建时间string(date-time)
creator创建用户string
dataType脚本编数据编码类型:HEX ASCII,可用值:ASCII,HEX,JSONstring
description脚本描述string
idIDstring
name解析脚本名称string
saveOriginalData保存原始数据:默认falseboolean
status状态:0禁用 1启用integer(int32)
tenantId租户IDstring
updateTime更新时间string(date-time)
updater更新用户string

响应示例:

{
	"convertJs": "",
	"createTime": "",
	"creator": "",
	"dataType": "",
	"description": "",
	"id": "",
	"name": "",
	"saveOriginalData": false,
	"status": 0,
	"tenantId": "",
	"updateTime": "",
	"updater": ""
}

删除

接口地址:/api/yt/js

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

请求示例:

{
  "ids": [],
  "tenantId": ""
}

请求参数:

参数名称参数说明请求类型是否必须数据类型
deleteDTODeleteDTObodytrueDeleteDTO
ids删除ID列表truearray
tenantId租户IDfalsestring

选项列表

接口地址:/api/yt/js/me/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

请求参数:

暂无

响应参数:

参数名称参数说明类型schema
bodyobject
statusCode可用值:ACCEPTED,ALREADY_REPORTED,BAD_GATEWAY,BAD_REQUEST,BANDWIDTH_LIMIT_EXCEEDED,CHECKPOINT,CONFLICT,CONTINUE,CREATED,DESTINATION_LOCKED,EXPECTATION_FAILED,FAILED_DEPENDENCY,FORBIDDEN,FOUND,GATEWAY_TIMEOUT,GONE,HTTP_VERSION_NOT_SUPPORTED,IM_USED,INSUFFICIENT_SPACE_ON_RESOURCE,INSUFFICIENT_STORAGE,INTERNAL_SERVER_ERROR,I_AM_A_TEAPOT,LENGTH_REQUIRED,LOCKED,LOOP_DETECTED,METHOD_FAILURE,METHOD_NOT_ALLOWED,MOVED_PERMANENTLY,MOVED_TEMPORARILY,MULTIPLE_CHOICES,MULTI_STATUS,NETWORK_AUTHENTICATION_REQUIRED,NON_AUTHORITATIVE_INFORMATION,NOT_ACCEPTABLE,NOT_EXTENDED,NOT_FOUND,NOT_IMPLEMENTED,NOT_MODIFIED,NO_CONTENT,OK,PARTIAL_CONTENT,PAYLOAD_TOO_LARGE,PAYMENT_REQUIRED,PERMANENT_REDIRECT,PRECONDITION_FAILED,PRECONDITION_REQUIRED,PROCESSING,PROXY_AUTHENTICATION_REQUIRED,REQUESTED_RANGE_NOT_SATISFIABLE,REQUEST_ENTITY_TOO_LARGE,REQUEST_HEADER_FIELDS_TOO_LARGE,REQUEST_TIMEOUT,REQUEST_URI_TOO_LONG,RESET_CONTENT,SEE_OTHER,SERVICE_UNAVAILABLE,SWITCHING_PROTOCOLS,TEMPORARY_REDIRECT,TOO_EARLY,TOO_MANY_REQUESTS,UNAUTHORIZED,UNAVAILABLE_FOR_LEGAL_REASONS,UNPROCESSABLE_ENTITY,UNSUPPORTED_MEDIA_TYPE,UPGRADE_REQUIRED,URI_TOO_LONG,USE_PROXY,VARIANT_ALSO_NEGOTIATESstring
statusCodeValueinteger(int32)integer(int32)

响应示例:

{
	"body": {},
	"statusCode": "",
	"statusCodeValue": 0
}

测试脚本执行结果

接口地址:/api/yt/js/test

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

请求参数:

参数名称参数说明请求类型是否必须数据类型
jsonNodeJsonNodebodytrueJsonNode

响应参数:

暂无

响应示例:

null

详情

接口地址:/api/yt/js/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

请求参数:

参数名称参数说明请求类型是否必须数据类型
ididpathtruestring

响应参数:

参数名称参数说明类型
convertJs解析脚本方法体内容string
createTime创建时间string(date-time)
creator创建用户string
dataType脚本编数据编码类型:HEX ASCII,可用值:ASCII,HEX,JSONstring
description脚本描述string
idIDstring
name解析脚本名称string
saveOriginalData保存原始数据:默认falseboolean
status状态:0禁用 1启用integer(int32)
tenantId租户IDstring
updateTime更新时间string(date-time)
updater更新用户string

响应示例:

{
	"convertJs": "",
	"createTime": "",
	"creator": "",
	"dataType": "",
	"description": "",
	"id": "",
	"name": "",
	"saveOriginalData": false,
	"status": 0,
	"tenantId": "",
	"updateTime": "",
	"updater": ""
}

修改脚本状态

接口地址:/api/yt/js/{id}/{status}

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

请求参数:

参数名称参数说明请求类型是否必须数据类型
ididpathtruestring
statusstatuspathtrueinteger(int32)

分页查询

接口地址:/api/yt/js{?endTime,name,orderFiled,orderType,page,pageSize,startTime}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

请求参数:

参数名称参数说明是否必须数据类型
pagepagetrueint
pageSizepageSizetrueint
orderFiledorderFiledfalsestring
orderTypeorderType,可用值:ASC,DESCfalsestring
namenamefalsestring
startTimestartTimefalseinteger(int64)
endTimeendTimefalseinteger(int64)

响应参数:

参数名称参数说明类型
itemsarray
convertJs解析脚本方法体内容string
createTime创建时间string(date-time)
creator创建用户string
dataType脚本编数据编码类型:HEX ASCII,可用值:ASCII,HEX,JSONstring
description脚本描述string
idIDstring
name解析脚本名称string
saveOriginalData保存原始数据:默认falseboolean
status状态:0禁用 1启用integer(int32)
tenantId租户IDstring
updateTime更新时间string(date-time)
updater更新用户string
totalinteger(int32)

响应示例:

{
	"items": [
		{
			"convertJs": "",
			"createTime": "",
			"creator": "",
			"dataType": "",
			"description": "",
			"id": "",
			"name": "",
			"saveOriginalData": false,
			"status": 0,
			"tenantId": "",
			"updateTime": "",
			"updater": ""
		}
	],
	"total": 0
}