313 lines
12 KiB
Markdown
313 lines
12 KiB
Markdown
---
|
|
name: assignments-routes
|
|
description: Handle 30 OpenAPI operation(s) under /api/v1/assignments for the assignments route group.
|
|
---
|
|
|
|
# assignments API Routes
|
|
|
|
Handle 30 OpenAPI operation(s) under /api/v1/assignments for the assignments route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### api_create_assignments_api_v1_assignments_post
|
|
|
|
- Operation ID: `api_create_assignments_api_v1_assignments_post`
|
|
- Route: `POST /api/v1/assignments/`
|
|
- Mode: WRITE
|
|
- Summary: Create assignment
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_read_assignment_api_v1_assignments_assignment_uuid_get
|
|
|
|
- Operation ID: `api_read_assignment_api_v1_assignments_assignment_uuid_get`
|
|
- Route: `GET /api/v1/assignments/{assignment_uuid}`
|
|
- Mode: READ
|
|
- Summary: Get assignment
|
|
- Parameters:
|
|
- `assignment_uuid` in `path` required
|
|
|
|
### api_update_assignment_api_v1_assignments_assignment_uuid_put
|
|
|
|
- Operation ID: `api_update_assignment_api_v1_assignments_assignment_uuid_put`
|
|
- Route: `PUT /api/v1/assignments/{assignment_uuid}`
|
|
- Mode: WRITE
|
|
- Summary: Update assignment
|
|
- Parameters:
|
|
- `assignment_uuid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_delete_assignment_api_v1_assignments_assignment_uuid_delete
|
|
|
|
- Operation ID: `api_delete_assignment_api_v1_assignments_assignment_uuid_delete`
|
|
- Route: `DELETE /api/v1/assignments/{assignment_uuid}`
|
|
- Mode: WRITE
|
|
- Summary: Delete assignment
|
|
- Parameters:
|
|
- `assignment_uuid` in `path` required
|
|
|
|
### api_read_assignment_from_activity_api_v1_assignments_activity_activity_uuid_get
|
|
|
|
- Operation ID: `api_read_assignment_from_activity_api_v1_assignments_activity_activity_uuid_get`
|
|
- Route: `GET /api/v1/assignments/activity/{activity_uuid}`
|
|
- Mode: READ
|
|
- Summary: Get assignment by activity
|
|
- Parameters:
|
|
- `activity_uuid` in `path` required
|
|
|
|
### api_delete_assignment_from_activity_api_v1_assignments_activity_activity_uuid_de
|
|
|
|
- Operation ID: `api_delete_assignment_from_activity_api_v1_assignments_activity_activity_uuid_de`
|
|
- Route: `DELETE /api/v1/assignments/activity/{activity_uuid}`
|
|
- Mode: WRITE
|
|
- Summary: Delete assignment by activity
|
|
- Parameters:
|
|
- `activity_uuid` in `path` required
|
|
|
|
### api_create_assignment_tasks_api_v1_assignments_assignment_uuid_tasks_post
|
|
|
|
- Operation ID: `api_create_assignment_tasks_api_v1_assignments_assignment_uuid_tasks_post`
|
|
- Route: `POST /api/v1/assignments/{assignment_uuid}/tasks`
|
|
- Mode: WRITE
|
|
- Summary: Create assignment task
|
|
- Parameters:
|
|
- `assignment_uuid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_read_assignment_tasks_api_v1_assignments_assignment_uuid_tasks_get
|
|
|
|
- Operation ID: `api_read_assignment_tasks_api_v1_assignments_assignment_uuid_tasks_get`
|
|
- Route: `GET /api/v1/assignments/{assignment_uuid}/tasks`
|
|
- Mode: READ
|
|
- Summary: List assignment tasks
|
|
- Parameters:
|
|
- `assignment_uuid` in `path` required
|
|
|
|
### api_read_assignment_task_api_v1_assignments_task_assignment_task_uuid_get
|
|
|
|
- Operation ID: `api_read_assignment_task_api_v1_assignments_task_assignment_task_uuid_get`
|
|
- Route: `GET /api/v1/assignments/task/{assignment_task_uuid}`
|
|
- Mode: READ
|
|
- Summary: Get assignment task
|
|
- Parameters:
|
|
- `assignment_task_uuid` in `path` required
|
|
|
|
### api_update_assignment_tasks_api_v1_assignments_assignment_uuid_tasks_assignment_
|
|
|
|
- Operation ID: `api_update_assignment_tasks_api_v1_assignments_assignment_uuid_tasks_assignment_`
|
|
- Route: `PUT /api/v1/assignments/{assignment_uuid}/tasks/{assignment_task_uuid}`
|
|
- Mode: WRITE
|
|
- Summary: Update assignment task
|
|
- Parameters:
|
|
- `assignment_task_uuid` in `path` required
|
|
- `assignment_uuid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_delete_assignment_tasks_api_v1_assignments_assignment_uuid_tasks_assignment_
|
|
|
|
- Operation ID: `api_delete_assignment_tasks_api_v1_assignments_assignment_uuid_tasks_assignment_`
|
|
- Route: `DELETE /api/v1/assignments/{assignment_uuid}/tasks/{assignment_task_uuid}`
|
|
- Mode: WRITE
|
|
- Summary: Delete assignment task
|
|
- Parameters:
|
|
- `assignment_task_uuid` in `path` required
|
|
- `assignment_uuid` in `path` required
|
|
|
|
### api_put_assignment_task_ref_file_api_v1_assignments_assignment_uuid_tasks_assign
|
|
|
|
- Operation ID: `api_put_assignment_task_ref_file_api_v1_assignments_assignment_uuid_tasks_assign`
|
|
- Route: `POST /api/v1/assignments/{assignment_uuid}/tasks/{assignment_task_uuid}/ref_file`
|
|
- Mode: WRITE
|
|
- Summary: Upload task reference file
|
|
- Parameters:
|
|
- `assignment_task_uuid` in `path` required
|
|
- `assignment_uuid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_put_assignment_task_sub_file_api_v1_assignments_assignment_uuid_tasks_assign
|
|
|
|
- Operation ID: `api_put_assignment_task_sub_file_api_v1_assignments_assignment_uuid_tasks_assign`
|
|
- Route: `POST /api/v1/assignments/{assignment_uuid}/tasks/{assignment_task_uuid}/sub_file`
|
|
- Mode: WRITE
|
|
- Summary: Upload task submission file
|
|
- Parameters:
|
|
- `assignment_task_uuid` in `path` required
|
|
- `assignment_uuid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_handle_assignment_task_submissions_api_v1_assignments_assignment_uuid_tasks_
|
|
|
|
- Operation ID: `api_handle_assignment_task_submissions_api_v1_assignments_assignment_uuid_tasks_`
|
|
- Route: `PUT /api/v1/assignments/{assignment_uuid}/tasks/{assignment_task_uuid}/submissions`
|
|
- Mode: WRITE
|
|
- Summary: Upsert assignment task submission
|
|
- Parameters:
|
|
- `assignment_task_uuid` in `path` required
|
|
- `assignment_uuid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_read_assignment_task_submissions_api_v1_assignments_assignment_uuid_tasks_as
|
|
|
|
- Operation ID: `api_read_assignment_task_submissions_api_v1_assignments_assignment_uuid_tasks_as`
|
|
- Route: `GET /api/v1/assignments/{assignment_uuid}/tasks/{assignment_task_uuid}/submissions`
|
|
- Mode: READ
|
|
- Summary: List task submissions
|
|
- Parameters:
|
|
- `assignment_task_uuid` in `path` required
|
|
- `limit` in `query`
|
|
- `offset` in `query`
|
|
- `assignment_uuid` in `path` required
|
|
|
|
### api_read_user_assignment_task_submissions_api_v1_assignments_assignment_uuid_tas
|
|
|
|
- Operation ID: `api_read_user_assignment_task_submissions_api_v1_assignments_assignment_uuid_tas`
|
|
- Route: `GET /api/v1/assignments/{assignment_uuid}/tasks/{assignment_task_uuid}/submissions/user/{user_id}`
|
|
- Mode: READ
|
|
- Summary: List task submissions for user
|
|
- Parameters:
|
|
- `assignment_task_uuid` in `path` required
|
|
- `user_id` in `path` required
|
|
- `assignment_uuid` in `path` required
|
|
|
|
### api_read_user_assignment_task_submissions_me_batch_api_v1_assignments_assignment
|
|
|
|
- Operation ID: `api_read_user_assignment_task_submissions_me_batch_api_v1_assignments_assignment`
|
|
- Route: `GET /api/v1/assignments/{assignment_uuid}/tasks/submissions/me`
|
|
- Mode: READ
|
|
- Summary: Batch read current user's task submissions
|
|
- Parameters:
|
|
- `assignment_uuid` in `path` required
|
|
|
|
### api_read_user_assignment_task_submissions_me_api_v1_assignments_assignment_uuid_
|
|
|
|
- Operation ID: `api_read_user_assignment_task_submissions_me_api_v1_assignments_assignment_uuid_`
|
|
- Route: `GET /api/v1/assignments/{assignment_uuid}/tasks/{assignment_task_uuid}/submissions/me`
|
|
- Mode: READ
|
|
- Summary: Get current user's task submission
|
|
- Parameters:
|
|
- `assignment_task_uuid` in `path` required
|
|
- `assignment_uuid` in `path` required
|
|
|
|
### api_delete_assignment_task_submissions_api_v1_assignments_assignment_uuid_tasks_
|
|
|
|
- Operation ID: `api_delete_assignment_task_submissions_api_v1_assignments_assignment_uuid_tasks_`
|
|
- Route: `DELETE /api/v1/assignments/{assignment_uuid}/tasks/{assignment_task_uuid}/submissions/{assignment_task_submission_uuid}`
|
|
- Mode: WRITE
|
|
- Summary: Delete task submission
|
|
- Parameters:
|
|
- `assignment_task_submission_uuid` in `path` required
|
|
- `assignment_uuid` in `path` required
|
|
- `assignment_task_uuid` in `path` required
|
|
|
|
### api_create_assignment_submissions_api_v1_assignments_assignment_uuid_submissions
|
|
|
|
- Operation ID: `api_create_assignment_submissions_api_v1_assignments_assignment_uuid_submissions`
|
|
- Route: `POST /api/v1/assignments/{assignment_uuid}/submissions`
|
|
- Mode: WRITE
|
|
- Summary: Create assignment submission
|
|
- Parameters:
|
|
- `assignment_uuid` in `path` required
|
|
|
|
### api_read_assignment_submissions_api_v1_assignments_assignment_uuid_submissions_g
|
|
|
|
- Operation ID: `api_read_assignment_submissions_api_v1_assignments_assignment_uuid_submissions_g`
|
|
- Route: `GET /api/v1/assignments/{assignment_uuid}/submissions`
|
|
- Mode: READ
|
|
- Summary: List assignment submissions
|
|
- Parameters:
|
|
- `assignment_uuid` in `path` required
|
|
- `limit` in `query`
|
|
- `offset` in `query`
|
|
|
|
### api_read_user_assignment_submission_me_api_v1_assignments_assignment_uuid_submis
|
|
|
|
- Operation ID: `api_read_user_assignment_submission_me_api_v1_assignments_assignment_uuid_submis`
|
|
- Route: `GET /api/v1/assignments/{assignment_uuid}/submissions/me`
|
|
- Mode: READ
|
|
- Summary: Get current user's assignment submission
|
|
- Parameters:
|
|
- `assignment_uuid` in `path` required
|
|
|
|
### api_read_user_assignment_submissions_api_v1_assignments_assignment_uuid_submissi
|
|
|
|
- Operation ID: `api_read_user_assignment_submissions_api_v1_assignments_assignment_uuid_submissi`
|
|
- Route: `GET /api/v1/assignments/{assignment_uuid}/submissions/{user_id}`
|
|
- Mode: READ
|
|
- Summary: Get assignment submission for user
|
|
- Parameters:
|
|
- `assignment_uuid` in `path` required
|
|
- `user_id` in `path` required
|
|
|
|
### api_update_user_assignment_submissions_api_v1_assignments_assignment_uuid_submis
|
|
|
|
- Operation ID: `api_update_user_assignment_submissions_api_v1_assignments_assignment_uuid_submis`
|
|
- Route: `PUT /api/v1/assignments/{assignment_uuid}/submissions/{user_id}`
|
|
- Mode: WRITE
|
|
- Summary: Update assignment submission for user
|
|
- Parameters:
|
|
- `assignment_uuid` in `path` required
|
|
- `user_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_delete_user_assignment_submissions_api_v1_assignments_assignment_uuid_submis
|
|
|
|
- Operation ID: `api_delete_user_assignment_submissions_api_v1_assignments_assignment_uuid_submis`
|
|
- Route: `DELETE /api/v1/assignments/{assignment_uuid}/submissions/{user_id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete assignment submission for user
|
|
- Parameters:
|
|
- `assignment_uuid` in `path` required
|
|
- `user_id` in `path` required
|
|
|
|
### api_get_submission_grade_api_v1_assignments_assignment_uuid_submissions_user_id_
|
|
|
|
- Operation ID: `api_get_submission_grade_api_v1_assignments_assignment_uuid_submissions_user_id_`
|
|
- Route: `GET /api/v1/assignments/{assignment_uuid}/submissions/{user_id}/grade`
|
|
- Mode: READ
|
|
- Summary: Get assignment submission grade
|
|
- Parameters:
|
|
- `assignment_uuid` in `path` required
|
|
- `user_id` in `path` required
|
|
|
|
### api_final_grade_submission_api_v1_assignments_assignment_uuid_submissions_user_i
|
|
|
|
- Operation ID: `api_final_grade_submission_api_v1_assignments_assignment_uuid_submissions_user_i`
|
|
- Route: `POST /api/v1/assignments/{assignment_uuid}/submissions/{user_id}/grade`
|
|
- Mode: WRITE
|
|
- Summary: Finalize assignment submission grade
|
|
- Parameters:
|
|
- `assignment_uuid` in `path` required
|
|
- `user_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_retry_assignment_submission_api_v1_assignments_assignment_uuid_submissions_m
|
|
|
|
- Operation ID: `api_retry_assignment_submission_api_v1_assignments_assignment_uuid_submissions_m`
|
|
- Route: `POST /api/v1/assignments/{assignment_uuid}/submissions/me/retry`
|
|
- Mode: WRITE
|
|
- Summary: Retry assignment for current user
|
|
- Parameters:
|
|
- `assignment_uuid` in `path` required
|
|
|
|
### api_submission_mark_as_done_api_v1_assignments_assignment_uuid_submissions_user_
|
|
|
|
- Operation ID: `api_submission_mark_as_done_api_v1_assignments_assignment_uuid_submissions_user_`
|
|
- Route: `POST /api/v1/assignments/{assignment_uuid}/submissions/{user_id}/done`
|
|
- Mode: WRITE
|
|
- Summary: Mark assignment as done for user
|
|
- Parameters:
|
|
- `assignment_uuid` in `path` required
|
|
- `user_id` in `path` required
|
|
|
|
### api_get_assignments_api_v1_assignments_course_course_uuid_get
|
|
|
|
- Operation ID: `api_get_assignments_api_v1_assignments_course_course_uuid_get`
|
|
- Route: `GET /api/v1/assignments/course/{course_uuid}`
|
|
- Mode: READ
|
|
- Summary: List course assignments
|
|
- Parameters:
|
|
- `course_uuid` in `path` required
|