创建 | 编辑
接口地址:/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": ""
}
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
tkDeviceScriptDTO | TkDeviceScriptDTO | body | true | TkDeviceScriptDTO |
convertJs | 解析脚本方法体内容 | false | string | |
createTime | 创建时间 | false | string(date-time) | |
creator | 创建用户 | false | string | |
dataType | 脚本编数据编码类型:HEX ASCII,可用值:ASCII,HEX,JSON | false | string | |
description | 脚本描述 | false | string | |
id | ID | false | string | |
name | 解析脚本名称 | false | string | |
saveOriginalData | 保存原始数据:默认false | false | boolean | |
status | 状态:0禁用 1启用 | false | integer(int32) | |
tenantId | 租户ID | false | string | |
updateTime | 更新时间 | false | string(date-time) | |
updater | 更新用户 | false | string |
响应参数:
参数名称 | 参数说明 | 类型 |
convertJs | 解析脚本方法体内容 | string |
createTime | 创建时间 | string(date-time) |
creator | 创建用户 | string |
dataType | 脚本编数据编码类型:HEX ASCII,可用值:ASCII,HEX,JSON | string |
description | 脚本描述 | string |
id | ID | string |
name | 解析脚本名称 | string |
saveOriginalData | 保存原始数据:默认false | boolean |
status | 状态:0禁用 1启用 | integer(int32) |
tenantId | 租户ID | string |
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": ""
}
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
deleteDTO | DeleteDTO | body | true | DeleteDTO |
ids | 删除ID列表 | true | array | |
tenantId | 租户ID | false | string |
选项列表
接口地址:/api/yt/js/me/list
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
请求参数:
暂无
响应参数:
参数名称 | 参数说明 | 类型 | schema |
body | object | ||
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_NEGOTIATES | string | |
statusCodeValue | integer(int32) | integer(int32) |
响应示例:
{
"body": {},
"statusCode": "",
"statusCodeValue": 0
}
测试脚本执行结果
接口地址:/api/yt/js/test
请求方式:POST
请求数据类型:application/x-www-form-urlencoded,application/json
响应数据类型:*/*
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
jsonNode | JsonNode | body | true | JsonNode |
响应参数:
暂无
响应示例:
null
详情
接口地址:/api/yt/js/{id}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
id | id | path | true | string |
响应参数:
参数名称 | 参数说明 | 类型 |
convertJs | 解析脚本方法体内容 | string |
createTime | 创建时间 | string(date-time) |
creator | 创建用户 | string |
dataType | 脚本编数据编码类型:HEX ASCII,可用值:ASCII,HEX,JSON | string |
description | 脚本描述 | string |
id | ID | string |
name | 解析脚本名称 | string |
saveOriginalData | 保存原始数据:默认false | boolean |
status | 状态:0禁用 1启用 | integer(int32) |
tenantId | 租户ID | string |
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
响应数据类型:*/*
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
id | id | path | true | string |
status | status | path | true | integer(int32) |
分页查询
接口地址:/api/yt/js{?endTime,name,orderFiled,orderType,page,pageSize,startTime}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
请求参数:
参数名称 | 参数说明 | 是否必须 | 数据类型 |
page | page | true | int |
pageSize | pageSize | true | int |
orderFiled | orderFiled | false | string |
orderType | orderType,可用值:ASC,DESC | false | string |
name | name | false | string |
startTime | startTime | false | integer(int64) |
endTime | endTime | false | integer(int64) |
响应参数:
参数名称 | 参数说明 | 类型 |
items | array | |
convertJs | 解析脚本方法体内容 | string |
createTime | 创建时间 | string(date-time) |
creator | 创建用户 | string |
dataType | 脚本编数据编码类型:HEX ASCII,可用值:ASCII,HEX,JSON | string |
description | 脚本描述 | string |
id | ID | string |
name | 解析脚本名称 | string |
saveOriginalData | 保存原始数据:默认false | boolean |
status | 状态:0禁用 1启用 | integer(int32) |
tenantId | 租户ID | string |
updateTime | 更新时间 | string(date-time) |
updater | 更新用户 | string |
total | integer(int32) |
响应示例:
{
"items": [
{
"convertJs": "",
"createTime": "",
"creator": "",
"dataType": "",
"description": "",
"id": "",
"name": "",
"saveOriginalData": false,
"status": 0,
"tenantId": "",
"updateTime": "",
"updater": ""
}
],
"total": 0
}