获取

描述

integer/array correlation.get(object **parameters**)

这个方法允许根据给定的参数检索联系。

参数

(object) 定义需要输出的参数。

这个方法支持以下参数。

参数类型描述
correlationids字符串/数组只返回拥有给定 ID 的联系。
selectFilter查询返回 filter 属性中的联系过滤。
selectOperations查询返回 operations 属性中的联系操作。
sortfield字符串/数组根据给定的属性对结果进行排序。

可能的值有： correlationid，name 和 status。
countOutput布尔值在引用评论中详细描述了所有 get 方法的常见参数。
editable布尔值
excludeSearch布尔值
filter对象
limit整数
output查询
preservekeys布尔值
search对象
searchByAny布尔值
searchWildcardsEnabled布尔值
sortorder字符串/数组
startSearch布尔值

返回值

(integer/array) 返回：

  • 一个对象数组；

  • 如果使用了 countOutput 参数，被检索的对象的数量。

示例

检索联系

检索所有具有相关条件和操作的已配置过的联系。过滤使用 “AND/OR” 的评估类型，因此 formula 属性为空，且 eval_formula 将自动生成。

请求：

  1. {
  2.     "jsonrpc": "2.0",
  3.     "method": "correlation.get",
  4.     "params": {
  5.         "output": "extend",
  6.         "selectOperations": "extend",
  7.         "selectFilter": "extend"
  8.     },
  9.     "auth": "343baad4f88b4106b9b5961e77437688",
  10.     "id": 1
  11. }

响应：

  1. {
  2.     "jsonrpc": "2.0",
  3.     "result": [
  4.         {
  5.             "correlationid": "1",
  6.             "name": "Correlation 1",
  7.             "description": "",
  8.             "status": "0",
  9.             "filter": {
  10.                 "evaltype": "0",
  11.                 "formula": "",
  12.                 "conditions": [
  13.                     {
  14.                         "type": "3",
  15.                         "oldtag": "error",
  16.                         "newtag": "ok",
  17.                         "formulaid": "A"
  18.                     }
  19.                 ],
  20.                 "eval_formula": "A"
  21.             },
  22.             "operations": [
  23.                 {
  24.                     "type": "0"
  25.                 }
  26.             ]
  27.         }
  28.     ],
  29.     "id": 1
  30. }

参见

来源

CCorrelation::get() in frontends/php/include/classes/api/services/CCorrelation.php.