Basis-URL
https://{tenant}.logzi.com/api/worksheet_state/
Jede Anfrage liefert eine JSON-Antwort zurück. Bei Erfolg ist result.code == 1, bei einem Fehler result.code == 0. Die Arbeitsblatt-Zustand-API dient der Verwaltung der frei definierbaren Arbeitsblatt-Zustände mit sprachspezifischen Bezeichnungen. Ein Zustand wird dem Arbeitsblatt über das Feld worksheet_state_id zugewiesen (Arbeitsblatt-API).
/api/worksheet_state/get
Abrufen eines einzelnen Arbeitsblatt-Zustand-Datensatzes anhand der ID.
Query-Parameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | ID des Zustands | |
language_id | int | ID der Sprache für die Bezeichnung |
Antwortfelder
| Feld | Typ | Beschreibung |
|---|---|---|
id | int | ID des Zustands |
name | string | Bezeichnung in der angeforderten Sprache |
name_key | string | Übersetzungsschlüssel |
sort_order | int | Sortierreihenfolge |
remove | int | Löschkennzeichen (0 / 1) |
language_id | int | ID der Sprache |
Beispielanfrage
GET /api/worksheet_state/get?id=1&language_id=1
X-API-KEY: {ihr_api_schluessel}/api/worksheet_state/get_all
Abrufen der Bezeichnungen eines Zustands in allen Sprachen (zur Bearbeitung).
Query-Parameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | ID des Zustands (0 oder leer: leere Sprachliste für einen neuen Datensatz) |
Beispielanfrage
GET /api/worksheet_state/get_all?id=1
X-API-KEY: {ihr_api_schluessel}/api/worksheet_state/list
Abrufen der Liste der Arbeitsblatt-Zustände in einer bestimmten Sprache, nach Sortierreihenfolge. Gelöschte Einträge sind nicht enthalten.
Query-Parameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
language_id | int | ID der Sprache |
Beispielanfrage
GET /api/worksheet_state/list?language_id=1
X-API-KEY: {ihr_api_schluessel}/api/worksheet_state/save
Erstellen oder Ändern eines Arbeitsblatt-Zustands. Ist data[id] 0 oder leer, wird ein neuer Datensatz angelegt.
POST-Felder - data-Objekt
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | ID des Zustands (0 oder leer = neu) | |
name_key | string | Übersetzungsschlüssel, max. 50 Zeichen. Für einen neuen Datensatz ein eindeutiger Schlüssel, z. B. s_db_wsstate_<32 Zeichen md5> | |
data[<language_id>] | string | Bezeichnung je Sprache (mindestens 2 Zeichen) | |
sort_order | int | Sortierreihenfolge (Standard: 0) |
Beispielanfrage
POST /api/worksheet_state/save
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{ "data": { "id": 0, "name_key": "s_db_wsstate_0f3c9a1b7d5e4c2a8b6d1e9f3a7c5b2d", "sort_order": 10, "data": { "1": "Folyamatban", "2": "In progress" } } }/api/worksheet_state/delete
Löschen eines Arbeitsblatt-Zustands (logisches Löschen, das Kennzeichen remove wird auf 1 gesetzt).
POST-Felder - data-Objekt
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | ID des zu löschenden Zustands |
Beispielanfrage
POST /api/worksheet_state/delete
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{ "data": { "id": 1 } }Interessierst du dich für unsere Software? Schreib uns einfach!
Jetzt registrieren,
später bezahlen!
