Подключение при помощи Management API

1
{
2
   "name":"Папка для конфигураций"
3
}

1
{
2
   "name":"Интеграционная конфигурация",
3
   "folderId":"{{ID папки}}",
4
   "logLevel":"Error",
5
   "errorItemIds":[],
6
   "defaultTimeout":30000
7
}

1
{
2
    "actionTypeId": "4d58067f-cc13-42c9-b53d-e5e0a214786a",
3
    "folderId": "{{ID папки}}",
4
    "parameters": [
5
        {
6
            "actionTypeParameterName": "token",
7
            "valueTypeId": "ff791c0a-925e-4117-8193-6e615e6bbecb",
8
            "value": "$.payload.username"
9
        }
10
    ]
11
}

1
{
2
    "actionTypeId": "0a9566c1-9a21-4a53-9d30-302ed422453d",
3
    "folderId": "{{ID папки}}",
4
    "parameters": [
5
        {
6
            "actionTypeParameterName": "regexp",
7
            "valueTypeId": "f6898ec0-cb22-4184-a511-cf728f8d1205",
8
            "value": "v1/devices/me/rpc/request/([0-9]+)"
9
        },
10
        {
11
            "actionTypeParameterName": "from",
12
            "valueTypeId": "ff791c0a-925e-4117-8193-6e615e6bbecb",
13
            "value": "$.endpoint.uriPath" // или $.request.context.endpoint.topic
14
        },
15
        {
16
            "actionTypeParameterName": "to",
17
            "valueTypeId": "ff791c0a-925e-4117-8193-6e615e6bbecb",
18
            "value": "$.contextVariables.externalRqId"
19
        }
20
    ]
21
}

1
{
2
   "name":"Получение команд",
3
   "folderId":"{{ID папки}}",
4
   "body":"function convert(message, context) { return { id: '{{externalRqId}}', method: '{{methodName}}', params: message};}; convert(message, context);", //id - опционален, methodName - название метода
5
   "expectedParams":{},
6
   "timeout":30000
7
}

1
{
2
   "name":"Передача атрибутов",
3
   "folderId":"{{ID папки}}",
4
   "dataType":"ATTRIBUTES",
5
   "configurationId":"{{ID интеграционной конфигурации}}",
6
   "responseOperations":[],
7
   "requestScriptsSequence":[],
8
   "actionsSequence":[
9
      {
10
         "id":"{{ID действия на авторизацию}}",
11
         "index":1
12
      }
13
   ],
14
   "defaultResponseCode":"200",
15
   "defaultResponseMessage":"{\"result\":\"OK\"}"
16
}

1
{
2
   "name":"Передача телеметрии",
3
   "folderId":"{{ID папки}}",
4
   "dataType":"TELEMETRY",
5
   "configurationId":"{{ID интеграционной конфигурации}}",
6
   "responseOperations":[],
7
   "requestScriptsSequence":[],
8
   "actionsSequence":[
9
      {
10
         "id":"{{ID действия на авторизацию}}",
11
         "index":1
12
      }
13
   ],
14
   "defaultResponseCode":"200",
15
   "defaultResponseMessage":"{\"result\":\"OK\"}"
16
}

1
{
2
   "name":"Передача RPC-команд",
3
   "folderId":"{{ID папки}}",
4
   "dataType":"RPC",
5
   "configurationId":"{{ID интеграционной конфигурации}}",
6
   "responseOperations":[],
7
   "requestScriptsSequence":[],
8
   "actionsSequence":[
9
      {
10
         "id":"{{ID действия на авторизацию}}",
11
         "index":1
12
      },
13
      {
14
         "id":"{{ID действия на извлечение request_id}}",
15
         "index":2
16
      },
17
   ],
18
   "defaultResponseCode":"200",
19
   "defaultResponseMessage":"{\"result\":\"OK\"}"
20
}

