|
You are browsing the documentation for a deprecated version ('2014-08-15') of the Amazon Mechanical Turk Requester API. This version of the API will be deprecated and will be rendered unusable as of June 1st, 2019. If you request against a legacy API version (https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI-legacy/Welcome.html) on or after June 1, 2019, you will receive the following response:
The latest version of our API ('2017-01-17') provides you with additional tool choices and enables you to select from nine AWS Software Development Kits This version also updates naming conventions used in the API and adopts the AWS standard of Signature Version 4 to authenticate requests securely. The API uses REST requests and no longer requires that developers be familiar with SOAP protocol. These changes make the MTurk API consistent with AWS APIs, simplifying the on-boarding process for both new and existing AWS developers. The legacy MTurk Command Line Tools and .NET, Java, Ruby, and Perl SDKs were marked as deprecated in January 2018. We will be deprecating the legacy APIs as of June 1, 2019. If you are on a legacy API, you must migrate to the latest
version of our API. You can find documentation for the latest API here and the AWS SDKs here For support, contact requestor-apilegacydeprecation-support@amazon.com |
SetHITAsReviewing
Description
The SetHITAsReviewing operation updates the status of a HIT. If
the status is Reviewable, this operation updates the status to
Reviewing, or reverts a Reviewing HIT
back to the Reviewable status.
You can update only HITs with status Reviewable to status
Reviewing. Similarly, you can revert only Reviewing HITs back to status Reviewable.
Note
The SetHITAsReviewing operation does
not toggle the status value. The default behavior is to
promote a HIT from Reviewable to Reviewing. To revert a Reviewing HIT back to
Reviewable, specify the Revert
parameter with a value of true.
Request Parameters
The SetHITAsReviewing operation accepts parameters common to all
operations. Some common parameters are required. See Common Parameters for more
information.
The following parameters are specific to the SetHITAsReviewing
operation:
| Name | Description | Required |
|---|---|---|
|
|
The name of the operation Type: String ValidValues: SetHITAsReviewing Default: None |
Yes |
|
|
The ID of the HIT whose status is to be updated. Type: String Default: None |
Yes |
|
|
Specifies whether to update the HIT Type: Boolean Valid Values: true | false Default: false; the operation promotes the HIT from |
No |
Response Elements
A successful request for the SetHITAsReviewing operation returns
with no errors. The response includes the elements described in the following table. The
operation returns no other data.
| Name | Description |
|---|---|
|
|
Contains a |
Examples
The following example shows how to use the SetHITAsReviewingResult operation.
Sample Request
The following example updates a HIT with Reviewable status
to Reviewing status.
https://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester &AWSAccessKeyId=[the Requester's Access Key ID]&Version=2017-01-17 &Operation=SetHITAsReviewing &Signature=[signature for this request]&Timestamp=[your system's local time]&HITId=123RVWYBAZW00EXAMPLE
Sample Response
The following is an example response.
<SetHITAsReviewingResult> <Request> <IsValid>True</IsValid> </Request> </SetHITAsReviewingResult>
