Perusteet

Sallitut HTTP-verbit ovat GET, PATCH, POST ja DELETE. Tässä tarkemmat kuvaukset kutsutyypeistä:

  • GET: Tietojen hakeminen Severasta
  • PATCH: Olemassa olevan tiedon päivittäminen
    • JSON Patch on muoto, jota käytetään tietoja päivitettäessä REST API:ssa (lisätietoja osoitteessa: http://jsonpatch.com/).
    • Vain Replace (korvaa) on tuettu.
  • POST: Uusien tietojen luominen Severaan
  • DELETE: Tietojen poistaminen Severasta.
    • Käytä harkiten, sillä poistetut tiedot poistetaan kokonaan
  • Kutsujen vastauskoodeja ovat Success, Created ja Bad request

Sivutus

Oletuksena jokaista GET-kutsua kohden haetaan 20 riviä, ja maksimi on 1000. Parametrit ovat firstRow ja rowCount. Suositellaan käytettäväksi raskaissa kutsuissa.

Tekstin haku

Parametria textToSearch voidaan käyttää nopeaan hakuun. Esimerkiksi GET/users kutsussa on parametri, jolla voi hakea käyttäjän nimestä, koodista, sähköpostista tai avainsanoista. Kunkin reitin osalta kentät, joista haku suoritetaan, on määritelty teknisessä dokumentaatiossa.

Lajittelu

Määritelty monissa GET all for reiteissä kyselyparametrina. Se tukee useiden arvojen antamista. Esimerkki:

  • ?sortings[0]
  • [key]=lastUpdatedDateTime&sortings[0]
  • [value]=Desc&sortings[1]
  • [key]=createdDateTime&sortings[1]
  • [value]=Asc

Changed since

Parametri tietojen hakemiseen tietystä päivämäärästä eteenpäin. Tämän parametrin avulla voit hakea tietoja, jotka on muutettu annetun päivämäärän jälkeen. Esimerkiksi GET/users kutsussa on ChangedSince-parametri, jolla saa käyttäjät, jotka on lisätty tai muutettu tämän päivämäärän jälkeen (suurempi tai yhtä suuri kuin).

Laajuudet (Scopes)

Tällä hetkellä käytössä on vain SeveraAll, mutta laajuuksia lisätään niiden implementoinnin myötä.



Oliko tästä vastauksesta apua? Kyllä Ei

Send feedback
Pahoittelut, että emme voineet auttaa. Anna palautetta, jotta voimme parantaa tätä artikkelia.