Get a response

To get a response by its ID, send a GET request to the /assignments/<response ID> resource.

Request

GET /api/v1/assignments/<response ID>
Host: https://sandbox.toloka.yandex.com
Authorization: OAuth <OAuth token>

Response

{
    "id": "0000082301--5f69bcc046757f5cf86c12ff",
    "task_suite_id": "0000082301--5f69bc8446757f5cf86c0e24",
    "pool_id": "533249",
    "user_id": "b4d8bcc33403cae9eb69991c8bb90bdc",
    "status": "ACCEPTED",
    "reward": 0.01,
    "bonus_ids": "IDs of the rewards given for the task",
    "tasks": [{
        "id": "6946cefa-32af-4f62-b530-8d2c71fa2966",
        "input_values": {
            "image": "http://images.com/1.png"
        }
    }],
    "solutions": [{
        "output_values": {
            "result": "OK"
        }
    }],
    "mixed": false,
    "automerged": false,
    "created": "2020-09-22T08:58:40.913",
    "submitted": "2020-09-22T08:58:46.207",
    "accepted": "2020-09-22T08:58:46.207",
    "public_comment": "Well done!",
"owner": {
      "id": "ac1e4701364b4ccef8a4fe10a8980cff",
      "myself": true
    }
}
Key descriptions

Key

Value

Data type

Required

id

ID of the task suite assignment to a user.

String

Yes

task_suite_id

ID of a task suite.

String

Yes

pool_id

ID of the pool that the task suite belongs to.

String

Yes

user_id

ID of the user who was assigned the task suite.

String

Yes

status

Status of an assigned task suite:

  • ACTIVE — Being completed by a user.

  • SUBMITTED — Completed but not checked.

  • ACCEPTED — Accepted by the requester.

  • REJECTED — Rejected by the requester.

  • SKIPPED — Skipped by the user.

  • EXPIRED — The time for completing the tasks expired.

String

Yes
reward Payment received by the performer. Number Yes

public_comment

A comment for the user.

Maximum length: 2048 characters.

String

No

bonus_ids[] IDs of rewards issued for the task. Array No

tasks[]

Data for the tasks.

Array

Yes

first_declined_solution_attempt[]

For training tasks. The user's first responses in the training task (only if these were the wrong answers). If the user answered correctly on the first try, the first_declined_solution_attempt array is omitted.

Arrays with the responses (output_values) are arranged in the same order as the task data in the tasks array.
{
      "output_values": {
        "<field 1>": <response>,
        "<field 2>": <response>
...
        "<field N>": <response>
      },
...
    }

Array

No

solutions[]

User responses. Arranged in the same order as the data for tasks in the tasks array.
{
      "output_values": {
        "<field 1>": <response>,
        "<field 2>": <response>
...
        "<field N>": <response>
      },
...
    }

Array

No

mixed

Type of operation for creating a task suite:

  • true — Automatic (“smart mixing”).

  • false— Manually.

The default value is false.

For more information about creating task suites, see the Requester's guide.

Boolean

No
automerged Flag of the response received as a result of merging identical tasks . Value:
  • true — The response was recorded when identical tasks were merged.
  • false — Normal user response.
Boolean Yes

created

The date and time when the task suite was assigned to a user. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

Yes

submitted

The date and time when the task suite was completed by a user. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

No

accepted

The date and time when the responses for the task suite were accepted by the requester. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

No

rejected

The date and time when the responses for the task suite were rejected by the requester. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

No

skipped

The date and time when the task suite was skipped by a user. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

No

expired

The date and time when the task suite expired. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

No

owner.id

Requester ID.

String

Yes

owner.myself

“My own” flag.

Boolean

Yes

owner.company_id

Company ID.

String

No

Key

Value

Data type

Required

id

ID of the task suite assignment to a user.

String

Yes

task_suite_id

ID of a task suite.

String

Yes

pool_id

ID of the pool that the task suite belongs to.

String

Yes

user_id

ID of the user who was assigned the task suite.

String

Yes

status

Status of an assigned task suite:

  • ACTIVE — Being completed by a user.

  • SUBMITTED — Completed but not checked.

  • ACCEPTED — Accepted by the requester.

  • REJECTED — Rejected by the requester.

  • SKIPPED — Skipped by the user.

  • EXPIRED — The time for completing the tasks expired.

String

Yes
reward Payment received by the performer. Number Yes

public_comment

A comment for the user.

Maximum length: 2048 characters.

String

No

bonus_ids[] IDs of rewards issued for the task. Array No

tasks[]

Data for the tasks.

Array

Yes

first_declined_solution_attempt[]

For training tasks. The user's first responses in the training task (only if these were the wrong answers). If the user answered correctly on the first try, the first_declined_solution_attempt array is omitted.

Arrays with the responses (output_values) are arranged in the same order as the task data in the tasks array.
{
      "output_values": {
        "<field 1>": <response>,
        "<field 2>": <response>
...
        "<field N>": <response>
      },
...
    }

Array

No

solutions[]

User responses. Arranged in the same order as the data for tasks in the tasks array.
{
      "output_values": {
        "<field 1>": <response>,
        "<field 2>": <response>
...
        "<field N>": <response>
      },
...
    }

Array

No

mixed

Type of operation for creating a task suite:

  • true — Automatic (“smart mixing”).

  • false— Manually.

The default value is false.

For more information about creating task suites, see the Requester's guide.

Boolean

No
automerged Flag of the response received as a result of merging identical tasks . Value:
  • true — The response was recorded when identical tasks were merged.
  • false — Normal user response.
Boolean Yes

created

The date and time when the task suite was assigned to a user. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

Yes

submitted

The date and time when the task suite was completed by a user. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

No

accepted

The date and time when the responses for the task suite were accepted by the requester. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

No

rejected

The date and time when the responses for the task suite were rejected by the requester. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

No

skipped

The date and time when the task suite was skipped by a user. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

No

expired

The date and time when the task suite expired. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

No

owner.id

Requester ID.

String

Yes

owner.myself

“My own” flag.

Boolean

Yes

owner.company_id

Company ID.

String

No