ulams dictionaries

ulams dictionaries access-add

Add users with access to the dictionary.

Kind: write. Stability: stable. MCP tool: dictionaries_access_add. Scopes: courses:write.

Endpoints: POST /api/admin/dictionaries/{id}/access.

Flag	Type	Required	Description
--id (positional)	integer	yes	id of Dictionary
--users	array	yes

# Add users with access to the dictionary
ulams dictionaries access-add 1 --users text --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 Dictionary"
    },
    "users": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "end_date": {
            "type": "string"
          },
          "user_id": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "required": [
    "id",
    "users"
  ],
  "additionalProperties": {}
}

ulams dictionaries access-list

Get list of users with access to the dictionary.

Kind: read (idempotent). Stability: stable. MCP tool: dictionaries_access_list. Scopes: courses:read.

Endpoints: GET /api/admin/dictionaries/{id}/access.

Flag	Type	Required	Description
--id (positional)	integer	yes	id of Dictionary

# Get list of users with access to the dictionary
ulams dictionaries access-list 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 Dictionary"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}

ulams dictionaries create

Store a newly created dictionary in storage.

Kind: write. Stability: stable. MCP tool: dictionaries_create. Scopes: courses:write.

Endpoints: POST /api/admin/dictionaries.

Flag	Type	Required	Description
--free-views-count	integer
--name	string	yes

# Store a newly created dictionary in storage
ulams dictionaries create --name Example --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "free_views_count": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "name": {
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": {}
}

ulams dictionaries delete

Remove the specified Dictionary from storage.

Kind: destructive (idempotent). Stability: stable. MCP tool: dictionaries_delete. Scopes: courses:write.

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

Flag	Type	Required	Description
--id (positional)	integer	yes	id of Dictionary

# Remove the specified Dictionary from storage
ulams dictionaries 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 Dictionary"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}

ulams dictionaries get

Display the specified Dictionary.

Kind: read (idempotent). Stability: stable. MCP tool: dictionaries_get. Scopes: courses:read.

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

Flag	Type	Required	Description
--id (positional)	integer	yes	id of Dictionary

# Display the specified Dictionary
ulams dictionaries 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 Dictionary"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}

ulams dictionaries list

Get a listing of the Dictionaries.

Kind: read (idempotent). Stability: stable. MCP tool: dictionaries_list. Scopes: courses:read.

Endpoints: GET /api/admin/dictionaries.

Flag	Type	Required	Description
--order-by	string
--order	string
--page	number		Pagination Page Number
--per-page	number		Pagination Per Page
--name	string		name %LIKE%

# Get a listing of the Dictionaries
ulams dictionaries list --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "order_by": {
      "type": "string",
      "enum": [
        "id",
        "name",
        "created_at"
      ]
    },
    "order": {
      "type": "string",
      "enum": [
        "ASC",
        "DESC"
      ]
    },
    "page": {
      "type": "number",
      "description": "Pagination Page Number"
    },
    "per_page": {
      "type": "number",
      "description": "Pagination Per Page"
    },
    "name": {
      "type": "string",
      "description": "name %LIKE%"
    }
  },
  "additionalProperties": {}
}

ulams dictionaries update

Update the specified Dictionary in storage.

Kind: write (idempotent). Stability: stable. MCP tool: dictionaries_update. Scopes: courses:write.

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

Flag	Type	Required	Description
--id (positional)	integer	yes	id of Dictionary
--free-views-count	integer
--name	string

# Update the specified Dictionary in storage
ulams dictionaries 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 Dictionary"
    },
    "free_views_count": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "name": {
      "type": "string"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}