ulams templates

Generated from front/cli (ulams schema)

`ulams templates assign`

Assign template to model (of class assignable to the Variable Set).

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

Endpoints: POST /api/admin/templates/{id}/assign.

Flag	Type	Required	Description
`--id` (positional)	string	yes	Unique id of template
`--assignable-id`	integer

# Assign template to model (of class assignable to the Variable Set)
ulams templates assign text --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique id of template"
    },
    "assignable_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}

`ulams templates assignable`

Get Templates that can be assigned to model.

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

Endpoints: GET /api/admin/templates/assignable.

Flag	Type	Description
`--assignable-class`	string	Class of assignable model for which we want to find assignable Templates
`--channel`	string	Class of channel for which we want to find assignable Templates
`--event`	string	Class of event for which we want to find assignable Templates

# Get Templates that can be assigned to model
ulams templates assignable --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "assignable_class": {
      "type": "string",
      "description": "Class of assignable model for which we want to find assignable Templates"
    },
    "channel": {
      "type": "string",
      "description": "Class of channel for which we want to find assignable Templates"
    },
    "event": {
      "type": "string",
      "description": "Class of event for which we want to find assignable Templates"
    }
  },
  "additionalProperties": {}
}

`ulams templates assigned`

Get Template assigned to the model.

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

Endpoints: GET /api/admin/templates/assigned.

Flag	Type	Required	Description
`--assignable-class`	string	yes	Class of assignable model for which we want to fetch assigned Template
`--assignable-id`	integer	yes	Id of assignable model for which we want to fetch assigned Template

# Get Template assigned to the model
ulams templates assigned --assignable-class text --assignable-id text --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "assignable_class": {
      "type": "string",
      "description": "Class of assignable model for which we want to fetch assigned Template"
    },
    "assignable_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "Id of assignable model for which we want to fetch assigned Template"
    }
  },
  "required": [
    "assignable_class",
    "assignable_id"
  ],
  "additionalProperties": {}
}

`ulams templates create`

Create a new template identified by id.

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

Endpoints: POST /api/admin/templates.

Flag	Type	Description
`--channel`	string	channel full classname
`--default`	boolean	this template is default template for given channel and event pair
`--event`	string	event full classname
`--id`	integer	template id
`--name`	string	template name

# Create a new template identified by id
ulams templates create --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "channel": {
      "type": "string",
      "description": "channel full classname"
    },
    "default": {
      "type": "boolean",
      "description": "this template is default template for given channel and event pair"
    },
    "event": {
      "type": "string",
      "description": "event full classname"
    },
    "id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "template id"
    },
    "name": {
      "type": "string",
      "description": "template name"
    }
  },
  "additionalProperties": {}
}

`ulams templates delete`

Delete a template identified by a id.

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

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

Flag	Type	Required	Description
`--id` (positional)	integer	yes	Unique human-readable template identifier

# Delete a template identified by a id
ulams templates 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": "Unique human-readable template identifier"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}

`ulams templates get`

Read a template identified by a given id identifier.

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

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

Flag	Type	Required	Description
`--id` (positional)	string	yes	Unique human-readable template identifier

# Read a template identified by a given id identifier
ulams templates get text --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique human-readable template identifier"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}

`ulams templates list`

Lists available templates.

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

Endpoints: GET /api/admin/templates.

Flag	Type	Required	Description
`--channel`	string		Channel class for filtering
`--event`	string		Event class for filtering

# Lists available templates
ulams templates list --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "channel": {
      "type": "string",
      "description": "Channel class for filtering"
    },
    "event": {
      "type": "string",
      "description": "Event class for filtering"
    }
  },
  "additionalProperties": {}
}

`ulams templates preview`

Read a template identified by a given id identifier.

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

Endpoints: GET /api/admin/templates/{id}/preview.

Flag	Type	Required	Description
`--id` (positional)	string	yes	Unique human-readable template identifier

# Read a template identified by a given id identifier
ulams templates preview text --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique human-readable template identifier"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}

`ulams templates unassign`

Remove template assignment to model.

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

Endpoints: POST /api/admin/templates/{id}/unassign.

Flag	Type	Required	Description
`--id` (positional)	string	yes	Unique id of template
`--assignable-id`	integer

# Remove template assignment to model
ulams templates unassign text --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique id of template"
    },
    "assignable_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}

`ulams templates update`

Update an existing template identified by id.

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

Endpoints: PATCH /api/admin/templates/{id}.

Flag	Type	Required	Description
`--id` (positional)	integer	yes	Unique human-readable template identifier
`--channel`	string		channel full classname
`--default`	boolean		this template is default template for given channel and event pair
`--event`	string		event full classname
`--name`	string		template name

# Update an existing template identified by id
ulams templates 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": "Unique human-readable template identifier"
    },
    "channel": {
      "type": "string",
      "description": "channel full classname"
    },
    "default": {
      "type": "boolean",
      "description": "this template is default template for given channel and event pair"
    },
    "event": {
      "type": "string",
      "description": "event full classname"
    },
    "name": {
      "type": "string",
      "description": "template name"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}

`ulams templates variables`

Dictionary list of available template variables.

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

Endpoints: GET /api/admin/templates/variables.

# Dictionary list of available template variables
ulams templates variables --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}