Task status
API version
Select a version to change the base URI
in syntax and code examples. Learn about versions:
in syntax and code examples. Learn about versions
Represents the status of a task created for an application.
URI
/api/v10/applications/ID/tasks/ID/statusGET Get the task status
Retrieve the text of the status set for a task.
Syntax
GET /api/v10/applications/123/tasks/1/status
Host: apply.example.edu
Authorization: DREAM apikey="..."Example request
Request
curl
curl \
-X GET \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
"https://apply.example.edu/api/v10/applications/123/tasks/1/status"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json | The media type of the resource |
Content-Length | 1234 | The size of the response body in bytes |
Response codes
| Response code | Description |
|---|---|
200 OK | The status was successfully returned |
404 Not Found | The application does not have this task |
Example response
Response
"I am preparing the documents for submission."PUT Set the task status
Set a status for a task.
This API request checks if the provided status is defined in the task template settings. If the status is not defined, the API request sets the Other status for the task and saves the provided text as status details.
Syntax
PUT /api/v10/applications/123/tasks/1/status
Host: apply.example.edu
Authorization: DREAM apikey="..."Raw request body
The request body must contain a valid JSON string literal enclosed in double quotes. The allowed string length is up to 50 characters.
Request body
"The task has been completed"Example request
Request
curl
curl \
-X PUT \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
-d '"The task has been completed"' \
"https://apply.example.edu/api/v10/applications/123/tasks/1/status"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | text/plain | The media type of the resource |
Content-Length | 0 | The size of the response body in bytes |
Response codes
| Response code | Description |
|---|---|
200 OK | The status was successfully set. |
400 Bad Request | An invalid status. |
400 Bad Request | An invalid status. Please make sure that status is a valid JSON string with quotes. |
404 Not Found | The application does not have this task. |