Skip to content
ulamsulamsulams docs

ulams questionnaire

Generated from front/cli (ulams schema)

ulams questionnaire assign

Section titled “ulams questionnaire assign”

assign a questionnaire model.

Kind: write. Stability: stable. MCP tool: questionnaire_assign. Scopes: reports:write.

Endpoints: PATCH /api/admin/questionnaire/assign/{model_type_title}/{model_id}/{id}/{target_group}.

Flag Type Required Description
--model-type-title (positional) string yes Name of Model (Course, Webinar etd.)
--model-id (positional) integer yes id of Model (Course, Webinar etd.)
--id (positional) integer yes id of questionnaire
--target-group (positional) string yes Target Group: user or author
--display-frequency-minutes integer Display frequency in minutes
Terminal window
# assign a questionnaire model
ulams questionnaire assign text 1 1 text --json
Input JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "model_type_title": {
      "type": "string",
      "description": "Name of Model (Course, Webinar etd.)"
    },
    "model_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "id of Model (Course, Webinar etd.)"
    },
    "id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "id of questionnaire"
    },
    "target_group": {
      "type": "string",
      "description": "Target Group: user or author"
    },
    "display_frequency_minutes": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "Display frequency in minutes"
    }
  },
  "required": [
    "model_type_title",
    "model_id",
    "id",
    "target_group"
  ],
  "additionalProperties": {}
}

ulams questionnaire create

Section titled “ulams questionnaire create”

Create a new questionnaire.

Kind: write. Stability: stable. MCP tool: questionnaire_create. Scopes: reports:write.

Endpoints: POST /api/admin/questionnaire.

Flag Type Required Description
--active boolean Questionnaire is active
--models array
--questions array
--title string yes questionnaire title
Terminal window
# Create a new questionnaire
ulams questionnaire create --title Example --json
Input JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "active": {
      "type": "boolean",
      "description": "Questionnaire is active"
    },
    "models": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "display_frequency_minutes": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "model_id": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "model_title": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "model_type_id": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "questionnaire_id": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "target_group": {
            "type": "string"
          }
        },
        "required": [
          "model_id",
          "model_type_id",
          "questionnaire_id"
        ],
        "additionalProperties": {}
      }
    },
    "questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "active": {
            "type": "boolean"
          },
          "description": {
            "type": "string"
          },
          "max_score": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "position": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "public_answers": {
            "type": "boolean"
          },
          "questionnaire_id": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "title": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "questionnaire_id",
          "title"
        ],
        "additionalProperties": {}
      }
    },
    "title": {
      "type": "string",
      "description": "questionnaire title"
    }
  },
  "required": [
    "title"
  ],
  "additionalProperties": {}
}

ulams questionnaire delete

Section titled “ulams questionnaire delete”

Delete a questionnaire identified by a id.

Kind: destructive (idempotent). Stability: stable. MCP tool: questionnaire_delete. Scopes: reports:write.

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

Flag Type Required Description
--id (positional) integer yes Unique human-readable questionnaire identifier
Terminal window
# Delete a questionnaire identified by a id
ulams questionnaire 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 questionnaire identifier"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}

ulams questionnaire get

Section titled “ulams questionnaire get”

Read a questionnaire identified by a given id identifier.

Kind: read (idempotent). Stability: stable. MCP tool: questionnaire_get. Scopes: reports:read.

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

Flag Type Required Description
--id (positional) integer yes Unique human-readable questionnaire identifier
Terminal window
# Read a questionnaire identified by a given id identifier
ulams questionnaire 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": "Unique human-readable questionnaire identifier"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}

ulams questionnaire list

Section titled “ulams questionnaire list”

Lists available questionnaires.

Kind: read (idempotent). Stability: stable. MCP tool: questionnaire_list. Scopes: reports:read.

Endpoints: GET /api/admin/questionnaire.

Flag Type Required Description
--page integer
--per-page integer
--order-by string
--order string
--title string
Terminal window
# Lists available questionnaires
ulams questionnaire list --json
Input JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "per_page": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "order_by": {
      "type": "string",
      "enum": [
        "id",
        "created_at",
        "title"
      ]
    },
    "order": {
      "type": "string",
      "enum": [
        "ASC",
        "DESC"
      ]
    },
    "title": {
      "type": "string"
    }
  },
  "additionalProperties": {}
}

ulams questionnaire report

Section titled “ulams questionnaire report”

Read a questionnaire report identified by a given id identifier and model type and model identified.

Kind: read (idempotent). Stability: stable. MCP tool: questionnaire_report. Scopes: reports:read.

Endpoints: GET /api/admin/questionnaire/report/{id}/{model_type_id}/{model_id}.

Flag Type Required Description
--id (positional) integer yes questionnaire identifier
--model-type-id (positional) integer yes questionnaire model type identified
--model-id (positional) integer yes model identifier
Terminal window
# Read a questionnaire report identified by a given id identifier and model type and model identified
ulams questionnaire report 1 1 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": "questionnaire identifier"
    },
    "model_type_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "questionnaire model type identified"
    },
    "model_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "model identifier"
    }
  },
  "required": [
    "id",
    "model_type_id",
    "model_id"
  ],
  "additionalProperties": {}
}

ulams questionnaire unassign-delete

Section titled “ulams questionnaire unassign-delete”

unassign a questionnaire model.

Kind: destructive (idempotent). Stability: stable. MCP tool: questionnaire_unassign_delete. Scopes: reports:write.

Endpoints: DELETE /api/admin/questionnaire/unassign/{model_type_title}/{model_id}/{id}/{target_group}.

Flag Type Required Description
--model-type-title (positional) string yes Name of Model (Course, Webinar etd.)
--model-id (positional) integer yes id of Model (Course, Webinar etd.)
--id (positional) integer yes id of questionnaire
--target-group (positional) string yes Target Group: user or author
Terminal window
# unassign a questionnaire model
ulams questionnaire unassign-delete text 1 1 text --json
Input JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "model_type_title": {
      "type": "string",
      "description": "Name of Model (Course, Webinar etd.)"
    },
    "model_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "id of Model (Course, Webinar etd.)"
    },
    "id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "id of questionnaire"
    },
    "target_group": {
      "type": "string",
      "description": "Target Group: user or author"
    }
  },
  "required": [
    "model_type_title",
    "model_id",
    "id",
    "target_group"
  ],
  "additionalProperties": {}
}

ulams questionnaire update

Section titled “ulams questionnaire update”

Update an existing questionnaire identified by id.

Kind: write. Stability: stable. MCP tool: questionnaire_update. Scopes: reports:write.

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

Flag Type Required Description
--id (positional) integer yes Unique human-readable questionnaire identifier
--active boolean Questionnaire is active
--models array
--questions array
--title string questionnaire title
Terminal window
# Update an existing questionnaire identified by id
ulams questionnaire 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 questionnaire identifier"
    },
    "active": {
      "type": "boolean",
      "description": "Questionnaire is active"
    },
    "models": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "display_frequency_minutes": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "model_id": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "model_title": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "model_type_id": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "questionnaire_id": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "target_group": {
            "type": "string"
          }
        },
        "required": [
          "model_id",
          "model_type_id",
          "questionnaire_id"
        ],
        "additionalProperties": {}
      }
    },
    "questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "active": {
            "type": "boolean"
          },
          "description": {
            "type": "string"
          },
          "max_score": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "position": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "public_answers": {
            "type": "boolean"
          },
          "questionnaire_id": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "title": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "questionnaire_id",
          "title"
        ],
        "additionalProperties": {}
      }
    },
    "title": {
      "type": "string",
      "description": "questionnaire title"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}