Preskoči na glavno vsebino

Prehľad zmien záznamu v REST API

Ako dohľadať históriu záznamu cez REST API?

Avtor: Petr Pech

Podobne ako v aplikácii, aj cez REST API možno dohľadať históriu vybraných záznamov. Vo vybraných evidenciách sa zaznamenávajú vykonané zmeny záznamov a ich jednotlivých polí — tzv. žurnál — a prehľad zmien vám ho sprístupní na zobrazenie aj ďalšiu analýzu.


Zostavenie URL

Služba je podriadeným zdrojom konkrétneho záznamu:

GET https://demo.flexibee.eu/c/demo/faktura-vydana/1/zmeny.json

V adrese /c/{firma}/{evidence}/{id}/zmeny je {firma} databázový identifikátor firmy, {evidence} evidencie a {id} identifikátor záznamu. Ako adresu poskladať, popisuje návod na zostavovanie URL adresy. Fungujú aj bežné parametre ako limit a add-row-count.


V ktorých evidenciách je prehľad dostupný

Do žurnálu sa ukladajú zmeny pre väčšinu, nie však pre všetky evidencie — subevidencia /zmeny je preto dostupná len na niektorých, rovnako ako v aplikácii:

  • faktúry vydané a prijaté,

  • banka, pokladňa a interné doklady,

  • prijaté a vydané objednávky,

  • príjemky a výdajky,

  • adresár,

  • cenník,

  • majetok,

  • cenové úrovne,

  • zákazky,

  • typy dokladov.

ℹ️ Chybu si nezamieňajte s dvomi rôznymi 404: formZaznamNenalezen znamená, že subevidencia existuje, ale záznam s daným ID nie. Kód adresaNeplatnaUrl naopak hovorí, že táto evidencia prehľad zmien vôbec nemá.


Ukážka výstupu

Každý riadok popisuje jednu zmenu jedného poľa — názov stĺpca v databáze, pôvodnú aj novú hodnotu, používateľa a čas:

{
"winstrom":{
"@version":"1.0",
"zmeny":[
{
"hlavicka_polozka":"Hlavička dok.",
"nazev":"",
"poradi_polozky":"",
"sloupec":"juhsum",
"puvodni_hodnota":"0.00",
"zmenena_na":"2500.00",
"uzivatelem":"knovak",
"operace":"změna",
"datcas":"2018.01.11 - 13:13:43"
},
{
"hlavicka_polozka":"Hlavička dok.",
"nazev":"",
"poradi_polozky":"",
"sloupec":"stavuhrk",
"puvodni_hodnota":"",
"zmenena_na":"stavUhr.uhrazeno",
"uzivatelem":"knovak",
"operace":"změna",
"datcas":"2018.01.11 - 13:13:43"
}
]
}
}

Pri dokladoch rozlišuje hlavicka_polozka a poradi_polozky, či išlo o zmenu hlavičky alebo konkrétnej položky, a operace nesie hodnoty ako vložené či zmena. Pri cenníku, adresári a číselníkoch sa tieto tri vlastnosti nevracajú — výstup obsahuje len nazev, sloupec, puvodni_hodnota, zmenena_na, uzivatelem a datcas.

📝 Vlastnosť sloupec obsahuje názov stĺpca v databáze (napríklad stavuhrk), nie názvy vlastností používané v REST API. Ak potrebujete naopak zistiť, ktoré záznamy sa od určitého okamihu zmenili, použite Changes API.


Súvisiace

Ste s tem dobili odgovor na svoje vprašanje?