Move a pool to the archive

If a pool isn't in use, it can be moved to the archive. The pool must have the “closed” status. Send a POST request to the resource /pools/<pool ID>/archive.

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

Request

POST /api/v1/pools/<pool ID>/archive
Host: https://sandbox.toloka.yandex.com
Authorization: OAuth <OAuth token>

POST /api/v1/pools/<pool ID>/archive
Host: https://toloka.yandex.com
Authorization: OAuth <OAuth token>

Response

Contains information about the results of the operation.

{
  "id" : "57068577e4b0bf7b07a0256f",
  "type" : "POOL.ARCHIVE",
  "status" : "SUCCESS",
  "submitted" : "2016-04-07T16:06:15.902",
  "started" : "2016-04-07T16:06:15.902",
  "finished" : "2016-04-07T16:06:15.902",
  "progress" : 100,
  "parameters" : {
    "pool_id" : "1"
  }
}

Key descriptions


Key	Value	Data type
`id`	Operation ID.	String
`type`	Operation type: `POOL.OPEN` — Opening a pool. `POOL.CLOSE` — Closing a pool. `PROJECT.ARCHIVE` — Archiving a project. `POOL.ARCHIVE` — Archiving a pool. `POOL.CLONE` — Cloning a pool. `TASK.BATCH_CREATE` — Creating multiple tasks. `TASK_SUITE.BATCH_CREATE` — Creating multiple task suites. `USER_BONUS.BATCH_CREATE` — Issuing a reward to multiple users.	String
`status`	The status of the operation: `PENDING` — Not started yet. `RUNNING` — In progress. `SUCCESS` — Completed sucessfully. `FAIL` — Not completed.	String
`submitted`	The UTC date and time the request was sent, in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].	String
`started`	The UTC date and time the operation started, in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].	String
`finished`	The UTC date and time the operation was completed, in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].	String
`progress`	The percentage of the operation completed.	Number
`parameters.id`	Pool ID.	String


Key	Value	Data type
`id`	Operation ID.	String
`type`	Operation type: `POOL.OPEN` — Opening a pool. `POOL.CLOSE` — Closing a pool. `PROJECT.ARCHIVE` — Archiving a project. `POOL.ARCHIVE` — Archiving a pool. `POOL.CLONE` — Cloning a pool. `TASK.BATCH_CREATE` — Creating multiple tasks. `TASK_SUITE.BATCH_CREATE` — Creating multiple task suites. `USER_BONUS.BATCH_CREATE` — Issuing a reward to multiple users.	String
`status`	The status of the operation: `PENDING` — Not started yet. `RUNNING` — In progress. `SUCCESS` — Completed sucessfully. `FAIL` — Not completed.	String
`submitted`	The UTC date and time the request was sent, in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].	String
`started`	The UTC date and time the operation started, in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].	String
`finished`	The UTC date and time the operation was completed, in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].	String
`progress`	The percentage of the operation completed.	Number
`parameters.id`	Pool ID.	String