Отримати плагіни

GET 
/plugins

Отримає список зареєстрованих плагінів з їх визначенням

Responses

200

Список плагінів

application/json

Schema

Schema

• Array [

namestring
Назва плагіна
Example: Super Plugin
uuidstring
Плагін UUID
Example: 01234567-89ab-cdef-0123-456789abcdef2
versionstring
Версія плагіна
Example: 1.0.0
manages_deviceboolean
Плагін може керувати списком пристроїв.
Example: false

overridden_interfaces

object[]

Список інтерфейсів, для яких плагін може змінювати поведінку

Array [

namestring

Назва зміненого інтерфейсу

Example: SwitchBinary

actionsstring[]

Список дій, які перевизначаються плагіном

Example: ["setStatus"]

]

provided_interfaces

object[]

Список інтерфейсів, що надаються та обробляються плагіном

Array [

namestring

Назва наданого інтерфейсу

Example: SomeNewInterface

parameters

object[]

Параметри "схема" для інтерфейсу

Array [

namestring

Назва параметру

Example: status_field

typestring

Тип параметру

Possible values: [integer, double, boolean, string, json]

Example: boolean

]

actions

object[]

Визначення для дій, наданих плагіном

Array [

namestring

Ім'я дії

arguments

object[]

Аргументи пристрою

Array [

namestring

Ім'я аргументу

typestring

Тип аргументу. Можливі значення: ціле число, логічне значення, рядок, json

Possible values: [integer, boolean, string, json]

]

]

]

• ]

Example (from schema)

[
  {
    "name": "Super Plugin",
    "uuid": "01234567-89ab-cdef-0123-456789abcdef2",
    "version": "1.0.0",
    "manages_device": false,
    "overridden_interfaces": [
      {
        "name": "SwitchBinary",
        "actions": [
          "setStatus"
        ]
      }
    ],
    "provided_interfaces": [
      {
        "name": "SomeNewInterface",
        "parameters": [
          {
            "name": "status_field",
            "type": "boolean"
          }
        ],
        "actions": [
          {
            "name": "string",
            "arguments": [
              {
                "name": "string",
                "type": "integer"
              }
            ]
          }
        ]
      }
    ]
  }
]

401

Користувач не має дозволу.

application/json

Schema

Schema

successbooleanrequired

Прапорець, який показує, чи був запит успішним

errorCodeintegerrequired

Ціле число помилки, див. Помилки

errorMessagestringrequired

Опис помилки

errorParameters

Додаткові дані, що описують помилку

Example (from schema)

{
  "success": true,
  "errorCode": 0,
  "errorMessage": "string"
}

Example

{
  "success": false,
  "errorCode": 4131,
  "errorMessage": "User not authorized",
  "errorParameters": "Not authorized"
}