За допомогою цього API ви можете переглядати, додавати, отримувати, редагувати та видаляти глобальні змінні у проекті.
Читання.
Дозволяє переглянути створені глобальні змінні у проекті.
GET https://api.smartsender.com/v1/definitions
Основні параметри:
Назва | Опис | Валідація |
|---|---|---|
page | Запитувана сторінка | Мінімальне значення 1 |
limitation | Кількість даних для виведення на сторінку | Мінімальне значення 1, максимальне 20 |
term | Рядок для пошуку |
|
У разі успішної відповіді отримаєте таке:
{
"cursor": Cursor,
"collection": Definition[]
}
Опис відповіді:
Назва | Опис |
|---|---|
cursor | Cursor об1єкт |
collection | Масив Definition об'єктів |
Створення.
Дозволяє створити нову глобальну змінну у проекті.
POST https://api.smartsender.com/v1/definitions
Основні параметри:
Назва | Опис | Валідація |
|---|---|---|
name | Назва | Уникальний в рамках проєкту |
value | Значення | String|Integer |
У разі успішної відповіді отримайте створений Definition об'єкт.
Отримання.
Дозволяє отримати існуючу глобальну змінну у проекті.
GET https://api.smartsender.com/v1/definitions/{definitionId}
У разі успішної відповіді отримайте створений Definition об'єкт.
Відновлення.
Дозволяє оновити існуючу глобальну змінну.
PUT https://api.smartsender.com/v1/definitions/{definitionId}
Основні параметри:
Назва | Опис |
|---|---|
name | Унікальний в рамках проєкту |
value | String|Integer |
У разі успішної відповіді отримаєте таке:
{
"state": true
}
Видалення.
Дозволяє видалити існуючу глобальну змінну.
DELETE https://api.smartsender.com/v1/definitions/{definitionId}
У разі успішної відповіді отримаєте таке:
{
"state": true
}