Archive a project

If a project isn't being used, you can send it to the archive. To do this, all the pools in the project must be archived. Send a POST request to the resource /projects/<project ID>/archive.

Request

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

Response

The response contains information about the results of the operation.

{
  "id" : "57068577e4b0bf7b07a0256f",
  "type" : "PROJECT.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" : {
    "project_id" : "1"
  }
}

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.

  • TASK_SUITE.BATCH_CREATE — Creating multiple task suites.

  • USER_BONUS.BATCH_CREATE — Awarding a bonus 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.project_id

Project ID.

String

You can check the operation status in the future by sending requests to the /operations resource. For more information, see Tracking operations.