Архивировать проект

POST /projects/{id}/archive

Отправляет проект в архив.

Если проект не используется, его можно отправить в архив. Для выполнения операции все пулы в проекте должны быть архивированы. Идентификатор проекта можно узнать из списка проектов.

Примеры запросов

curl -X POST 'https://tasks.yandex.ru/api/v1/projects/83859/archive' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here'

import requests

url = "https://tasks.yandex.ru/api/v1/projects/83859/archive"
headers = {
  'Authorization': 'OAuth PlaceYourRealOAuthToken_Here'
}
response = requests.post(url, headers=headers)

print(response.text)

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://tasks.yandex.ru/api/v1/projects/83859/archive',
  'qs': {},
  'headers': {
    'Authorization': 'OAuth PlaceYourRealOAuthToken_Here'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Path-параметры

Параметр

Описание

id*

string

Идентификатор проекта.

Заголовки

Заголовок

Описание

Authorization

API-токен для авторизации аккаунта. В качестве префикса добавьте OAuth.

Ответ

Ответ содержит сведения о выполнении операции.

Пример ответа
{
  "id": "57068577e4b0bf7b07a0256f",
  "type": "PROJECT.ARCHIVE",
  "status": "SUCCESS",
  "submitted": "2022-04-07T16:06:15.902",
  "started": "2022-04-07T16:06:15.902",
  "finished": "2022-04-07T16:06:15.902",
  "progress": 100,
  "parameters": {
    "project_id": "1"
  },
  "details": {}
}

Параметр

Описание

id

string

Идентификатор операции.

type

string

Тип операции:

  • PROJECT.ARCHIVE — отправка проекта в архив;

status

string

Статус операции:

  • PENDING — выполнение не началось;
  • RUNNING — выполняется;
  • SUCCESS — успешно выполнена;
  • FAIL — не выполнена.

submitted

string

Дата и время отправки запроса по UTC в формате ISO 8601: YYYY-MM-DDThh:mm:ss[.sss].

started

string

Дата и время начала операции по UTC в формате ISO 8601: YYYY-MM-DDThh:mm:ss[.sss].

finished

string

Дата и время окончания операции по UTC в формате ISO 8601: YYYY-MM-DDThh:mm:ss[.sss].

progress

float

Ход выполнения операции в процентах.

parameters.project_id

string

Идентификатор проекта.

В дальнейшем статус операции можно отслеживать с помощью запросов к ресурсу /operations. Подробнее см. в разделе Отслеживание операций.

Обязательный параметр

Предыдущая
Редактировать проект
Следующая
Пулы