Задачи

Список всех задач

Получите все задачи, включая завершённые или отменённые.

Метод

GET

URL

/api/v1/:projectKey/jobs

Заголовки запроса

Authorization: {YOUR_ORGANIZATION_API_KEY}: ключ можно найти в ‘Preferences’ > ‘Account’ > ‘Organization API Key’.

Коды статуса

200: ответ отправлен в виде JSON в теле

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

curl -X GET \
  https://openreplay.example.com/api/v1/3sWXSsqHgSKnE87YkNJK/jobs \
  -H 'content-type: application/json' \
  -H 'Authorization: {YOUR_ORGANIZATION_API_KEY}'

Пример ответа

{
  "data": [
    {
      "jobId": 3451,
      "description": "Delete user sessions of userId = shekar@example.com",
      "status": "scheduled",
      "projectId": 1,
      "action": "delete_user_data",
      "referenceId": "mehdi@openreplay.com",
      "createdAt": 1623912955277,
      "updatedAt": 1623912955277,
      "startAt": 1623954600000,
      "errors": null
    },
    {
      "jobId": 3452,
      "description": "Delete user sessions of userId = shekar@example.com",
      "status": "cancelled",
      "projectId": 1,
      "action": "delete_user_data",
      "referenceId": "mehdi@openreplay.com",
      "createdAt": 1623912962910,
      "updatedAt": 1623913015276,
      "startAt": 1623954600000,
      "errors": null
    }
  ]
}

Получение сведений о задаче

Возвращает status задачи и другие сведения, такие как createdAt, referenceId и errors.

Метод

GET

URL

/api/v1/:projectKey/jobs/:jobId

Параметры

Имя	Тип	Описание
jobId	string	ID, возвращённый вызовом удаления пользователя (обязательно)

Заголовки запроса

Authorization: {YOUR_ORGANIZATION_API_KEY}: ключ можно найти в ‘Preferences’ > ‘Account’ > ‘Organization API Key’.

Коды статуса

200: ответ отправлен в виде JSON в теле

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

curl -X GET \
  https://openreplay.example.com/api/v1/3sWXSsqHgSKnE87YkNJK/jobs/3451\
  -H 'content-type: application/json' \
  -H 'Authorization: {YOUR_ORGANIZATION_API_KEY}'

Пример ответа

{
  "data": {
    "jobId": 3451,
    "description": "Delete user sessions of userId = shekar@example.com",
    "status": "scheduled",
    "projectId": 1,
    "action": "delete_user_data",
    "referenceId": "mehdi@openreplay.com",
    "createdAt": 1623912955277,
    "updatedAt": 1623912955277,
    "startAt": 1623954600000,
    "errors": null
  }
}

Отмена задачи

Отмените задачу, если она ещё не началась или всё ещё выполняется.

Метод

DELETE

URL

/api/v1/:projectKey/jobs/:jobId

Параметры

Имя	Тип	Описание
jobId	string	ID, возвращённый вызовом удаления пользователя (обязательно)

Заголовки запроса

Authorization: {YOUR_ORGANIZATION_API_KEY}: ключ можно найти в ‘Preferences’ > ‘Account’ > ‘Organization API Key’.

Коды статуса

200: ответ отправлен в виде JSON в теле 501: возвращается, если задачу нельзя отменить

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

curl -X DELETE \
  https://openreplay.example.com/api/v1/3sWXSsqHgSKnE87YkNJK/jobs/3452 \
  -H 'content-type: application/json' \
  -H 'Authorization: {YOUR_ORGANIZATION_API_KEY}'

Пример ответа

{
  "data": {
    "jobId": 3452,
    "description": "Delete user sessions of userId = shekar@example.com",
    "status": "cancelled",
    "projectId": 1,
    "action": "delete_user_data",
    "referenceId": "mehdi@openreplay.com",
    "createdAt": 1623912962910,
    "updatedAt": 1623913015276,
    "startAt": 1623954600000,
    "errors": null
  }
}