Izmantotā SERP versija ir 8.5 2019-06-05 build 85310221, testēts, izmantojot Postman.
...
- sort - nosaka secību;
- range - var izvēlēties kādu ierakstu diapozonu pēc izvēlētā sort parametra skatīt;
- fields - nosaka laukus, kurus iekļaut atbildē;
- filter - atgriež ierakstus, kuri atbilst filtram;
- offset un limit - var sadalīt API atbildi;
- updates_after - atgriež ierakstus, kas ir mainīti pēc dotā sekvences skaitļa;
- deletes_after - atgriež ierakstus, kas ir dzēsti pēc dotā sekvences skaitļa.
GET metode strādā arī uz custom laukiem.
| Note |
|---|
Lai dabūtu ierakstu pēc SerNr vai jebkāda cita reģistra MainKey lauka, jāizmanto range, vienīgi šajā gadījumā pie sort jānorāda lauka nosaukums: sort=SerNr&range=23001 |
...
sort
Nosaka secību, pēc kura lauka atbildi indeksa kārtot. Ja laukam nav indekss pēc, kā kārtot, atgriezīs kļūdas paziņojumu MainKey indekss ir lauka nosaukums.
Piem., http://localhost:8085/api/1/IVVc?sort=CustCode
...
range
Atgriež noteiktu diapozonu ierakstus. Šim parametram obligāti vajag izmantot arī sort parametru, lai noteiktu, kuram indeksam tieši vajag šo diapozonu.
Piem., http://localhost:8085/api/1/IVVc?sort=CustCode&range=10100:10109 atgriezīs atgriezīs visus rēķinus, kuros klientu numuri ir no 10100 līdz 10109, galus ieskaitot.
...
Tā kā range izmanto sort indeksus, strādā ļoti ātri.
...
fields
Atgriezīs Katram ierakstam atgriezīs tikai šos laukus. Ja nenorāda, tad atgriež ierakstus ar visiem laukiem.
Piem., http://localhost:8085/api/1/IVVc?fields=SerNr,CustCode,Addr0 Addr0 atgriezīs visus rēķinus tikai ar rēķina numuru, klienta kodu un nosaukumu.
...
Atgriež ierakstus, kas atbilst filtra laukiem, var norādīt vairākus.
Piem., http://localhost:8085/api/1/IVVc?filter.CustCode=10100 atgriezīs atgriezīs tikai rēķinus ar šo klientu.
...
- offset norāda pie kura ieraksta sāks veidot atbildi
- limit norāda maksimālo ierakstu skaitu atbildē
Piem., http://localhost:8085/api/1/IVVc?offset=5&limit=5 izlaidīs izlaidīs pirmos 5 un ietvers otros 5 ierakstus no reģistra.
...
Atgriezīs tikai tos ierakstus, kas ir mainīti pēc padotā sekvences numura.
Piem., http://localhost:8085/api/1/IVVc?updates_after=16201
...
deletes_after
Atgriezīs to ierakstus, kas ir dzēsti pēc padotā sekvences numura. Par sekvences numuriem zemāk.
Piem., http://localhost:8085/api/1/IVVc?updates_after=16213
...
...
Datu rakstīšana
Datus rakstīšanai pastāv 2 parametri:
...
| Note |
|---|
Datu rakstīšana nestrādā uz blokveida un custom reģistriem. Mēģinājums rediģēt custom reģistru crasho DB. |
POST
Ar POST metodi var izveidot jaunus ierakstus.
Piem., http://localhost:8085/api/1/IVVc?set_field.SerNr=99999&set_field.CustCode=10101&set_row_field.0.ArtCode=10&set_row_field.0.Quant=7 - klientam 10101 izveidos rēķinu Nr. 99999 ar 7 artikuliem Nr.10 pirmajā rindā.
...
Ar PATCH metodi rediģē esošu ierakstu. Esošajam ierakstam piekļūst jau izsaukuma URL norādot MainKey lauka vērtību.
Piem., http://localhost:8085/api/1/IVVc/99999?set_field.CustCode=20202&set_row_field.0.Quant=9 - rēķinam Nr. 99999 nomainīs klientu uz 20202 un pirmās rindas artikulu skaitu uz 9.
...
Katrs REST API pieprasījums iekš <data> taga atgriež numuru sequence, kuri pieaug kaut kā. To var izmantot, atceroties katra pieprasījuma atbildes sekvenci un, kad no jauna kaut kādi dati jāiegūst, var izmantot šo skaitli inkrementālajam importam.
<data register="ORVc" sequence="16197" sort="SerNr" key="SerNr" systemversion="8.5.31.221">
...