Definitions API
- Oleksandr Serdiuk
С помощью данного API вы можете просматривать, добавлять, получать, редактировать и удалять глобальные переменные в проекте.
Чтение.
Позволяет просмотреть созданные глобальные переменные в проекте.
GET https://api.smartsender.com/v1/definitions
Основные параметры:
Название | Описание | Валидация |
|---|---|---|
page | Запрашиваемая страница | Минимальное значение 1 |
limitation | Количество данных для вывода на странице | Минимальное значение 1, максимальное 20 |
term | Строка для поиска |
|
В случае успешного ответа получите следующее:
{
"cursor": Cursor,
"collection": Definition[]
}
Описание ответа:
Название | Описание |
|---|---|
cursor | Cursor обьект |
collection | Массив Definition объектов |
Создание.
Позволяет создать новую глобальную переменную в проекте.
POST https://api.smartsender.com/v1/definitions
Основные параметры:
Название | Описание | Валидация |
|---|---|---|
name | Название | Уникальный в рамках проекта |
value | Значение | String|Integer |
В случае успешного ответа получите созданный Definition объект.
Получение.
Позволяет получить существующую глобальную переменную в проекте.
В случае успешного ответа получите созданный Definition объект.
Обновление.
Позволяет обновить существующую глобальную переменную.
Основные параметры:
Название | Описание |
|---|---|
name | Уникальный в рамках проекта |
value | String|Integer |
В случае успешного ответа получите следующее:
Удаление.
Позволяет удалить существующую глобальную переменную.
В случае успешного ответа получите следующее: