开发者中心
目录

应用开发●API接口●策略API

查询单个策略

请求方式及地址

   GET 
   http://api.nlecloud.com/Strategys

URL请求参数

参数类型描述其它
strategyId integer Required

响应参数

参数类型描述其它
ResultObj StrategyAddDTO
Status ResultStatus 返回状态
StatusCode integer 返回的状态码
Msg string 返回的消息
ErrorObj Object

响应示例

{
  "ResultObj": {
    "StrategyId": 1,
    "GatewayID": 2,
    "GatewayName": "sample string 3",
    "Kind": 64,
    "Condition": "sample string 5",
    "ConditionCn": "sample string 6",
    "StrategyVariableList": [
      {
        "GatewayDeviceName": "sample string 1",
        "Operator": 1,
        "AndOr": 1,
        "Kind": 0,
        "BracketsStart": "sample string 2",
        "BracketsEnd": "sample string 3",
        "StrategyVariableID": 4,
        "StrategyId": 5,
        "GatewayID": 1,
        "GatewayDeviceID": 1,
        "RightValue": "sample string 7"
      },
      {
        "GatewayDeviceName": "sample string 1",
        "Operator": 1,
        "AndOr": 1,
        "Kind": 0,
        "BracketsStart": "sample string 2",
        "BracketsEnd": "sample string 3",
        "StrategyVariableID": 4,
        "StrategyId": 5,
        "GatewayID": 1,
        "GatewayDeviceID": 1,
        "RightValue": "sample string 7"
      }
    ],
    "StrategyActionList": [
      {
        "GatewayDeviceName": "sample string 1",
        "ActionID": 2,
        "StrategyId": 1,
        "GatewayDeviceID": 1,
        "SetValue": "sample string 3",
        "Delay": 4
      },
      {
        "GatewayDeviceName": "sample string 1",
        "ActionID": 2,
        "StrategyId": 1,
        "GatewayDeviceID": 1,
        "SetValue": "sample string 3",
        "Delay": 4
      }
    ],
    "StrategyRunTimeList": [
      {
        "Period": 1,
        "RunTimeID": 1,
        "StrategyId": 1,
        "Day": 1,
        "Time": "2024-04-19T02:08:21.0404162+08:00"
      },
      {
        "Period": 1,
        "RunTimeID": 1,
        "StrategyId": 1,
        "Day": 1,
        "Time": "2024-04-19T02:08:21.0404162+08:00"
      }
    ],
    "CreateUserID": 7,
    "ProjectId": 8,
    "ReturnUrl": "sample string 9",
    "DataToken": "sample string 10"
  },
  "Status": 0,
  "StatusCode": 1,
  "Msg": "sample string 2",
  "ErrorObj": {}
}

查询策略

请求方式及地址

   GET 
   http://api.nlecloud.com/Strategys

URL请求参数

参数类型描述其它
ProjectID integer 项目ID（必须）
DeviceID integer 设备ID（可选）
Kind byte 类型（可选） 1：设备控制 2：邮件上报
Nullity integer 状态（可选） 0：启用 1：禁用
PageSize integer 指定每页要显示的数据个数，默认20，最多100
StartDate string 起始时间（可选，包括当天，格式YYYY-MM-DD）
EndDate string 结束时间（可选，包括当天，格式YYYY-MM-DD）
PageIndex integer 指定页码

响应参数

参数类型描述其它
ResultObj ListPagerSetOfStrategyListDTO
Status ResultStatus 返回状态
StatusCode integer 返回的状态码
Msg string 返回的消息
ErrorObj Object

响应示例

