POST /core/collections/:id

Описание

Этот запрос используется для обновления существующей коллекции. Вы можете изменить основные данные коллекции, такие как её название, имена в единственном и множественном числе, а также определить или обновить её поля.

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

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

id, name, singleName, pluralName, fields

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

Нет

Пример:

Добавление текстового поля description

POST
/core/collections/102

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

1{
2  "name": "test2",
3  "pluralName": "tests2",
4  "singleName": "test2",
5  "fields": [
6    {
7      "name": "description",
8      "type": "text",
9      "allowNull": true
10    }
11  ]
12}
Описание полей:
  • name - Название коллекции
  • singleName - Односложное название коллекции
  • pluralName - Множественное название коллекции
  • fields - Массив объектов, Типы полей
    • name - имя поля
    • type - тип данных поля
    • allowNull - указывает, может ли поле содержать null

Ответ

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

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

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

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