Skip to content

ulams translations

Generated from front/cli (ulams schema)

Store a newly created translation.

Kind: write. Stability: stable. MCP tool: translations_create. Scopes: settings:write.

Endpoints: POST /api/admin/translations.

Flag Type Required Description
--group string group
--key string key
--text object yes text
Terminal window
# Store a newly created translation
ulams translations create --text text --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"group": {
"type": "string",
"description": "group"
},
"key": {
"type": "string",
"description": "key"
},
"text": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {},
"description": "text"
}
},
"required": [
"text"
],
"additionalProperties": {}
}

Remove the specified translation.

Kind: destructive (idempotent). Stability: stable. MCP tool: translations_delete. Scopes: settings:write.

Endpoints: DELETE /api/admin/translations/{id}.

Flag Type Required Description
--id (positional) integer yes id of translation
Terminal window
# Remove the specified translation
ulams translations delete 1 --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "id of translation"
}
},
"required": [
"id"
],
"additionalProperties": {}
}

Display the specified translation.

Kind: read (idempotent). Stability: stable. MCP tool: translations_get. Scopes: settings:read.

Endpoints: GET /api/admin/translations/{id}.

Flag Type Required Description
--id (positional) integer yes id of translation
Terminal window
# Display the specified translation
ulams translations get 1 --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "id of translation"
}
},
"required": [
"id"
],
"additionalProperties": {}
}

Get a list of translations stored in the database.

Kind: read (idempotent). Stability: stable. MCP tool: translations_list. Scopes: settings:read.

Endpoints: GET /api/admin/translations.

Flag Type Required Description
--order-by string
--order string
--page number Pagination Page Number
--per-page number Pagination Per Page
--group string Group
--key string
--public boolean
Terminal window
# Get a list of translations stored in the database
ulams translations list --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"order_by": {
"type": "string"
},
"order": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"page": {
"type": "number",
"description": "Pagination Page Number"
},
"per_page": {
"type": "number",
"description": "Pagination Per Page"
},
"group": {
"type": "string",
"description": "Group"
},
"key": {
"type": "string"
},
"public": {
"type": "boolean"
}
},
"additionalProperties": {}
}

Retrieve translation.

Kind: write. Stability: stable. MCP tool: translations_retrieve. Scopes: settings:write.

Endpoints: POST /api/admin/translations/retrieve.

Flag Type Required Description
--key string yes key
--replace object replace
Terminal window
# Retrieve translation
ulams translations retrieve --key text --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "key"
},
"replace": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {},
"description": "replace"
}
},
"required": [
"key"
],
"additionalProperties": {}
}

Update the specified translation.

Kind: write (idempotent). Stability: stable. MCP tool: translations_update. Scopes: settings:write.

Endpoints: PUT /api/admin/translations/{id}.

Flag Type Required Description
--id (positional) integer yes id of translation
--group string group
--key string key
--text object text
Terminal window
# Update the specified translation
ulams translations update 1 --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "id of translation"
},
"group": {
"type": "string",
"description": "group"
},
"key": {
"type": "string",
"description": "key"
},
"text": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {},
"description": "text"
}
},
"required": [
"id"
],
"additionalProperties": {}
}