Skip to content

ulams model-fields

Generated from front/cli (ulams schema)

Create or update metafile.

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

Endpoints: POST /api/admin/model-fields.

Flag Type Required Description
--class-id string class_id
--class-type string class_type
--default string default
--extra object extra
--id integer id
--name string name
--rules object rules
--value string value
--visibility object visibility
Terminal window
# Create or update metafile
ulams model-fields create --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"class_id": {
"type": "string",
"description": "class_id"
},
"class_type": {
"type": "string",
"description": "class_type"
},
"default": {
"type": "string",
"description": "default"
},
"extra": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {},
"description": "extra"
},
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "id"
},
"name": {
"type": "string",
"description": "name"
},
"rules": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {},
"description": "rules"
},
"value": {
"type": "string",
"description": "value"
},
"visibility": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {},
"description": "visibility"
}
},
"additionalProperties": {}
}

delete metafile and related values from model.

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

Endpoints: DELETE /api/admin/model-fields.

Flag Type Required Description
--class-id string class_id
--class-type string class_type
--default string default
--extra object extra
--id integer id
--name string name
--rules object rules
--value string value
--visibility object visibility
Terminal window
# delete metafile and related values from model
ulams model-fields delete --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"class_id": {
"type": "string",
"description": "class_id"
},
"class_type": {
"type": "string",
"description": "class_type"
},
"default": {
"type": "string",
"description": "default"
},
"extra": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {},
"description": "extra"
},
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "id"
},
"name": {
"type": "string",
"description": "name"
},
"rules": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {},
"description": "rules"
},
"value": {
"type": "string",
"description": "value"
},
"visibility": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {},
"description": "visibility"
}
},
"additionalProperties": {}
}

Lists available Model extended fields.

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

Endpoints: GET /api/admin/model-fields.

Flag Type Required Description
--class-type string yes class type of which field is extended
--page integer pagination page number
--per-page integer number of items per page
--order string order direction
--order-by string order by field
Terminal window
# Lists available Model extended fields
ulams model-fields list --class-type text --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"class_type": {
"type": "string",
"description": "class type of which field is extended"
},
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "pagination page number"
},
"per_page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "number of items per page"
},
"order": {
"type": "string",
"description": "order direction"
},
"order_by": {
"type": "string",
"description": "order by field"
}
},
"required": [
"class_type"
],
"additionalProperties": {}
}