ulams cmi5

ulams cmi5 delete

Delete cmi5 package by id.

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

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

Flag	Type	Required	Description
--id (positional)	number	yes	Cmi5 id

# Delete cmi5 package by id
ulams cmi5 delete 1 --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "Cmi5 id"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}

ulams cmi5 list

Get a listing of the cmi5.

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

Endpoints: GET /api/admin/cmi5/.

Flag	Type	Required	Description
--page	number		page
--per-page	number		per_page

# Get a listing of the cmi5
ulams cmi5 list --json

Input JSON Schema

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

ulams cmi5 statements

Lists available statements.

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

Endpoints: GET /api/admin/cmi5/statements.

Flag	Type	Required	Description
--order-by	string
--order	string
--page	number		Pagination Page Number
--per-page	number		Pagination Per Page
--verb	string		Verb display name or id
--account	string		Account name or homePage
--registration	string		Registration uuid
--object	string		Object type
--version	string		Version
--date-from	string		Date from
--date-to	string		Date to

# Lists available statements
ulams cmi5 statements --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "order_by": {
      "type": "string",
      "enum": [
        "created_at",
        "id"
      ]
    },
    "order": {
      "type": "string",
      "enum": [
        "ASC",
        "DESC"
      ]
    },
    "page": {
      "type": "number",
      "description": "Pagination Page Number"
    },
    "per_page": {
      "type": "number",
      "description": "Pagination Per Page"
    },
    "verb": {
      "type": "string",
      "description": "Verb display name or id"
    },
    "account": {
      "type": "string",
      "description": "Account name or homePage"
    },
    "registration": {
      "type": "string",
      "description": "Registration uuid"
    },
    "object": {
      "type": "string",
      "description": "Object type"
    },
    "version": {
      "type": "string",
      "description": "Version"
    },
    "date_from": {
      "type": "string",
      "description": "Date from"
    },
    "date_to": {
      "type": "string",
      "description": "Date to"
    }
  },
  "additionalProperties": {}
}

ulams cmi5 upload

Convert ZIP Cmi5 Package into Ulams LMS Cmi5 storage.

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

Endpoints: POST /api/admin/cmi5.

Flag	Type	Required	Description
--file	string	yes	Path of a local file (.zip)

# Convert ZIP Cmi5 Package into Ulams LMS Cmi5 storage
ulams cmi5 upload --file text --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "file": {
      "type": "string",
      "description": "Path of a local file (.zip)"
    }
  },
  "required": [
    "file"
  ],
  "additionalProperties": {}
}