AWS Documentation » Amazon Mechanical Turk » API Reference » Operations » ListReviewableHITs

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

ListReviewableHITs

Description

The ListReviewableHITs operation returns all of a Requester's HITs that have not been approved or rejected. The operation can return any HITs that have not been deleted with the DeleteHIT operation or that have not been auto-deleted.

By default, ListReviewableHITs operation only returns the IDs of HITs in the status Reviewable.

If you used the UpdateHITReviewStatus Operation to set the status of the HIT to Reviewing, and want HITs in the status Reviewing, set the Status request parameter to Reviewing.

Request Syntax

{ 
  "HITTypeId": String,

  "Status": String,

  "NextToken": String,

  "MaxResults": Integer
 }

Request Parameters

The request accepts the following data in JSON format:

Name	Description	Required
HITTypeId	The ID of the HIT type of the HITs to consider for the query. Type: String	No
Status	The status of the HITs to return: Reviewable | Reviewing Type: String By Default Status is set to Reviewable.	No
NextToken	Pagination token Type: String	No
MaxResults	Type: Integer	No

Response Elements

A successful request returns a paginated list of HIT data structures.

Example

The following example shows how to use the ListReviewableHITs operation:

Sample Request

POST / HTTP/1.1
Host: mturk-requester.us-east-1.amazonaws.com
Content-Length: <PayloadSizeBytes>
X-Amz-Date: <Date>
{
}

Sample Response

The following is an example response:

HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
{
  NextToken:PaginationToken,
  NumResults:10,
  HITs:[HIT]
}