Toloka documentation

Archive a training pool

Warning

We recommend that you use the toloka.dev domain for API requests. The toloka.yandex.com domain is still supported but it will be deprecated soon.

Moves a training pool to the archive.

If a training pool isn't in use, it can be moved to the archive. Before archiving, check two conditions:

  • The training pool must have the "closed" status.
  • All the main pools that the training pool is linked to must be sent to the archive.

Request

POST https://toloka.dev/api/v1/trainings/<training_id>/archive
Authorization: OAuth <OAuth token>
POST https://sandbox.toloka.dev/api/v1/trainings/<training_id>/archive
Authorization: OAuth <OAuth token>

Path parameters

Parameter Overview
training_id Pool ID.

Headers

Title Overview
Authorization A token for account authorization. Add OAuth as a prefix.

Response

Note

If the training pool is already archived, attempting to archive it again returns an empty response with status 204.

{
  "id": "95029e60-eace-4a3e-96b9-c72c5e727218",
  "type": "TRAINING.ARCHIVE",
  "status": "SUCCESS",
  "submitted": "2021-02-26T10:13:32.921",
  "started": "2021-02-26T10:13:32.921",
  "finished": "2021-02-26T10:13:32.921",
  "progress": 100,
  "parameters": {
    "training_id": "123456"
  },
  "details": {}
}

Parameter

Overview

id

string

User ID.

type

string

Type of operation: TRAINING.ARCHIVE — Archive a training pool.

status

string

The status of the operation:

  • PENDING — Not started yet.
  • RUNNING — In progress.
  • SUCCESS — Completed successfully.
  • FAIL — Not completed.

submitted

string

The UTC date and time the request was sent, in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

started

string

The UTC date and time the operation started, in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

finished

string

The UTC date and time the operation was completed, in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

progress

integer

The percentage of the operation completed.

parameters.training_id

string

ID of the training pool.

details

object

Details of the operation completion.