Change the task suite overlap

  1. Request
  2. Path parameters
  3. Headers
  4. Query parameters
  5. Request body
  6. Response

Changes task suite overlap.

You can specify a numeric value or set infinite overlap to assign the task suite to all users (this is useful for training tasks).

Request

PATCH https://toloka.yandex.com/api/v1/task-suites/<task_suite_id>
Authorization: OAuth <OAuth token>
Content-Type: application/JSON

Path parameters

Parameter Overview
task_suite_id ID of a task suite.
Parameter Overview
task_suite_id ID of a task suite.

Headers

Title Overview
authorization A token for account authorization. Add OAuth as a prefix.
content-type Specifies the data format in the request body.
Title Overview
authorization A token for account authorization. Add OAuth as a prefix.
content-type Specifies the data format in the request body.

Query parameters

Specified in the link after the question mark; separated by &.

Parameter Overview
open_pool

boolean

Open the pool immediately after creating the task suite, if the pool is closed. The default value is false.

Parameter Overview
open_pool

boolean

Open the pool immediately after creating the task suite, if the pool is closed. The default value is false.

Request body

Numeric overlap value
{
   "overlap": <new overlap value>,
   "infinite_overlap": false
}
Copied to clipboard
Infinite overlap
{
   "overlap": null,
   "infinite_overlap": true
}
Copied to clipboard
Parameter Overview
overlap

integer | required if

Required if the parameter is not used when creating a task suite allow_defaults=true, and the overlap is not specified in the pool parameters (in the defaults.​default_​overlap_for_​new_task_suites key).

Task suite overlap.

infinite_overlap

boolean | required

Assigning a task suite with infinite overlap. This option is used, for instance, for suites of training tasks when you want to assign them to all users:
  • true — Use infinite overlap.

  • false — Use the overlap that is set for the task suite or pool.

Parameter Overview
overlap

integer | required if

Required if the parameter is not used when creating a task suite allow_defaults=true, and the overlap is not specified in the pool parameters (in the defaults.​default_​overlap_for_​new_task_suites key).

Task suite overlap.

infinite_overlap

boolean | required

Assigning a task suite with infinite overlap. This option is used, for instance, for suites of training tasks when you want to assign them to all users:
  • true — Use infinite overlap.

  • false — Use the overlap that is set for the task suite or pool.

Response

Contains a task suite in JSON format.