Skip to content
ulamsulamsulams docs

ulams questionnaire-questions

Generated from front/cli (ulams schema)

ulams questionnaire-questions create

Section titled “ulams questionnaire-questions create”

Create a new question identified by id.

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

Endpoints: POST /api/admin/question.

Flag Type Required Description
--active boolean question is active
--description string question description
--max-score integer maximum score for question
--position integer question position
--public-answers boolean whether answers to questions are public
--questionnaire-id integer yes identifier of the questionnaire object
--title string yes question title
--type string type: rate, text
Terminal window
# Create a new question identified by id
ulams questionnaire-questions create --questionnaire-id text --title Example --json
Input JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "active": {
      "type": "boolean",
      "description": "question is active"
    },
    "description": {
      "type": "string",
      "description": "question description"
    },
    "max_score": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "maximum score for question"
    },
    "position": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "question position"
    },
    "public_answers": {
      "type": "boolean",
      "description": "whether answers to questions are public"
    },
    "questionnaire_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "identifier of the questionnaire object"
    },
    "title": {
      "type": "string",
      "description": "question title"
    },
    "type": {
      "type": "string",
      "description": "type: rate, text"
    }
  },
  "required": [
    "questionnaire_id",
    "title"
  ],
  "additionalProperties": {}
}

ulams questionnaire-questions delete

Section titled “ulams questionnaire-questions delete”

Delete a question identified by a id.

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

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

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

ulams questionnaire-questions get

Section titled “ulams questionnaire-questions get”

Read a question identified by a given id identifier.

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

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

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

ulams questionnaire-questions list

Section titled “ulams questionnaire-questions list”

Lists available questions.

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

Endpoints: GET /api/admin/question.

Terminal window
# Lists available questions
ulams questionnaire-questions list --json
Input JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}

ulams questionnaire-questions update

Section titled “ulams questionnaire-questions update”

Update an existing question identified by id.

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

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

Flag Type Required Description
--id (positional) integer yes Unique human-readable question identifier
--active boolean question is active
--description string question description
--max-score integer maximum score for question
--position integer question position
--public-answers boolean whether answers to questions are public
--questionnaire-id integer identifier of the questionnaire object
--title string question title
--type string type: rate, text
Terminal window
# Update an existing question identified by id
ulams questionnaire-questions 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 question identifier"
    },
    "active": {
      "type": "boolean",
      "description": "question is active"
    },
    "description": {
      "type": "string",
      "description": "question description"
    },
    "max_score": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "maximum score for question"
    },
    "position": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "question position"
    },
    "public_answers": {
      "type": "boolean",
      "description": "whether answers to questions are public"
    },
    "questionnaire_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "identifier of the questionnaire object"
    },
    "title": {
      "type": "string",
      "description": "question title"
    },
    "type": {
      "type": "string",
      "description": "type: rate, text"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}