Получить список файлов

GET /attachments

Получает список сохраненных в Яндекс Заданиях файлов.

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

curl -X GET 'https://tasks.yandex.ru/api/v1/attachments?pool_id=1085757' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here'
import requests

url = "https://tasks.yandex.ru/api/v1/attachments"
params = {
  'pool_id': '1085757'
}
headers = {
  'Authorization': 'OAuth PlaceYourRealOAuthToken_Here'
}
response = requests.get(url, params=params, headers=headers)

print(response.text)
var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://tasks.yandex.ru/api/v1/attachments',
  'qs': {'pool_id': '1085757'},
  'headers': {
    'Authorization': 'OAuth PlaceYourRealOAuthToken_Here'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Заголовки

Заголовок

Описание

Authorization

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

Query-параметры

Указываются в ссылке после знака вопроса, перечисляются через &.

Параметр

Описание

pool_id

string

Обязательно нужно указать pool_id или assignment_id.

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

assignment_id

string

Обязательно нужно указать pool_id или assignment_id.

Идентификатор выдачи страницы заданий.

name

string

Имя файла.

type

string

Тип приложения. На данный момент ключ имеет одно значение — ASSIGNMENT_ATTACHMENT.

user_id

string

Идентификатор исполнителя, который отправил файл(ы).

sort

string

Параметры для сортировки:

  • id — идентификатор файла;
  • created — дата отправки файла по UTC в формате ISO 8601: YYYY-MM-DDThh:mm:ss[.sss].

О том, как задать сортировку, читайте на странице Сортировка списка объектов.

limit

integer

Ограничение на количество возвращаемых результатов. По умолчанию — 20, максимум — 100.

string

Объекты с идентификатором больше указанного значения.

id_gte

string

Объекты с идентификатором больше или равным указанному значению.

string

Объекты с идентификатором меньше указанного значения.

id_lte

string

Объекты с идентификатором меньше или равным указанному значению.

string

Объекты, выданные или созданные после указанной даты.

created_gte

string

Объекты, выданные или созданные после указанной даты включительно.

string

Объекты, выданные или созданные до указанной даты.

created_lte

string

Объекты, выданные или созданные до указанной даты включительно.

Больше примеров

Можно настроить показ списка файлов частями (например, по 10 файлов):

  1. Показать первые 10 файлов, начиная с файла с наименьшим идентификатором.
  2. Показывать оставшиеся файлы по 10 штук в порядке возрастания.

Показать первые 10 файлов

curl -X GET 'https://tasks.yandex.ru/api/v1/attachments?pool_id=1085757&sort=id&limit=10' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here'

Показать остальные части с сортировкой по возрастанию идентификатора

curl -X GET 'https://tasks.yandex.ru/api/v1/attachments?pool_id=1085757&sort=id&limit=10&id_gt={ID_последнего_файла_из_предыдущего_запроса}' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here'

Ответ

Содержит сведения о файлах в массиве items:

{
  "items": [
    {file #1},
    {file #2},
    ...
    {file #n}
  ],
  "has_more": false
}
Пример ответа
{
  "items": [
    {
      "id": "0983459b-e26f-42f3-a5fd-6e3feee913e7",
      "attachment_type": "ASSIGNMENT_ATTACHMENT",
      "name": "37540601.jpg",
      "details": {
        "user_id": "ae1d5431cfc59e25b4abbbe75666d59b",
        "assignment_id": "5241f238-6640-43e4-80bb-3283893cd221",
        "pool_id": "154"
      },
      "owner": {
        "id": "6c6e20dc86cca2ae787afcb2629de162",
        "myself": true
      },
      "created": "2016-05-25T16:14:27.748",
      "media_type": "image/jpeg"
    }
  ],
  "has_more": true
}

Параметр

Описание

items

array of objects

Массив со списком прикрепленных файлов и их свойств.

has_more

boolean

Показывает, является ли список элементов в ответе полным.

Возможные значения:

  • true — не все элементы вошли в ответ из-за ограничений в параметре limit.

    Можно получить остальные результаты с помощью параметров с постфиксами _lt(e) и _gt(e).

    См. подробнее о фильтрации запросов.

  • false — в ответе содержатся все имеющиеся элементы.