استرجع جميع المهام، بما في ذلك المكتملة أو الملغاة.

GET

/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

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

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

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

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
  }
}