Добавление коллекции

POST /core/collections/add

Описание

Этот эндпоинт используется для создания новой коллекции в системе. Запрос отправляется с данными коллекции, а в ответе возвращается информация о только что созданной коллекции, включая ее структуру и метаданные.

Параметры запроса

Обязательные параметры:

name, singleName, pluralName, fields

Вспомогательные параметры:

Нет

Пример:
POST
/core/collections/add

Отправляемы данные FormData:

1{
2  "name": "test",
3  "singleName": "test",
4  "pluralName": "tests",
5  "fields": []
6}

Ответ

Возвращается в формате JSON и содержит следующие ключевые поля:

  • id - Идентификатор коллекции
  • name - Название коллекции
  • singleName - Односложное название коллекции
  • pluralName - Множественное название коллекции
  • fields - Массив объектов, Типы полей
  • active - Статус активности коллекции ( true / false )
  • createdBy - Идентификатор пользователя, создавшего коллекцию
  • createdAt - Дата и время создания коллекции
  • updatedAt - Дата и время последнего обновления коллекции
POST
/core/collections/add

При успешном запросе, ответ будет выглядеть так:

1{
2  "status": "success",
3  "payload": {
4    "id": 101,
5    "fields": [
6      {
7        "name": "_hits",
8        "default": 0,
9        "allowNull": true,
10        "type": "number"
11      },
12      {
13        "name": "_sort",
14        "default": 500,
15        "type": "number"
16      },
17      {
18        "name": "name",
19        "allowNull": false,
20        "unique": true,
21        "type": "text"
22      },
23      {
24        "name": "active",
25        "default": true,
26        "type": "boolean"
27      }
28    ],
29    "name": "Test2",
30    "pluralName": "tests",
31    "singleName": "test2",
32    "createdBy": 1,
33    "updatedAt": "2024-11-16T10:57:57.007Z",
34    "createdAt": "2024-11-16T10:57:57.007Z"
35  }
36}