Блоки
Получение списка блоков (табличное представление)
- Метод
- GET
- URL
https://api.gigma.ru/api/tables/applications/{id}/blocks- Авторизация
- Bearer token
- Headers
Authorization: Bearer {token}
Параметры запроса
applications/{id}— ID приложения из списка приложенийquery— поисковая строка
Пример запроса
https://api.gigma.ru/api/tables/applications/30/blocks Ответ
При успешном действии возвращается HTTP код 200.
{
"columns": [
{
"id": 149,
"table_id": 19,
"order": 0,
"key": "code",
"has_icon": 0,
"text": "Код"
},
{
"id": 150,
"table_id": 19,
"order": 1,
"key": "date",
"has_icon": 0,
"text": "Дата"
},
{
"id": 151,
"table_id": 19,
"order": 2,
"key": "name",
"has_icon": 1,
"text": "Название"
},
{
"id": 152,
"table_id": 19,
"order": 3,
"key": "path",
"has_icon": 0,
"text": "Путь"
},
{
"id": 153,
"table_id": 19,
"order": 4,
"key": "block_type",
"has_icon": 1,
"text": "Тип блока"
},
{
"id": 154,
"table_id": 19,
"order": 5,
"key": "creator",
"has_icon": 1,
"text": "Создал"
}
],
"blocks": [
{
"id": {
"icon": null,
"value": 7,
"url": ""
},
"date": "25 янв 2025",
"name": {
"icon": "https://api.gigma.ru/storage/uploads/default.svg",
"value": "Видео на главной странице"
},
"path": "> Главная > Видео на главной странице",
"block_type": {
"icon": "https://api.gigma.ru/api//storage/uploads/image-profile-2.svg",
"value": "Картинка"
},
"creator": {
"icon": "https://api.gigma.ru/api//storage/uploads/cdO1uLpgY29TgnFLhaJWQkjK8VDxMg2fk3dp0ihW.png",
"value": "Воронова София",
"link": "https://beta.gigma.ru/users/list-users/66"
}
}
],
"pagination": {
"total": 1,
"per_page": 10,
"current_page": 1,
"last_page": 1,
"from": 1,
"to": 1
}
} Описание полей ответа
columns— массив столбцовpagination— объект с информацией, необходимой для пагинацииid— первичный ключ (номер заказа)name— название блокаblock_type— объект с информацией о типе блока
Получение списка блоков
- Метод
- GET
- URL
https://api.gigma.ru/api/applications/{id}/blocks- Авторизация
- Bearer token
- Headers
Authorization: Bearer {token}
Параметры запроса
applications/{id}— ID приложения из списка приложенийquery— поисковая строка
Пример запроса
https://api.gigma.ru/api/applications/30/blocks Ответ
При успешном действии возвращается HTTP код 200.
[
{
"id": 8,
"code": 1,
"name": "Первый блок (текстовый)",
"avatar": null,
"block_type": {
"id": 1,
"name": "Обычный текст",
"avatar": "https://api.gigma.ru/api//storage/uploads/image-profile-1.svg",
"created_at": "2025-01-23T09:47:38.000000Z"
},
"link": null,
"file": null,
"text": "Текст",
"parent": null,
"children": [
{
"id": 9,
"code": 2,
"name": "Второй блок",
"avatar": null,
"block_type": {
"id": 5,
"name": "URL ссылка",
"avatar": "https://api.gigma.ru/api//storage/uploads/image-profile-4.svg",
"created_at": "2025-01-23T09:47:38.000000Z"
},
"link": "https://yandex.ru",
"file": null,
"text": null,
"parent": {
"id": 8,
"name": "Первый блок (текстовый)"
},
"children": [
{
"id": 10,
"code": 3,
"name": "Третий блок",
"avatar": null,
"block_type": {
"id": 3,
"name": "Картинка",
"avatar": "https://api.gigma.ru/api//storage/uploads/image-profile-2.svg",
"created_at": "2025-01-23T09:47:38.000000Z"
},
"link": null,
"file": {
"id": 2827,
"name": "Da Chirillo - Колбасы и деликатесы премиум качества.png",
"type": {
"id": 1,
"name": "Трудовой договор",
"avatar": "https://api.gigma.ru/storage/uploads/default.svg",
"created_at": "2024-03-27T07:00:46.000000Z"
},
"path": "https://api.gigma.ru/storage/uploads/IcnkXX2tyYQcFtuNOYEsbrgRX13T1IVkeyTTHxqH.png",
"link": null,
"created_at": "2025-01-27T14:17:14.000000Z",
"updated_at": "2025-01-27T14:17:14.000000Z"
},
"text": null,
"parent": {
"id": 9,
"name": "Второй блок"
},
"children": [],
"created_at": "2025-01-27T14:17:14.000000Z"
}
],
"created_at": "2025-01-27T14:12:38.000000Z"
},
{
"id": 11,
"code": 4,
"name": "Четвертый блок",
"avatar": null,
"block_type": {
"id": 2,
"name": "Длинный текст",
"avatar": "https://api.gigma.ru/api//storage/uploads/image-profile-1.svg",
"created_at": "2025-01-23T09:47:38.000000Z"
},
"link": null,
"file": null,
"text": "<p>Привет!</p>",
"parent": {
"id": 8,
"name": "Первый блок (текстовый)"
},
"children": [],
"created_at": "2025-01-27T14:23:07.000000Z"
}
],
"created_at": "2025-01-27T13:03:19.000000Z"
}
] Описание полей ответа
Возвращаемые поля аналогичны запросу получения выбранного блока.
Получение выбранного блока
- Метод
- GET
- URL
https://api.gigma.ru/api/applications/{id}/blocks/{id}- Авторизация
- Bearer token
- Headers
Authorization: Bearer {token}
Параметры запроса
applications/{id}— ID приложения из списка приложений
Пример запроса
https://api.gigma.ru/api/applications/30/blocks/9 Ответ
При успешном действии возвращается HTTP код 200.
{
"block": {
"id": 10,
"code": 3,
"name": "Третий блок",
"avatar": {
"id": 2827,
"name": "Da Chirillo - Колбасы и деликатесы премиум качества.png",
"type": {
"id": 1,
"name": "Трудовой договор",
"avatar": "https://api.gigma.ru/storage/uploads/default.svg",
"created_at": "2024-03-27T07:00:46.000000Z"
},
"path": "https://api.gigma.ru/storage/uploads/IcnkXX2tyYQcFtuNOYEsbrgRX13T1IVkeyTTHxqH.png",
"link": null,
"created_at": "2025-01-27T14:17:14.000000Z",
"updated_at": "2025-01-27T14:17:14.000000Z"
},
"block_type": {
"id": 3,
"name": "Картинка",
"avatar": "https://api.gigma.ru/api//storage/uploads/image-profile-2.svg",
"created_at": "2025-01-23T09:47:38.000000Z"
},
"link": null,
"file": {
"id": 2827,
"name": "Da Chirillo - Колбасы и деликатесы премиум качества.png",
"type": {
"id": 1,
"name": "Трудовой договор",
"avatar": "https://api.gigma.ru/storage/uploads/default.svg",
"created_at": "2024-03-27T07:00:46.000000Z"
},
"path": "https://api.gigma.ru/storage/uploads/IcnkXX2tyYQcFtuNOYEsbrgRX13T1IVkeyTTHxqH.png",
"link": null,
"created_at": "2025-01-27T14:17:14.000000Z",
"updated_at": "2025-01-27T14:17:14.000000Z"
},
"text": null,
"parent": {
"id": 9,
"name": "Второй блок"
},
"children": [],
"created_at": "2025-01-27T14:17:14.000000Z"
}
} Описание полей ответа
id— первичный ключ (номер блока)code— код блокаname— название блокаavatar— объект с информацией об аватареblock_type— объект с информацией о типе блокаlink— URL ссылкаfile— объект с информацией о прикреплённом файлеtext— текстовый контент блокаchildren— массив объектов типа “Блок”, которые являются подчиненными сущностями выбранного элементаcreated_at— дата добавления в систему
Добавление блока
- Метод
- POST
- URL
https://api.gigma.ru/api/applications/{id}/blocks- Авторизация
- Bearer token
- Headers
Authorization: Bearer {token}
Параметры запроса
applications/{id}— ID приложения из списка приложенийblock_type_id— ID типа блока из справочникаname— имя блокаlink— URL ссылка. Обязателен, еслиblock_type_id= 4 илиblock_type_id= 5avatar_id— ID аватара, загруженного при помощи запроса добавления файлаfile_id— ID прикрепляемого файла, загруженного при помощи запроса добавления файла. Обязателен, еслиblock_type_id= 3text— текстовый контент блока. Обязателен, еслиblock_type_id= 1 илиblock_type_id= 2parent_id— ID родительского блока из запроса получения списка блоков
Пример запроса
{
"block_type_id": 3,
"name": "Параметр 1",
"link": null,
"avatar_id": 1,
"file_id": 1,
"text": null,
"parent_id": 1
} Ответ
При успешном действии возвращается HTTP код 201.
{
"block": {
"id": 5,
"code": 5,
"name": "Параметр 1",
"avatar": {
"id": 1,
"name": "logo.svg",
"type": {
"id": 1,
"name": "Трудовой договор",
"avatar": "https://api.gigma.ru/storage/uploads/default.svg",
"created_at": "2024-03-27T07:00:46.000000Z"
},
"path": "https://api.gigma.ru/storage/uploads/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
"link": null,
"created_at": "2024-04-14T20:04:32.000000Z",
"updated_at": "2024-04-14T20:04:32.000000Z"
},
"block_type": {
"id": 3,
"name": "Картинка",
"avatar": "https://api.gigma.ru/api//storage/uploads/image-profile-2.svg",
"created_at": "2025-01-23T09:47:38.000000Z"
},
"link": null,
"file": {
"id": 1,
"name": "logo.svg",
"type": {
"id": 1,
"name": "Трудовой договор",
"avatar": "https://api.gigma.ru/storage/uploads/default.svg",
"created_at": "2024-03-27T07:00:46.000000Z"
},
"path": "https://api.gigma.ru/storage/uploads/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
"link": null,
"created_at": "2024-04-14T20:04:32.000000Z",
"updated_at": "2024-04-14T20:04:32.000000Z"
},
"text": null,
"parent": {
"id": 1,
"name": "Видео рекламного слайдера"
},
"children": [],
"created_at": "2025-01-23T17:59:03.000000Z"
}
} Описание полей ответа
Возвращаемые поля аналогичны запросу получения выбранного блока.
Редактирование блока
- Метод
- PUT
- URL
https://api.gigma.ru/api/applications/{id}/blocks/{id}- Авторизация
- Bearer token
- Headers
Authorization: Bearer {token}
Параметры запроса
applications/{id}— ID приложения из списка приложенийblock_type_id— ID типа блока из справочникаname— имя блокаcode— код блокаlink— URL ссылка. Обязателен, еслиblock_type_id= 4 илиblock_type_id= 5avatar_id— ID аватара, загруженного при помощи запроса добавления файла. Обязателен, еслиblock_type_id= 3file_id— ID прикрепляемого файла, загруженного при помощи запроса добавления файла. Обязателен, еслиblock_type_id= 3text— текстовый контент блока. Обязателен, еслиblock_type_id= 1 илиblock_type_id= 2parent_id— ID родительского блока из запроса получения списка блоков
Пример запроса
{
"block_type_id": 3,
"name": "Видео рекламного слайдера",
"avatar_id": 2,
"file_id": 2,
"parent_id": 1,
"code": 10
} Ответ
При успешном действии возвращается HTTP код 200.
{
"block": {
"id": 2,
"code": 10,
"name": "Видео рекламного слайдера",
"avatar": {
"id": 2,
"name": "logo.png",
"type": {
"id": 1,
"name": "Трудовой договор",
"avatar": "https://api.gigma.ru/storage/uploads/default.svg",
"created_at": "2024-03-27T07:00:46.000000Z"
},
"path": "https://api.gigma.ru/storage/uploads/igbcW8dPebcrVfnbC2A2Zptf1nruFcF8Nmf8sVTG.png",
"link": null,
"created_at": "2024-04-14T20:11:00.000000Z",
"updated_at": "2024-04-14T20:11:00.000000Z"
},
"block_type": {
"id": 3,
"name": "Картинка",
"avatar": "https://api.gigma.ru/api//storage/uploads/image-profile-2.svg",
"created_at": "2025-01-23T09:47:38.000000Z"
},
"link": null,
"file": {
"id": 2,
"name": "logo.png",
"type": {
"id": 1,
"name": "Трудовой договор",
"avatar": "https://api.gigma.ru/storage/uploads/default.svg",
"created_at": "2024-03-27T07:00:46.000000Z"
},
"path": "https://api.gigma.ru/storage/uploads/igbcW8dPebcrVfnbC2A2Zptf1nruFcF8Nmf8sVTG.png",
"link": null,
"created_at": "2024-04-14T20:11:00.000000Z",
"updated_at": "2024-04-14T20:11:00.000000Z"
},
"text": null,
"parent": {
"id": 1,
"name": "Видео рекламного слайдера"
},
"children": [],
"created_at": "2025-01-23T17:44:00.000000Z"
}
} Описание полей ответа
Возвращаемые поля аналогичны запросу получения выбранного блока.
Удаление блока
- Метод
- DELETE
- URL
https://api.gigma.ru/api/applications/{id}/blocks/{id}- Авторизация
- Bearer token
- Headers
Authorization: Bearer {token}
Параметры запроса
applications/{id}— ID приложения из списка приложений
Пример запроса
https://api.gigma.ru/api/applications/30/blocks/1 Ответ
При успешном действии возвращается HTTP код 200.
{
"message": "Block successfully deleted"
} Описание полей ответа
message— информационное поле
Получение истории изменений по блоку
- Метод
- GET
- URL
https://api.gigma.ru/api/applications/{id}/blocks/{id}/history- Авторизация
- Bearer token
- Headers
Authorization: Bearer {token}
Параметры запроса
applications/{id}— ID приложения из списка приложений
Пример запроса
https://api.gigma.ru/api/applications/30/blocks/18/history Ответ
При успешном действии возвращается HTTP код 200.
{
"histories": [
{
"id": 2174,
"icon": "check",
"color": "primary",
"title": "Создание",
"description": "Создание: Воронова София",
"datetime": "23.01.2025 15:57"
}
],
"historiesCount": 1
} Описание полей ответа
id— первичный ключicon— иконкаcolor— цветtitle— заголовокdescription— описаниеdatetime— дата выполнения действия