Registrácia Prihlásenie

API stavu pracovného listu

Správa stavov pracovných listov

Koncové body

Autentifikácia

Ku každej API požiadavke je potrebné odoslať hlavičku X-API-KEY.

X-API-KEY: {vas_api_kluc}

Máte ešte otázky?

Napíšte nám tiket, alebo si pozrite naše centrum pomoci.

Ak sa vám páčilo, podeľte sa s ostatnými

Základná URL

https://{tenant}.logzi.com/api/worksheet_state/

Každá požiadavka vracia JSON odpoveď. Pri úspešnej odpovedi je result.code == 1, pri chybe result.code == 0. API stavu pracovného listu slúži na správu voľne definovateľných stavov pracovných listov s názvami podľa jazyka. Stav sa priraďuje k pracovnému listu poľom worksheet_state_id (API pracovného listu).

GET /api/worksheet_state/get

Získanie jedného záznamu stavu pracovného listu podľa identifikátora.

Parametre dotazu

ParameterTypPovinnéPopis
idintIdentifikátor stavu
language_idintIdentifikátor jazyka pre názov

Polia odpovede

PoleTypPopis
idintIdentifikátor stavu
namestringNázov vo vyžiadanom jazyku
name_keystringPrekladový kľúč
sort_orderintPoradie zoradenia
removeintPríznak odstránenia (0 / 1)
language_idintIdentifikátor jazyka

Príklad požiadavky

GET /api/worksheet_state/get?id=1&language_id=1
X-API-KEY: {vas_api_kluc}
GET /api/worksheet_state/get_all

Získanie názvov jedného stavu vo všetkých jazykoch (na úpravu).

Parametre dotazu

ParameterTypPovinnéPopis
idintIdentifikátor stavu (0 alebo prázdne: prázdny zoznam jazykov pre nový záznam)

Príklad požiadavky

GET /api/worksheet_state/get_all?id=1
X-API-KEY: {vas_api_kluc}
GET /api/worksheet_state/list

Získanie zoznamu stavov pracovných listov v danom jazyku podľa poradia zoradenia. Odstránené položky nie sú zahrnuté.

Parametre dotazu

ParameterTypPovinnéPopis
language_idintIdentifikátor jazyka

Príklad požiadavky

GET /api/worksheet_state/list?language_id=1
X-API-KEY: {vas_api_kluc}
POST /api/worksheet_state/save

Vytvorenie alebo úprava stavu pracovného listu. Ak je data[id] 0 alebo prázdne, vytvorí sa nový záznam.

POST polia - objekt data

PoleTypPovinnéPopis
idintIdentifikátor stavu (0 alebo prázdne = nový)
name_keystringPrekladový kľúč, najviac 50 znakov. Pre nový záznam jedinečný kľúč, napr. s_db_wsstate_<32-znakový md5>
data[<language_id>]stringNázov pre každý jazyk (aspoň 2 znaky)
sort_orderintPoradie zoradenia (predvolené: 0)

Príklad požiadavky

POST /api/worksheet_state/save
X-API-KEY: {vas_api_kluc}
Content-Type: application/json

{ "data": { "id": 0, "name_key": "s_db_wsstate_0f3c9a1b7d5e4c2a8b6d1e9f3a7c5b2d", "sort_order": 10, "data": { "1": "Folyamatban", "2": "In progress" } } }
POST /api/worksheet_state/delete

Odstránenie stavu pracovného listu (logické odstránenie, príznak remove sa nastaví na 1).

POST polia - objekt data

PoleTypPovinnéPopis
idintIdentifikátor stavu, ktorý sa má odstrániť

Príklad požiadavky

POST /api/worksheet_state/delete
X-API-KEY: {vas_api_kluc}
Content-Type: application/json

{ "data": { "id": 1 } }

Kontaktuj nás

Zaujíma ťa náš softvér? Pokojne nám napíš!

Odoslať dopyt

Potrebuješ pomoc?

Ak nevieš nájsť odpoveď a potrebuješ pomoc

Pozri sa do centra pomoci

Zaregistruj sa teraz,
zaplať neskôr!

Vyskúšaj 3 dni zadarmo, bez rizika a záväzkov!
Vytvorenie registrácie
Registrácia