Breadcrumbs Surpass API v2 > API v2 Reference > Tasks > Task API

Task API

The Tasks section of Surpass allows you to create, manage, and complete assignments. You can use tasks to create and review items and use the deadline tools to manage projects outside of the system.

This article explains what calls can be made to the Surpass API using the Task resource.

Import this API into your Postman Workspace

In This Article

Listing tasks

get /api/v2/Task

Send a request to the endpoint to retrieve a list of tasks. Refer to the available parameters to influence the response. No request body is required.

General tasks

General tasks are useful for setting deadlines and prompting users to perform certain actions in Surpass. The Task API resource can be used to retrieve, create, and update General tasks.

To learn more about General tasks, read Creating a General task and Working in a General task as an assignee.

Retrieving General task information

get /api/v2/GeneralTask/{id}

Send a request to the endpoint to retrieve information for a specific General task using either its ID or reference. No request body is required.

Creating a General task

post /api/v2/GeneralTask

Send a request to the endpoint to create a General task.

Updating a General task

put /api/v2/GeneralTask/{id}

Send a request to the endpoint to update a specific General task.

Authoring tasks

In an Authoring task, assignees write items and submit them for review. The Task API resource can be used to retrieve, create, and update Authoring tasks.

To learn about Authoring tasks, read Creating an Authoring task, Working in an Authoring (Edit Existing Items) task as an assignee, Working in an Authoring (Create New Items) task as an assignee, Working in an Authoring (Edit Existing Items) task as a lead assignee, and Working in an Authoring (Create New Items) task as a lead assignee,

Retrieving Authoring task information

get /api/v2/ItemAuthoringTask/{id}

Send a request to the endpoint to retrieve information for a specific Authoring task using either its ID or reference. No request body is required.

Creating an Authoring task

post /api/v2/ItemAuthoringTask

Send a request to the endpoint to create an Authoring task.

Updating an Authoring task

put /api/v2/ItemAuthoringTask/{id}

Send a request to the endpoint to update a specific Authoring task.

Review tasks

In a Review task, assignees inspect an item list on an item-by-item basis. Assignees may also be allowed to edit items in Review tasks. There are two editing modes available for Review tasks:

The Task API resource can be used to retrieve, create, and update Review tasks, as well as list, retrieve, and update Review task results.

Retrieving Review task information

get /api/v2/ItemReviewTask/{id}

Send a request to the endpoint to retrieve information for a specific Review task using either its ID or reference. No request body is required.

Listing Review task results

get /api/v2/ItemReviewTask/ItemReviewResult?taskId={id}

Send a request to the endpoint to retrieve a list of the results for a specific Review task using either its ID or reference. No request body is required.

Retrieving Review task results information

get /api/v2/ItemReviewTask/ItemReviewResult/{id}

Send a request to the endpoint to retrieve information for a specific Review task result using either its ID or reference. No request body is required.

Creating a Review task

post /api/v2/ItemReviewTask

Send a request to the endpoint to create a Review task.

Updating a Review task

put /api/v2/ItemReviewTask/{id}

Send a request to the endpoint to update a specific Review task.

Updating a Review task result

put /api/v2/ItemReviewTask/ItemReviewResult/{id}

Send a request to the endpoint to update a specific Review task result.

Standard Setting tasks

In a Standard Setting task, assignees rate items in an item list according to the Angoff rating method to help determine a cut score for your test. The Angoff rating method is designed to identify the proportion of minimally competent candidates.

The Task API resource can be used to retrieve, create, and update Standard Setting tasks, as well as list, retrieve, and update Standard Setting task results.

To learn more about Standard Setting tasks, read Creating a Standard Setting task, Working in a Standard Setting task as an assignee, and Working in a Standard Setting task as a lead assignee.

Retrieving Standard Setting task information

get /api/v2/StandardSettingTask/{id}

Send a request to the endpoint to retrieve information for a specific Standard Setting task using either its ID or reference. No request body is required.

Listing Standard Setting task results

get /api/v2/StandardSettingTask?taskId={id}

Send a request to the endpoint to retrieve a list of the results for a specific Standard Setting task using either its ID or reference. No request body is required.

Retrieving Standard Setting task results information

get /api/v2/StandardSettingTask/StandardSettingResult/{id}

Send a request to the endpoint to retrieve information for a specific Standard Setting task result using either its ID or reference. No request body is required.

Creating a Standard Setting task

post /api/v2/StandardSettingTask

Send a request to the endpoint to create a Standard Setting task.

Updating a Standard Setting task

put /api/v2/StandardSettingTask/{id}

Send a request to the endpoint to update a specific Standard Setting task.

Updating a Standard Setting task result

put /api/v2/StandardSettingTask/StandardSettingResult/{id}

Send a request to the endpoint to update a specific Standard Setting task result.

Error Codes

Refer to the following table for information on error codes that may be encountered when using this resource.

Further reading

Read the following articles to learn more about similar APIs, how to get started with the Surpass API v2, and how to get the best out of this reference documentation:

NOTE: This form is to provide feedback to help improve the Surpass Help documentation only. If you need live support, contact support@surpass.com.