1
{
2
   "name":"Подписка",
3
   "folderId":"{{ID папки}}",
4
   "dataType":"MIXED",
5
   "configurationId":"{{ID интеграционной конфигурации}}",
6
   "responseOperations":[],
7
   "requestScriptsSequence":[],
8
   "actionsSequence":[],
9
   "defaultResponseCode":"200",
10
   "defaultResponseMessage":"{\"result\":\"OK\"}"
11
}

1
{
2
   "name":"Передача атрибутов",
3
   "folderId":"{{ID папки}}",
4
   "type":"AUTH", // или COMMON
5
   "tenantType": "USER",
6
   "endpointConditions":[
7
      {
8
         "conditionParameterType":"endpoint", // или mqttMessageType
9
         "comparisonOperation":"startsWith", // или equals
10
         "parameterName":"uriPath", // или name
11
         "expectedValue":"/api/v1" //или PUBLISH
12
      },
13
      {
14
         "conditionParameterType":"endpoint",
15
         "comparisonOperation":"endsWith", // или equals
16
         "parameterName":"uriPath", // или topic
17
         "expectedValue":"/attributes" // или v1/devices/me/attributes
18
      },
19
      {
20
         "conditionParameterType":"params", // объект не добавляется
21
         "comparisonOperation":"equals",
22
         "parameterName":"httpMethod",
23
         "expectedValue":"POST"
24
      }
25
    ],
26
   "incomingOperationId": "{{ID входящей операции на передачу атрибутов}}",
27
   "protocol":"HTTP" // или MQTT, COAP
28
}

1
{
2
   "name":"Передача телеметрии",
3
   "folderId":"{{ID папки}}",
4
   "type":"AUTH",
5
   "tenantType": "USER",
6
   "endpointConditions":[
7
      {
8
         "conditionParameterType":"endpoint",
9
         "comparisonOperation":"startsWith",
10
         "parameterName":"uriPath",
11
         "expectedValue":"/api/v1"
12
      },
13
      {
14
         "conditionParameterType":"endpoint",
15
         "comparisonOperation":"endsWith",
16
         "parameterName":"uriPath",
17
         "expectedValue":"/telemetry"
18
      }
19
      {
20
         "conditionParameterType":"params",
21
         "comparisonOperation":"equals",
22
         "parameterName":"httpMethod",
23
         "expectedValue":"POST"
24
      }
25
   ],
26
   "incomingOperationId": "{{ID входящей операции на передачу телеметрии}}",
27
   "protocol":"HTTP"
28
}

1
{
2
   "name":"Передача команд",
3
   "folderId":"{{ID папки}}",
4
   "type":"AUTH",
5
   "tenantType": "USER",
6
   "endpointConditions":[
7
      {
8
         "conditionParameterType":"endpoint",
9
         "comparisonOperation":"startsWith",
10
         "parameterName":"uriPath",
11
         "expectedValue":"/api/v1"
12
      },
13
      {
14
         "conditionParameterType":"endpoint",
15
         "comparisonOperation":"endsWith",
16
         "parameterName":"uriPath",
17
         "expectedValue":"/rpc"
18
      },
19
      {
20
         "conditionParameterType":"params",
21
         "comparisonOperation":"equals",
22
         "parameterName":"httpMethod",
23
         "expectedValue":"POST"
24
      }
25
    ],
26
   "incomingOperationId": "{{ID входящей операции на передачу команд}}",
27
   "protocol":"HTTP"
28
}