{
  "ResultObj": {
    "PageSet": [
      {
        "NullityCN": 0,
        "GatewayName": "sample string 1",
        "GatewayKind": 64,
        "GatewayKindCn": "sample string 3",
        "GatewayTag": "sample string 4",
        "GatewayNullity": true,
        "Telphone": "sample string 6",
        "CollegeName": "sample string 7",
        "VariableList": [
          {
            "ApiTag": "sample string 1",
            "StrategyVariableID": 2,
            "StrategyId": 3,
            "GatewayID": 1,
            "GatewayDeviceID": 1,
            "Operator": "sample string 4",
            "RightValue": "sample string 5",
            "AndOr": "sample string 6",
            "Kind": 64,
            "BracketsStart": "sample string 8",
            "BracketsEnd": "sample string 9"
          },
          {
            "ApiTag": "sample string 1",
            "StrategyVariableID": 2,
            "StrategyId": 3,
            "GatewayID": 1,
            "GatewayDeviceID": 1,
            "Operator": "sample string 4",
            "RightValue": "sample string 5",
            "AndOr": "sample string 6",
            "Kind": 64,
            "BracketsStart": "sample string 8",
            "BracketsEnd": "sample string 9"
          }
        ],
        "ActionList": [
          {
            "GatewayDeviceName": "sample string 1",
            "ApiTag": "sample string 2",
            "ActionID": 3,
            "StrategyId": 1,
            "GatewayDeviceID": 1,
            "SetValue": "sample string 4",
            "Delay": 5
          },
          {
            "GatewayDeviceName": "sample string 1",
            "ApiTag": "sample string 2",
            "ActionID": 3,
            "StrategyId": 1,
            "GatewayDeviceID": 1,
            "SetValue": "sample string 4",
            "Delay": 5
          }
        ],
        "ActionHTML": "sample string 8",
        "RunTimeList": [
          {
            "RunTimeID": 1,
            "StrategyId": 1,
            "Period": 64,
            "Day": 1,
            "Time": "2024-04-19T02:08:21.2279226+08:00"
          },
          {
            "RunTimeID": 1,
            "StrategyId": 1,
            "Period": 64,
            "Day": 1,
            "Time": "2024-04-19T02:08:21.2279226+08:00"
          }
        ],
        "RunTimeHTML": "sample string 9",
        "StrategyId": 10,
        "GatewayID": 11,
        "Kind": 64,
        "Condition": "sample string 13",
        "ConditionCn": "sample string 14",
        "Nullity": 64,
        "CreateDate": "2024-04-19T02:08:21.2279226+08:00",
        "CreateUserID": 16,
        "ProjectID": 17
      },
      {
        "NullityCN": 0,
        "GatewayName": "sample string 1",
        "GatewayKind": 64,
        "GatewayKindCn": "sample string 3",
        "GatewayTag": "sample string 4",
        "GatewayNullity": true,
        "Telphone": "sample string 6",
        "CollegeName": "sample string 7",
        "VariableList": [
          {
            "ApiTag": "sample string 1",
            "StrategyVariableID": 2,
            "StrategyId": 3,
            "GatewayID": 1,
            "GatewayDeviceID": 1,
            "Operator": "sample string 4",
            "RightValue": "sample string 5",
            "AndOr": "sample string 6",
            "Kind": 64,
            "BracketsStart": "sample string 8",
            "BracketsEnd": "sample string 9"
          },
          {
            "ApiTag": "sample string 1",
            "StrategyVariableID": 2,
            "StrategyId": 3,
            "GatewayID": 1,
            "GatewayDeviceID": 1,
            "Operator": "sample string 4",
            "RightValue": "sample string 5",
            "AndOr": "sample string 6",
            "Kind": 64,
            "BracketsStart": "sample string 8",
            "BracketsEnd": "sample string 9"
          }
        ],
        "ActionList": [
          {
            "GatewayDeviceName": "sample string 1",
            "ApiTag": "sample string 2",
            "ActionID": 3,
            "StrategyId": 1,
            "GatewayDeviceID": 1,
            "SetValue": "sample string 4",
            "Delay": 5
          },
          {
            "GatewayDeviceName": "sample string 1",
            "ApiTag": "sample string 2",
            "ActionID": 3,
            "StrategyId": 1,
            "GatewayDeviceID": 1,
            "SetValue": "sample string 4",
            "Delay": 5
          }
        ],
        "ActionHTML": "sample string 8",
        "RunTimeList": [
          {
            "RunTimeID": 1,
            "StrategyId": 1,
            "Period": 64,
            "Day": 1,
            "Time": "2024-04-19T02:08:21.2279226+08:00"
          },
          {
            "RunTimeID": 1,
            "StrategyId": 1,
            "Period": 64,
            "Day": 1,
            "Time": "2024-04-19T02:08:21.2279226+08:00"
          }
        ],
        "RunTimeHTML": "sample string 9",
        "StrategyId": 10,
        "GatewayID": 11,
        "Kind": 64,
        "Condition": "sample string 13",
        "ConditionCn": "sample string 14",
        "Nullity": 64,
        "CreateDate": "2024-04-19T02:08:21.2279226+08:00",
        "CreateUserID": 16,
        "ProjectID": 17
      }
    ],
    "PageCount": 1,
    "PageIndex": 2,
    "PageSize": 3,
    "RecordCount": 4
  },
  "Status": 0,
  "StatusCode": 1,
  "Msg": "sample string 2",
  "ErrorObj": {}
}

新增策略

请求方式及地址

   POST 
   http://api.nlecloud.com/Strategys

包体请求参数

参数类型描述其它
DeviceID integer 设备ID
Kind byte 类型 1：设备控制 2：邮件上报
Expression string 策略表达式 ({0} or {1}) and {2}
StrategyVariableList Collection of StrategyVariableAddApiDTO 策略变量列表
StrategyActionList Collection of StrategyActionAddApiDTO 策略动作列表
StrategyRunTimeList Collection of StrategyRunTimeAddApiDTO 策略定时执行列表

请求示例

{
  "DeviceID": 1,
  "Kind": 64,
  "Expression": "sample string 3",
  "StrategyVariableList": [],
  "StrategyActionList": [],
  "StrategyRunTimeList": [],
  "ReturnUrl": "sample string 4",
  "DataToken": "sample string 5"
}

响应参数

参数类型描述其它
ResultObj integer
Status ResultStatus 返回状态
StatusCode integer 返回的状态码
Msg string 返回的消息
ErrorObj Object

