canvas.courses.return-test-student-for-course

Returns information for a test student in this course. Creates a test student if one does not already exist for the course. The caller must have permission to access the course's student view.

Return test student for course

Overview

Property	Value
Workflow type	Atomic
Library	App-canvas
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Canvas API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
course_id	string	Yes	—	ID

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Canvas API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
course_id	string	Yes	—	ID
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call GET /v1/courses/{course_id}/student_view_student
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform GET /v1/courses/{course_id}/student_view_student
* (any state)	fail	failed	Record the failure reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "canvas.courses.return-test-student-for-course",
  "initial_data": {
    "base_url": "value",
    "course_id": "value"
  }
}