The object containing metadata related to the learner interaction.
Taskbase Public API (0.9.0)
Download OpenAPI description
Languages
Servers
https://api.taskbase.com/
Bodyapplication/jsonrequired
answerFreeformTextAnswer (object) or InTextFillInBlanksAnswer (object) or InTextChoicesAnswer (object) or MultipleChoiceAnswer (object) or MultipleResponsesAnswer (object) or SimulationAnswer (object)required
Base class for task answers. The concrete type depends on the task type.
Example: {"content":"The Battle of Waterloo was in 1815."}
Defines the type of the task. Can be used by deserialization tools to instantiate the correct sub-type.
Enum"FREEFORM_TEXT""IN_TEXT_FILL_IN_BLANKS""IN_TEXT_CHOICES""MULTIPLE_CHOICE""MULTIPLE_RESPONSES""SIMULATION"
Example: "FREEFORM_TEXT"
Discriminator
- FREEFORM_TEXT
- IN_TEXT_FILL_IN_BLANKS
- IN_TEXT_CHOICES
- MULTIPLE_CHOICE
- MULTIPLE_RESPONSES
- SIMULATION
Freeform text task.
Example: {"id":"task_waterloo","problemStatement":"When was the Battle of Waterloo?","type":"FREEFORM_TEXT","sampleSolutions":[{"content":"The Battle of Waterloo was in 1815."}]}
The task ID. This field should contain the task identifier used in the client's system.
Defines the type of the task. Can be used by deserialization tools to instantiate the correct sub-type.
Enum"FREEFORM_TEXT""IN_TEXT_FILL_IN_BLANKS""IN_TEXT_CHOICES""MULTIPLE_CHOICE""MULTIPLE_RESPONSES""SIMULATION"
Discriminator
- FreeformTextTask
- InTextChoicesTask
- InTextFillInBlanksTask
- MultipleChoiceTask
- MultipleResponsesTask
- SimulationTask
The task language.
Default "EN_US"
Enum"DE_CH""DE_DE""EN_US""EN_UK""FR_FR""IT_IT""ES_ES"
The task title. If left blank, the taskDefinition.id will be used as the title during implicit task creation or update.
Example: "my_task_title"
The problem statement of the task.
Example: "When was the Battle of Waterloo?"
- https://api.taskbase.com/feedback/compute
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.taskbase.com/feedback/compute \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"userId": "student123",
"taskType": "FREEFORM_TEXT",
"taskDefinition": {
"id": "task_waterloo",
"problemStatement": "When was the Battle of Waterloo?",
"type": "FREEFORM_TEXT",
"sampleSolutions": [
{
"content": "The Battle of Waterloo was in 1815."
}
]
},
"answer": {
"content": "The Battle of Waterloo was in 1815."
}
}'Successful operation
The object containing metadata about the performed operation, along with helpful debugging information. Designed to simplify the integration process and does not include any production-related details that should be visible to the end user.
Defines the type of the task. Can be used by deserialization tools to instantiate the correct sub-type.
Enum"FREEFORM_TEXT""IN_TEXT_FILL_IN_BLANKS""IN_TEXT_CHOICES""MULTIPLE_CHOICE""MULTIPLE_RESPONSES""SIMULATION"
Discriminator
- FreeformTextFeedback
- InTextChoicesFeedback
- InTextFillInBlanksFeedback
- MultipleChoiceFeedback
- MultipleResponsesFeedback
- SimulationFeedback
Response
application/json
{ "result": { "allAspects": [ … ], "feedback": [ … ], "answer": { … }, "points": { … }, "sampleSolutions": [ … ], "sampleSolution": { … } }, "metaData": { "taskAction": "CREATED", "tenantId": "string", "taskLink": "string" }, "taskId": "string", "taskType": "FreeformTextFeedback", "userId": "string" }