Перейти к содержанию

Получение свойств полей проверок соответствия ПО и действий пользователей

Запрос

Тип Метод
GET /software_compliance_checks/_meta

Описание: При выполнении запроса будут возвращены свойства полей проверок соответствия ПО и список действий пользователей над ними в интерфейсе платформы.

Пример запроса

GET
http://127.0.0.1/cruddy/v2/software_compliance_checks/_meta

Успешный ответ

Статус код: 200 – запрос успешно обработан.

Формат: JSON.

Тело ответа:

Параметр Тип данных Описание
fields Array Список полей для пользовательского интерфейса
fields{name} string Название поля
fields{type} string Тип данных, поддерживаемый полем. Например:
- string;
- date;
- boolean.
fields{filters} Array<string> Список фильтров. Допустимые значения:
- equal;
- substr;
- intersection;
- range.
actions Array<string> Список массовых действий
instance_actions Array Список действий над отдельными объектами
instance_actions{action} string Название действия
instance_actions{params} object Параметры, определяющие действие
relations Array<string> Список связей
Пример ответа

{
  "fields": [
    {
      "name": "string",
      "type": "boolean",
      "filters": [
        "equal"
      ]
    }
  ],
  "actions": [
    "string"
  ],
  "instance_actions": [
    {
      "action": "string",
      "params": {}
    }
  ],
  "relations": [
    "string"
  ]
}

Другие возможные ответы

Код Ответ Описание
400 Bad Request Неверный тип параметра запроса, либо отсутствует обязательный параметр
401 can’t get user info Невозможно аутентифицировать пользователя
500 Internal Server Error Ошибки сервера

Примечание: Текст ошибки не фиксированный, может изменяться в зависимости от фактического ответа получателя запроса.

Пример ответа

Код 400

{
  "error": "Bad Request",
  "error_code": 400
}

Код 401

{
  "error": "can't get user info: {\\\"error\\\":\\\"invalid_token\\\",\\\"error_description\\\":\\\"Token verification failed\\\"}\nor \n{ \"error\": \"unauthorized\", \"error_code\": 401 }",
  "error_code": 401
}

Код 500

{
  "error": "Internal Server Error",
  "error_code": 500
}