Создание Рабочего стола

Запрос

Тип	Метод
POST	/dashboards/create

Описание: При выполнении запроса будет создан рабочий стол.

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

POST
http://127.0.0.1/cruddy/v2/dashboards/create

Тело запроса:

Параметр	Тип данных	Обязательность	Описание
name	string	Required	Название рабочего стола
config	Object <config>	Required	Свойства рабочего стола

Config

Параметр	Тип	Обязательность	Описание
grid	Array of <grid>	Required	Список параметров расположения виджетов на странице
period	Array of Strings	Required	Временной диапазон данных на рабочем столе

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

{
  "name": "string",
  "config": {
    "grid": [
      {}
    ],
    "period": [
      "now-1",
      "now"
    ]
  }
}

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

Статус код: 201 - успешное создание рабочего стола.

Формат: JSON.

Тело ответа: модель созданного рабочего стола.

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

{
  "id": "uuid",
  "created_at": "2023-12-20T00:00:01.652259Z",
  "updated_at": "2023-12-20T00:00:01.652259Z",
  "trace_id": "uuid",
  "name": "string",
  "config": {
    "grid": [
      {}
    ],
    "period": [
      "now-1",
      "now"
    ]
  },
  "owner": {
    "id": "uuid",
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "username": "string"
  },
  "users": null,
  "groups": null,
  "widgets": null
}

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

Код	Ответ	Описание
400	Bad Request	Неверный тип параметра запроса, либо отсутствует обязательный параметр
409	name_already_used	Попытка создать объект с существующим уникальным атрибутом
500	Internal Server Error	Другие ошибки при создании объекта

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

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

Код 400

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

Код 409

{
  "error": "name_already_used",
  "error_code": 409,
  "extra": {
    "fields": [
      "name"
    ]
  }
}

Код 500

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