Amazon Mechanical Turk · JSON Structure

Amazon Mechanical Turk Update Qualification Type Request Structure

UpdateQualificationTypeRequest schema from Amazon Mechanical Turk API

Type: object Properties: 9 Required: 1
CrowdsourcingHuman IntelligenceLaborMachine LearningTasks

UpdateQualificationTypeRequest is a JSON Structure definition published by Amazon Mechanical Turk, describing 9 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

QualificationTypeId Description QualificationTypeStatus Test AnswerKey TestDurationInSeconds RetryDelayInSeconds AutoGranted AutoGrantedValue

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-mechanical-turk/refs/heads/main/json-structure/amazon-mechanical-turk-update-qualification-type-request-structure.json",
  "name": "UpdateQualificationTypeRequest",
  "description": "UpdateQualificationTypeRequest schema from Amazon Mechanical Turk API",
  "type": "object",
  "properties": {
    "QualificationTypeId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EntityId"
        },
        {
          "description": "The ID of the Qualification type to update."
        }
      ]
    },
    "Description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The new description of the Qualification type."
        }
      ]
    },
    "QualificationTypeStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/QualificationTypeStatus"
        },
        {
          "description": "The new status of the Qualification type - Active | Inactive"
        }
      ]
    },
    "Test": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "<p>The questions for the Qualification test a Worker must answer correctly to obtain a Qualification of this type. If this parameter is specified, <code>TestDurationInSeconds</code> must also be specified.</p> <p>Constraints: Must not be longer than 65535 bytes. Must be a QuestionForm data structure. This parameter cannot be specified if AutoGranted is true.</p> <p>Constraints: None. If not specified, the Worker may request the Qualification without answering any questions.</p>"
        }
      ]
    },
    "AnswerKey": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure."
        }
      ]
    },
    "TestDurationInSeconds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Long"
        },
        {
          "description": "The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification."
        }
      ]
    },
    "RetryDelayInSeconds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Long"
        },
        {
          "description": "The amount of time, in seconds, that Workers must wait after requesting a Qualification of the specified Qualification type before they can retry the Qualification request. It is not possible to disable retries for a Qualification type after it has been created with retries enabled. If you want to disable retries, you must dispose of the existing retry-enabled Qualification type using DisposeQualificationType and then create a new Qualification type with retries disabled using CreateQualificationType."
        }
      ]
    },
    "AutoGranted": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": "<p>Specifies whether requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test.</p> <p>Constraints: If the Test parameter is specified, this parameter cannot be true.</p>"
        }
      ]
    },
    "AutoGrantedValue": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Integer"
        },
        {
          "description": "The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true."
        }
      ]
    }
  },
  "required": [
    "QualificationTypeId"
  ]
}