Получить лог операции

GET /operations/{id}/log

Получает лог операции.

Логи можно получить для асинхронных операций (async_mode = true). Такие операции выполняются в фоновом режиме.

Логи доступны только за последний месяц. Чтобы получить логи за более ранний период, обратитесь в службу поддержки.

Лог операции можно получить при:

При успешной операции лог содержит id созданных объектов, а при неуспешной — сведения об ошибках валидации.

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

curl -X GET 'https://tasks.yandex.ru/api/v1/operations/5c04458e-63c1-46c1-ba0d-6f0756a5358b/log' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here'

import requests

url = "https://tasks.yandex.ru/api/v1/operations/5c04458e-63c1-46c1-ba0d-6f0756a5358b/log"
headers = {
  'Authorization': 'OAuth PlaceYourRealOAuthToken_Here'
}
response = requests.get(url, headers=headers)

print(response.text)

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://tasks.yandex.ru/api/v1/operations/5c04458e-63c1-46c1-ba0d-6f0756a5358b/log',
  '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.

Ответ

Содержит JSON-массив с описанием каждого шага операции.

[
  {
    "type": _тип_действия_,
    "success": <true/false>,
    "input": {
      _входные_данные_при_создании_операции_
    },
    "output": {
      _выходные_данные_шага_операции_или_подробности_ошибки_
    }
  },
  ...
]
Пример лога при успешной выдаче бонусов
[
  {
    "type": "USER_BONUS_PERSIST",
    "success": true,
    "input": {
      "id": 65,
      "amount": 5,
      "created": "2021-02-02T12:51:00",
      "user_id": "ec00d2407f7241258d0faba610110d95",
      "public_title": {
        "EN": "Good job!",
        "RU": "Молодец!"
      },
      "public_message": {
        "EN": "Ten tasks completed",
        "RU": "Выполнено 10 заданий"
      },
      "private_comment": "pool_123456",
      "without_message": false
    },
    "output": {
      "user_bonus_id": "2128"
    }
  }
]
Пример лога при неуспешной выдаче бонусов
[
  {
    "type": "USER_BONUS_VALIDATE",
    "success": false,
    "input": {
      "id": 65,
      "amount": 5,
      "created": "2021-02-02T12:51:00",
      "user_id": "ec00d2407f7241258d0faba610110d95",
      "public_title": {
        "EN": "Good job!",
        "RU": "Молодец!"
      },
      "public_message": {
        "EN": "Ten tasks completed",
        "RU": "Выполнено 10 заданий"
      },
      "private_comment": "pool_123456",
      "without_message": false
   },
    "output": {
      "user_id": {
        "code": "ENTITY_DOES_NOT_EXIST",
        "message": "Entity does not exist"
      }
    }
  }
]

Параметр

Описание

type

string

Тип действия на шаге операции. Зависит от:

  • типа операции, по которой запрашивается лог;
  • результата выполнения (success: true/false).

Значения type при успешной асинхронной операции:

  • USER_BONUS_PERSIST — выдача бонуса.
  • TASK_CREATE — создание задания.
  • TASK_SUITE_CREATE — создание страницы заданий.

Значения type при неуспешной асинхронной операции:

  • USER_BONUS_VALIDATE — выдача бонуса.
  • TASK_VALIDATE — создание задания.
  • TASK_SUITE_VALIDATE — создание страницы заданий.

От типа операции зависят значения input и output.

success

boolean

Результат выполнения шага:

  • true — действие выполнено успешно;
  • false — действие не выполнено.

input

object

Данные в input дублируют переданные при создании операции входные данные.

output

object

Выходные данные шага операции.

Данные в output при успешной операции:

  • Для действия USER_BONUS_PERSIST — user_bonus_id (id выданного бонуса).
  • Для действия TASK_CREATE — task_id (id созданного задания).
  • Для действия TASK_SUITE_CREATE — task_suite_id (id созданной страницы заданий).

Данные в output при неуспешной операции:

  • code — имя ошибки.
  • message — пояснение, как исправить ошибку.
  • payload — при code = VALIDATION_ERROR уточняет причину ошибки.

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

Предыдущая
Получить сведения об операции
Следующая
Получение ответов