Variables API - FI
Tämän API:n avulla voit tarkastella, lisätä, muokata ja poistaa muuttujia projektissa.
Lukeminen.
Voit tarkastella luotuja muuttujia projektissa.
GET https://api.smartsender.com/v1/variables
Pääparametrit:
Nimi | Kuvaus | Validointi |
---|---|---|
page | Pyydetty sivu | Vähimmäisarvo 1 |
limitation | Näytettävien tietojen määrä sivua kohden | Pienin arvo 1, maksimi 20 |
term | Hakumerkkijono |
|
Jos vastaus on onnistunut, saat seuraavat tiedot:
{
"cursor": Cursor,
"collection": Variable[]
}
Vastauksen kuvaus:
Luominen.
Mahdollistaa uuden muuttujan luomisen projektiin.
POST https://api.smartsender.com/v1/variables
Pääparametrit:
Nimi | Kuvaus | Validointi |
---|---|---|
name | Nimi | Ainutlaatuinen projektin sisällä |
type | Tyyppi | Saatavilla
|
description | Kuvaus | Välttämättä |
values | Vaihtoehdot pilkuilla erotettuina | Pakollinen, jos tyyppi enum |
Jos onnistut, hanki luotu Variable-objekti.
Päivittää.
Voit päivittää olemassa olevan muuttujan.
Pääparametrit:
Nimi | Kuvaus |
---|---|
name | Nimi |
description | Kuvaus |
Jos vastaus on onnistunut, saat seuraavat tiedot:
Poistaminen.
Voit poistaa olemassa olevan muuttujan.
Jos vastaus on onnistunut, saat seuraavat tiedot: