قيم حالة المهمة: scheduled، running، completed، failed، cancelled.

استرجاع جميع مهام مشروع ما، بما في ذلك المهام المكتملة والملغاة. مقسّم إلى صفحات.

GET

/public/:projectKey/jobs

Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}

curl -X GET \
  '{BASE_URL}/public/3sWXSsqHgSKnE87YkNJK/jobs?limit=50&page=1' \
  -H 'Authorization: Bearer {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": "shekar@example.com",
      "createdAt": 1623912955277,
      "updatedAt": null,
      "startAt": 1623954600000,
      "errors": null
    },
    {
      "jobId": 3452,
      "description": "Delete user sessions of userId = mehdi@example.com",
      "status": "cancelled",
      "projectId": 1,
      "action": "delete_user_data",
      "referenceId": "mehdi@example.com",
      "createdAt": 1623912962910,
      "updatedAt": 1623913015276,
      "startAt": 1623954600000,
      "errors": null
    }
  ]
}

إرجاع حالة المهمة وبياناتها الوصفية.

GET

/public/:projectKey/jobs/:jobId

Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}

200: تم إرسال الاستجابة بصيغة JSON في النص
400: jobId غير صالح (ليس عدداً صحيحاً)
404: لم يتم العثور على المهمة

curl -X GET \
  {BASE_URL}/public/3sWXSsqHgSKnE87YkNJK/jobs/3451 \
  -H 'Authorization: Bearer {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": "shekar@example.com",
    "createdAt": 1623912955277,
    "updatedAt": null,
    "startAt": 1623954600000,
    "errors": null
  }
}

إلغاء مهمة لم تبدأ بعد أو لا تزال قيد التنفيذ.

DELETE

/public/:projectKey/jobs/:jobId

Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}

200: تم إلغاء المهمة
400: لا يمكن إلغاء المهمة في حالتها الحالية، أو jobId غير صالح
404: لم يتم العثور على المهمة

curl -X DELETE \
  {BASE_URL}/public/3sWXSsqHgSKnE87YkNJK/jobs/3452 \
  -H 'Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}'

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