响应示例

{
  "ResultObj": 1,
  "Status": 0,
  "StatusCode": 2,
  "Msg": "sample string 3",
  "ErrorObj": {}
}

删除策略

请求方式及地址

   DELETE 
   http://api.nlecloud.com/Strategys

包体请求参数

请求示例

[
  1,
  2
]

响应参数

参数类型描述其它
Status ResultStatus 返回状态
StatusCode integer 返回的状态码
Msg string 返回的消息
ErrorObj Object

响应示例

{
  "Status": 0,
  "StatusCode": 1,
  "Msg": "sample string 2",
  "ErrorObj": {}
}

查询策略执行记录

请求方式及地址

   GET 
   http://api.nlecloud.com/Strategys/Records

URL请求参数

参数类型描述其它
projectId integer 项目ID（必须）
deviceId integer 设备ID（可选）
StrategyID integer 策略ID（可选）
PageSize integer 指定每页要显示的数据个数，默认20，最多100
StartDate string 起始时间（可选，包括当天，格式YYYY-MM-DD）
EndDate string 结束时间（可选，包括当天，格式YYYY-MM-DD）
PageIndex integer 指定页码

响应参数

参数类型描述其它
ResultObj ListPagerSetOfCD_StrategyRecord
Status ResultStatus 返回状态
StatusCode integer 返回的状态码
Msg string 返回的消息
ErrorObj Object

响应示例

{
  "ResultObj": {
    "PageSet": [
      {
        "CD_StrategyRecordActions": null,
        "RecordID": 1,
        "StrategyId": 2,
        "GatewayID": 3,
        "GatewayName": "sample string 4",
        "Kind": 64,
        "GatewayKindCn": "sample string 6",
        "Condition": "sample string 7",
        "ConditionCn": "sample string 8",
        "RunTimeID": 9,
        "Period": 64,
        "Day": 1,
        "Time": "2024-04-19T02:08:21.3373204+08:00",
        "ExecTimeHTML": "sample string 11",
        "RecordActionHTML": "sample string 12",
        "Action": "sample string 13",
        "CreateDate": "2024-04-19T02:08:21.3373204+08:00",
        "CreateUserID": 15,
        "ProjectID": 16
      },
      {
        "CD_StrategyRecordActions": null,
        "RecordID": 1,
        "StrategyId": 2,
        "GatewayID": 3,
        "GatewayName": "sample string 4",
        "Kind": 64,
        "GatewayKindCn": "sample string 6",
        "Condition": "sample string 7",
        "ConditionCn": "sample string 8",
        "RunTimeID": 9,
        "Period": 64,
        "Day": 1,
        "Time": "2024-04-19T02:08:21.3373204+08:00",
        "ExecTimeHTML": "sample string 11",
        "RecordActionHTML": "sample string 12",
        "Action": "sample string 13",
        "CreateDate": "2024-04-19T02:08:21.3373204+08:00",
        "CreateUserID": 15,
        "ProjectID": 16
      }
    ],
    "PageCount": 1,
    "PageIndex": 2,
    "PageSize": 3,
    "RecordCount": 4
  },
  "Status": 0,
  "StatusCode": 1,
  "Msg": "sample string 2",
  "ErrorObj": {}
}

更新策略

请求方式及地址

   PUT 
   http://api.nlecloud.com/Strategys/{strategyID}

URL请求参数

参数类型描述其它
strategyID integer Required

包体请求参数

参数类型描述其它
DeviceID integer 设备ID
Kind byte 类型 1：设备控制 2：邮件上报
Expression string 策略表达式 ({0} or {1}) and {2}
StrategyVariableList Collection of StrategyVariableAddApiDTO 策略变量列表
StrategyActionList Collection of StrategyActionAddApiDTO 策略动作列表
StrategyRunTimeList Collection of StrategyRunTimeAddApiDTO 策略定时执行列表

请求示例

{
  "DeviceID": 1,
  "Kind": 64,
  "Expression": "sample string 3",
  "StrategyVariableList": [],
  "StrategyActionList": [],
  "StrategyRunTimeList": [],
  "ReturnUrl": "sample string 4",
  "DataToken": "sample string 5"
}

响应参数

参数类型描述其它
ResultObj integer
Status ResultStatus 返回状态
StatusCode integer 返回的状态码
Msg string 返回的消息
ErrorObj Object

响应示例

{
  "ResultObj": 1,
  "Status": 0,
  "StatusCode": 2,
  "Msg": "sample string 3",
  "ErrorObj": {}
}

启用/禁用策略

请求方式及地址

   POST 
   http://api.nlecloud.com/Strategys/Enable/{strategyID}

URL请求参数

参数类型描述其它
strategyID integer 策略ID Required
enable boolean 启动/禁用 Required

响应参数

参数类型描述其它
Status ResultStatus 返回状态
StatusCode integer 返回的状态码
Msg string 返回的消息
ErrorObj Object

响应示例

{
  "Status": 0,
  "StatusCode": 1,
  "Msg": "sample string 2",
  "ErrorObj": {}
}