Skip to content

ulams adapt

Generated from front/cli (ulams schema)

Build the current version into a SCORM package (queued).

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

Endpoints: POST /api/admin/adapt/{id}/build.

Flag Type Required Description
--id (positional) integer yes
--body unknown Request body (JSON)
Terminal window
# Build the current version into a SCORM package (queued)
ulams adapt build 1 --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"body": {
"description": "Request body (JSON)"
}
},
"required": [
"id"
],
"additionalProperties": {}
}

Create from Adapt JSON (course, config, contentObjects, articles, blocks, components).

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

Endpoints: POST /api/admin/adapt.

Flag Type Required Description
--body unknown Request body (JSON)
Terminal window
# Create from Adapt JSON (course, config, contentObjects, articles, blocks, components)
ulams adapt create --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"body": {
"description": "Request body (JSON)"
}
},
"additionalProperties": {}
}

Delete a source (the built SCORM package stays).

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

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

Flag Type Required Description
--id (positional) integer yes
Terminal window
# Delete a source (the built SCORM package stays)
ulams adapt 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
}
},
"required": [
"id"
],
"additionalProperties": {}
}

Show a source and its build status.

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

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

Flag Type Required Description
--id (positional) integer yes
Terminal window
# Show a source and its build status
ulams adapt 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
}
},
"required": [
"id"
],
"additionalProperties": {}
}

List Adapt JSON sources.

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

Endpoints: GET /api/admin/adapt.

Terminal window
# List Adapt JSON sources
ulams adapt list --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": {}
}

JSON of the current or a given version.

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

Endpoints: GET /api/admin/adapt/{id}/source.

Flag Type Required Description
--id (positional) integer yes
Terminal window
# JSON of the current or a given version
ulams adapt source 1 --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"id"
],
"additionalProperties": {}
}

Add a version.

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

Endpoints: POST /api/admin/adapt/{id}/versions.

Flag Type Required Description
--id (positional) integer yes
--body unknown Request body (JSON)
Terminal window
# Add a version
ulams adapt versions-add 1 --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"body": {
"description": "Request body (JSON)"
}
},
"required": [
"id"
],
"additionalProperties": {}
}

Version history (version, change note, author, date; no source).

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

Endpoints: GET /api/admin/adapt/{id}/versions.

Flag Type Required Description
--id (positional) integer yes
Terminal window
# Version history (version, change note, author, date; no source)
ulams adapt versions-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
}
},
"required": [
"id"
],
"additionalProperties": {}
}