Base URL
https://{tenant}.logzi.com/api/worksheet_state/
Every request returns a JSON response. On success result.code == 1; on failure result.code == 0. The worksheet state API is used to manage the freely definable worksheet states, with language-specific names. A state is assigned to a worksheet with the worksheet_state_id field (Worksheet API).
/api/worksheet_state/get
Retrieve a single worksheet state record by ID.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int | State identifier | |
language_id | int | Language identifier for the name |
Response fields
| Field | Type | Description |
|---|---|---|
id | int | State identifier |
name | string | Name in the requested language |
name_key | string | Translation key |
sort_order | int | Sort order |
remove | int | Deleted flag (0 / 1) |
language_id | int | Language identifier |
Example request
GET /api/worksheet_state/get?id=1&language_id=1
X-API-KEY: {your_api_key}/api/worksheet_state/get_all
Retrieve the names of a state in all languages (for editing).
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int | State identifier (0 or empty: empty language list for a new record) |
Example request
GET /api/worksheet_state/get_all?id=1
X-API-KEY: {your_api_key}/api/worksheet_state/list
Retrieve the list of worksheet states in the given language, ordered by sort order. Deleted items are not included.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
language_id | int | Language identifier |
Example request
GET /api/worksheet_state/list?language_id=1
X-API-KEY: {your_api_key}/api/worksheet_state/save
Create or update a worksheet state. If data[id] is 0 or empty, a new record is created.
POST fields - data object
| Field | Type | Required | Description |
|---|---|---|---|
id | int | State identifier (0 or empty = new) | |
name_key | string | Translation key, max. 50 characters. For a new record use a unique key, e.g. s_db_wsstate_<32 character md5> | |
data[<language_id>] | string | Name per language (at least 2 characters) | |
sort_order | int | Sort order (default: 0) |
Example request
POST /api/worksheet_state/save
X-API-KEY: {your_api_key}
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
Delete a worksheet state (soft delete, the remove flag is set to 1).
POST fields - data object
| Field | Type | Required | Description |
|---|---|---|---|
id | int | Identifier of the state to delete |
Example request
POST /api/worksheet_state/delete
X-API-KEY: {your_api_key}
Content-Type: application/json
{ "data": { "id": 1 } }Create your account now,
pay later!