1
{
2
   "name":"Подписка на получение команд",
3
   "folderId":"{{ID папки}}",
4
   "type":"COMMON",
5
   "tenantType": "USER",
6
   "endpointConditions":[
7
        {
8
            "conditionParameterType":"endpoint", // или mqttMessageType
9
            "comparisonOperation":"startsWith", // или equals
10
            "parameterName":"uriPath", // или name
11
            "expectedValue":"/api/v1" //или SUBSCRIBE
12
        },
13
        {
14
            "conditionParameterType":"endpoint", // объект не добавляется
15
            "comparisonOperation":"endsWith",
16
            "parameterName":"uriPath",
17
            "expectedValue":"/attributes"
18
        },
19
        {
20
            "conditionParameterType":"params", // объект не добавляется
21
            "comparisonOperation":"equals",
22
            "parameterName":"httpMethod",
23
            "expectedValue":"GET"
24
        }
25
    ],
26
   "incomingOperationId": "{{ID входящей операции на подписку}}",
27
   "protocol":"MQTT"
28
}

1
{
2
   "folderId":"{{ID папки}}",
3
   "protocol":"HTTP", // или MQTT, COAP
4
   "host": null, // или {{хост}}
5
   "port": null, //или {{порт}}
6
   "connectionTimeout": 30000,
7
   "socketTimeout": 30000,
8
   "parameters":[]
9
}

1
{
2
   "folderId":"{{ID папки}}",
3
   "hostId":"{{ID хоста}}",
4
   "path":"v1/devices/me/rpc/request/{{externalRqId}}",
5
   "method":"PUBLISH",
6
   "urlEncoded":false
7
}

1
{
2
   "folderId":"{{ID папки}}",
3
   "hostId":"{{ID хоста}}",
4
   "path":"v1/devices/me/attributes/response/{{externalRqId}}",
5
   "method":"PUBLISH",
6
   "urlEncoded":false
7
}

1
{
2
   "name":"Получение команд",
3
   "folderId":"{{ID папки}}",
4
   "dataType":"RPC",
5
   "configurationId":"{{ID интеграционной конфигурации}}",
6
   "thingClassesRelation": [
7
      {
8
         "classId": "{{classId устройства}}",
9
         "commandIds": [
10
            "{{commandId класса}}"
11
         ]
12
      }
13
   ],
14
   "reuseConnection": true,
15
   "requestHostId": null, // или {{ID хоста}}
16
   "requestOutgoingEndpointId": null, // или {{ID исходящего эндпоинта на передачу команд}}
17
   "requestScriptsSequence":[
18
      {
19
         "id":"{{ID скрипта на получение команд}}",
20
         "index":1
21
      }
22
   ],
23
   "responseScriptsSequence":[],
24
   "actionsSequence":[],
25
   "errorResponseCodes":[],
26
   "successResponseCodes":[
27
      "200",
28
      "201",
29
      "202",
30
      "203",
31
      "204"
32
   ],
33
   "syncRetryCodes":[],
34
   "syncRetryTimes":10,
35
   "asyncRetryTimes":5,
36
   "timeout":10000
37
}

1
{
2
   "name":"Передача запрошенных атрибутов",
3
   "folderId":"{{ID папки}}",
4
   "dataType":"ATTRIBUTES",
5
   "configurationId":"{{ID интеграционной конфигурации}}",
6
   "thingClassesRelation": [
7
      {
8
         "classId": "{{classId устройства}}",
9
         "commandIds": [
10
            "{{commandId класса}}"
11
         ]
12
      }
13
   ],
14
   "reuseConnection": true,
15
   "requestHostId": null, // или {{ID хоста}}
16
   "requestOutgoingEndpointId": null, // или {{ID исходящего эндпоинта на передачу запрошенных атрибутов}}
17
   "requestScriptsSequence":[
18
       {
19
         "id":"{{ID скрипта на получение запрошенных атрибутов}}",
20
         "index":1
21
      }
22
   ],
23
   "responseScriptsSequence":[],
24
   "actionsSequence":[],
25
   "errorResponseCodes":[],
26
   "successResponseCodes":[
27
      "200",
28
      "201",
29
      "202",
30
      "203",
31
      "204"
32
   ],
33
   "syncRetryCodes":[],
34
   "syncRetryTimes":10,
35
   "asyncRetryTimes":5,
36
   "timeout":10000
37
}