بمجرد تشغيل خطاف الويب، يتم توصيل الحمولة إلى عنوان URL المحدد للحمولة. يلتزم كل حدث لنوع خطاف ويب معين بمخطط JSON مماثل، والذي يحتوي على معلومات ذات صلة بالحدث المدعوم. يحدد القسم التالي الخصائص المتضمنة في الحمولات ويقدم أمثلة على الحمولات للمؤسسة وخطافات الويب الخاصة بالخدمة.
حمولات خطاف الويب للمؤسسة
يتناول الجدول أدناه الخصائص المتضمنة في حمولات الويب الخاصة بخطافات الويب للمؤسسة، والتي توفر معلومات حول التغييرات والتحديثات على المستخدمين في مؤسستك وكذلك المجموعات والكائنات والأدوار بها.
الخاصية | الوصف |
---|---|
webhookName | اسم خطاف الويب الذي وصَّلَ الحمولة. |
webhookId | معرّف خطاف الويب الذي وصَّلَ الحمولة. |
portalURL | عنوان URL الخاص بالبوابة الإلكترونية التي يتم تسجيل خطاف الويب لها. |
when | الوقت الذي تم فيه توصيل الحمولة. |
username | المستخدم الذي شغَّل الحدث. |
userId | معرّف المستخدم الذي شغَّل الحدث. |
when | الوقت الذي وقع فيه الحدث. |
operation | نوع العملية التي قام بها المستخدم. تلخص القائمة التالية خاصية نوع العملية التي تم إرجاعها في الحمولة وعمليات واجهة برمجة تطبيقات دليل البوابة الإلكترونية المرتبطة بها:
|
source | نمط المستخدم الذي تمت تأدية العملية عليه. ويمكن أن يكون items، أو group، أو user. |
id | معرّف عنصر المصدر الذي تمت تأدية العملية عليه. |
properties | الخصائص الإضافية المرتبطة بمشغلات حدث معين. توضح القائمة التالية الخصائص الإضافية المتضمنة في الحمولة. للحصول على مزيد من المعلومات حول مشغلات الأحداث التي تتضمن خصائص إضافية، يرجى الاطلاع على مشغلات الحدث، أو انقر فوق الخصائص أدناه لمعرفة المزيد حول مشغل معين وخصائصه. |
مثال على الحمولة
يوضح المثال التالي نموذج حمولة لخطاف ويب خاص بمؤسسة يتم تشغيله عند تحديث مجموعة معينة:
{
"info": {
"webhookName": "Group monitoring",
"webhookId": "72fed926aeb74c9ca8a22aacddc6725a",
"portalURL": "https://orgURL/portal/",
"when": 1543192196521
},
"events": [
{
"username": "administrator",
"userId": "173dd04b69134bdf99c5000aad0b6298",
"when": 1543192196521,
"operation": "update",
"source": "group",
"id": "173dd04b69134bdf99c5000aad0b6298",
"properties": {}
}
]
}
حمولات خطاف الويب لخدمة معالجة البيانات الجغرافية
يسرد الجدول أدناه الخصائص المتضمنة في الحمولات الخاصة بخطافات الويب لخدمة معالجة البيانات الجغرافية التي تقدم معلومات حول التغييرات التي تم إجراؤها على خدمات معالجة البيانات الجغرافية.
الخاصية | الوصف |
---|---|
serviceType | نوع الخدمة التي تم تكوين خطاف الويب لها. بالنسبة لخطافات الويب الخاصة بخدمة المعالم، لن تعود هذه الخاصية إلا بـ GPServer. |
jobId | معرّف وظيفة خدمة معالجة البيانات الجغرافية. |
statusURL | عنوان URL لحالة وظيفة خدمة معالجة البيانات الجغرافية التي قد يتم الاستقصاء عنها للحصول على معلومات حول حالة الوظيفة. |
name | اسم خطاف الويب. |
taskName | اسم أداة المعالجة الجغرافية. |
folderName | المجلد الذي يحتوي على خدمة المعالجة الجغرافية. |
serviceName | اسم خدمة المعالجة الجغرافية. |
eventType | الخاصية التي تصف كيفية اكتمال مهمة خدمة المعالجة الجغرافية. لا تشترك خطافات الويب لخدمة المعالجة الجغرافية في مشغلات أحداث معينة. من ناحية أخرى، توفر خطافات الويب هذه حمولاتها بعد اكتمال وظيفة خدمة المعالجة الجغرافية. تشير قائمة الحمولات هذه إلى ما إذا كانت الوظيفة قد اكتملت بنجاح (esriJobSucceeded)، أو بشكل غير ناجح (esriJobFailed)، أو تم إلغاؤها (esriJobCancelled). القيم: esriJobSucceeded | esriJobFailed | esriJobCancelled |
when | الطابع الزمني لوقت إنجاز المهمة (معبرًا عنه بالمللي ثانية خلال مرحلة زمنية). |
مثال على الحمولة
يوضح المثال التالي نموذجًا لحمولة خطاف الويب لخدمة المعالجة الجغرافية التي يتم تشغيلها عند انتهاء الوظيفة.
{
"serviceType": "GPServer",
"jobId": "jeccad3d9099d4e1591859fdb08f4d1eb",
"statusURL": https://machine.domain.com/webadaptor/rest/services/my_Service/GPServer/jobs/jeccad3d9099d4e1591859fdb08f4d1eb?f=pjson,
"name": "webhook1",
"taskName": "",
"folderName": "",
"serviceName": "my_Service",
"events": [
{
"eventType": "esriJobSucceeded",
"when": 1652458959318
}
]
}
حمولات خطاف الويب لخدمة المعالم
يسرد الجدول أدناه الخصائص المتضمنة في الحمولات الخاصة بخطافات الويب لخدمة المعالم التي تقدم معلومات حول التغييرات التي تم إجراؤها على خدمات المعالم.
الخاصية | الوصف |
---|---|
serviceType | نوع الخدمة التي تم تكوين خطاف الويب لها. بالنسبة لخطافات الويب الخاصة بخدمة المعالم، لن تعود هذه الخاصية إلا بـ FeatureServer. |
changesUrl | عنوان URL لنقطة نهاية استخراج التغييرات الخاصة بالخدمة. بينما تحتوي الحمولة فقط على مشغل الحدث ووقت حدوثه، يمكنك الوصول إلى عنوان URL هذا لمعرفة المزيد حول التغييرات المحددة التي حدثت أثناء الحدث. |
id | معرّف خطاف الويب الذي وصَّلَ الحمولة. |
folderName | المجلد الذي يحتوي على خدمة المعالم. |
serviceName | اسم خدمة المعالم. |
eventType | نوع الحدث الذي تم إجراؤه على خدمة المعالم. لمعرفة المزيد حول قيم نوع التغيير التي يمكنك الاشتراك فيها عند إنشاء خطاف الويب الخاص بك، يرجى الاطلاع على موضوع مشغلات الحدث. القيم: * | FeaturesCreated | FeaturesUpdated | FeaturesDeleted | FeaturesEdited | AttachmentsCreated | AttachmentsUpdated | AttachmentsDeleted | LayerSchemaChanged | LayerDefinitionChanged | FeatureServiceDefinitionChanged | FeaturesPosted |
when | الطابع الزمني (معبرًا عنه بالمللي ثانية خلال مرحلة زمنية) لوقت وقوع الحدث. |
مثال على الحمولة
يوضح المثال التالي نموذج حمولة خطاف الويب لخدمة المعالم التي يتم تشغيلها عند تحديث خدمة المعالم (FeaturesUpdated) وإزالتها (FeaturesDeleted) وتحريرها (FeaturesEdited):
{
"serviceType": "FeatureServer",
"changesUrl": "https://machine.domain.com/webadaptor/rest/services/Hosted/my_Service/FeatureServer/extractChanges?serverGens=12942,13026",
"id": "84e17696-c9d8-43cc-9cf7-5aeb658db12b",
"folderName": "Hosted",
"serviceName": "my_Service",
"events": [
{
"eventType": "FeaturesUpdated",
"when": 1652459863334
},
{
"eventType": "FeaturesDeleted",
"when": 1652459863334
},
{
"eventType": "FeaturesEdited",
"when": 1652459863334
}
]
}