assignments
Get one assignment with completion stats.
Get one assignment with completion stats.
OpenAPI specificationPOST
/api/v1/assignments/getAuthentication
bearerAuth
Request
curl --globoff --request POST \
--url 'https://honen.com/api/v1/assignments/get' \
--header 'Authorization: Bearer <BEARER_TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
"assignmentId": "<assignmentId>"
}'Replace credential and <field> placeholders with your own values. URL placeholders appear as %3Cfield%3E. Review the example values before sending your request.
Use the sample JSON body as your starting point, and enter values that match the endpoint's schema.
Request body schema or example
{
"type": "object",
"properties": {
"assignmentId": {
"type": "string"
}
},
"required": [
"assignmentId"
]
}Responses
200Command result.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
true
]
},
"data": {
"type": "object",
"properties": {
"assignment": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"WORKSPACE",
"GROUP",
"CUSTOM"
]
},
"name": {
"type": "string",
"nullable": true
},
"courseId": {
"type": "string"
},
"courseTitle": {
"type": "string"
},
"courseDescription": {
"type": "string",
"nullable": true
},
"groupId": {
"type": "string",
"nullable": true
},
"groupName": {
"type": "string",
"nullable": true
},
"assignedById": {
"type": "string"
},
"assignedByName": {
"type": "string"
},
"assignedAt": {
"type": "string"
},
"dueDate": {
"type": "string",
"nullable": true
},
"totalAssignees": {
"type": "number"
},
"completedCount": {
"type": "number"
},
"completionPercent": {
"type": "number"
},
"completionCriteria": {
"type": "object",
"properties": {
"activitiesPerTopic": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"ALL"
]
}
]
},
"testRequired": {
"type": "boolean",
"enum": [
false,
true
]
},
"testMinScore": {
"type": "number",
"nullable": true
},
"projectsRequired": {
"type": "boolean",
"enum": [
false,
true
]
},
"quizMinScore": {
"type": "number",
"nullable": true
},
"refreshersRequired": {
"type": "boolean",
"enum": [
false,
true
]
}
},
"required": [
"activitiesPerTopic",
"testRequired",
"testMinScore",
"projectsRequired",
"quizMinScore"
],
"nullable": true
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"INCLUDE",
"EXCLUDE"
]
},
"targetType": {
"type": "string",
"enum": [
"GROUP",
"USER",
"INVITE"
]
},
"groupId": {
"type": "string",
"nullable": true
},
"userId": {
"type": "string",
"nullable": true
}
},
"required": [
"kind",
"targetType",
"groupId",
"userId"
]
}
},
"assignedUsers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"userId": {
"type": "string"
},
"name": {
"type": "string",
"nullable": true
},
"email": {
"type": "string"
},
"avatarUrl": {
"type": "string",
"nullable": true
},
"complete": {
"type": "boolean",
"enum": [
false,
true
]
},
"progressPercent": {
"type": "number"
},
"completedAt": {
"type": "string",
"nullable": true
}
},
"required": [
"userId",
"name",
"email",
"avatarUrl",
"complete",
"progressPercent",
"completedAt"
]
}
}
},
"required": [
"id",
"type",
"name",
"courseId",
"courseTitle",
"courseDescription",
"groupId",
"groupName",
"assignedById",
"assignedByName",
"assignedAt",
"dueDate",
"totalAssignees",
"completedCount",
"completionPercent",
"completionCriteria",
"rules",
"assignedUsers"
]
}
},
"required": [
"assignment"
]
}
},
"required": [
"success",
"data"
]
}400Malformed JSON request body.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}401Missing or invalid Connector credentials.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}403Connector policy does not permit this command.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}404Unknown command.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}422Input validation error.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}