نموذج PortalPy

تساعد هذه التعليمات في إدراج جميع التصنيفات والأساليب في نموذج PortalPy حيث يمكن استخدامه لكتابة البرنامج النصي الإداري مقابل Portal for ArcGIS.

التصنيف: البوابة الإلكترونية

هو كائن يُمثل اتصال عنوان URL في البوابة الإلكترونية. لإنشاء مثيل لكائن البوابة الإلكترونية، قم بتنفيذ الكود مثل هذا:

PortalPy.Portal(portalUrl, user, password)

يتم إدراج أساليب البوابة الإلكترونية المتاحة في الجزء الموضح أدناه. قبل التعامل مع هذه الأساليب، ضع في الاعتبار ما يلي:

• مُعرفات المجموعة- تتطلب العديد من وظائف المجموعة مُعرّف المجموعة. يختلف المُعرف عن اسم المجموعة أو عنوانها. لتحديد مُعرف المجموعة، استخدم وظيفة search_groups وحدد العنوان للحصول على مُعرف المجموعة.
• الزمن- تقوم العديد من الطرق بإرجاع حقل زمني. ترجع جميع الأوقات باعتبارها مللي ثانية منذ 1 يناير 1970. ويكون الزمن بالثواني في 1 يناير 1970 في بايثون، لذلك قم بقسمة الأزمنة من PortalPy على 1.000. تظهر الأمثلة التالية كيفية تحويل زمن PortalPy إلى زمن بايثون.

  group = portalAdmin.get_group('67e1761068b7453693a0c68c92a62e2e')
  pythontime = time.ctime(group['created']/1000)

أساليب PortalPy

يتم وصف أساليب البوابة الإلكترونية المتاحة أدناه.

_init_

مُنشئ البوابة الإلكترونية. يتطلب ذلك عنوان URL للبوابة الإلكترونية واختياريًا اسم المستخدم وكلمة المرور.

_init_(self, url, username=None, password=None, key_file=None, cert_file=None, expiration=60, referer=None, proxy_host=None, proxy_port=None, connection=None, workdir=r'c:\users\davi3690\appdata\local\temp\2')

add_group_users

يُضيف المستخدمون إلى المجموعة المحددة. لا تستخدم هذه الطريقة إلا إذا كان مستخدم كائن البوابة الإلكترونية إما مسئولاً للبوابة الإلكترونية بأكملها أو المالك الصريح للمجموعة.

add_group_users(self, user_names, group_id)

الوسيطات

معلمة	الوصف
user_names	السلسلة المطلوبة والمستخدمين المفصول بينهم بفاصلة
group_id	السلسلة المطلوبة وتحديد مُعرف المجموعة

إرجاع القيمة

قاموس بمفتاح not_added يحتوي على المستخدمين الذي لم تتم إضافتهم إلى المجموعة.

create_group

يُنشئ المجموعة ويُرجع مُعرف المجموعة إذا نجح.

create_group(self, title, tags, description=None, snippet=None, access='public', thumbnail=None, is_invitation_only=False, sort_field='avgRating', sort_order='desc', is_view_only=False)

الوسيطات

معلمة	الوصف
عنوان	السلسلة المطلوبة واسم المجموعة
العلامات	السلسلة المطلوبة وقائمة العلامات المفصولة بفاصلة
الوصف	السلسلة الاختيارية، تصف المجموعة بالتفصيل
جزء التعليمة البرمجية المتكررة	السلسلة الاختيارية، أقل من 250 حرفًا تُلخص المجموعة
الوصول	السلسلة الاختيارية، يمكن أن تكون خاصة أو عامة أو مؤسسة
الصورة المصغرة	السلسلة الاختيارية، عنوان URL لصورة المجموعة
isInvitationOnly	المنطق الاختياري، يُعرّف ما إن أمكن للمستخدمين الانضمام بالطلب
sort_field	السلسلة الاختيارية، تُحدد كيفية فرز العناصر المشتركة مع المجموعة
sort_order	السلسلة الاختيارية، تصاعديًا أو تنازليًا
is_view_only	المنطق الاختياري، يُعرّف ما إذا كان يمكن البحث عن المجموعة

إرجاع القيمة

السلسلة التي تكون مُعرف المجموعة.

create_group_from_dict

يُنشئ المجموعة ويُرجع مُعرف المجموعة إذا نجح. في معظم الحالات، يُوصي باستخدام create_group، لأن هذا الأسلوب يمكن أن تأخذ قاموس المجموعة من استدعاء PortalPy آخر وتنسخه.

create_group_from_dict(self, group, thumbnail=None)

الوسيطات

معلمة	الوصف
المجموعة	كائن القاموس
الصورة المصغرة	عنوان URL للصورة

مثال

create_group({'title': 'Test', 'access':'public'})

delete_group

تحذف المجموعة.

delete_group(self, group_id)

الوسيطات

معلمة	الوصف
group_id	السلسلة التي تتضمن مُعرّف المجموعة المحذوفة.

إرجاع القيمة

يشير المنطق إلى نجاح أو فشل العملية.

delete_user

يحذف المستخدم من البوابة الإلكترونية، اختياريًا أو إعادة تعيين المجموعات والعناصر. يتعذر عليك حذف مستخدم في البوابة الإلكترونية إذا امتلك مجموعات أو عناصر. عند اختيار التتالي، يتم إعادة تعيين العناصر والمجموعات إلى المستخدم المُعرّف في خيار reassign_to. إذا لم تستخدم التتالي، يعتمد نجاح أو فشل الحذف على ما إذا تم تحويل عناصر ومجموعات المستخدم مُسبقًا.

عند التتالي، ستحذف هذه الطريقة حتى 10.000 عنصر. إذا امتلك المستخدم ما يزيد عن 10.000 عنصر، ستفشل الطريقة.

delete_user(self, username, cascade=False, reassign_to=None)

الوسيطات

معلمة	الوصف
اسم المستخدم	السلسلة المطلوبة، اسم المستخدم
التتالي	المنطق الاختياري، يعني إعادة تعيين العناصر والمجموعات بشكل حقيقي
reassign_to	السلسلة الاختيارية، المالك الجديد للعناصر والمجموعات

إرجاع القيمة

يشير المنطق إلى نجاح أو فشل العملية.

generate_token

يُنتج رمزًا مميزًا جديدًا ويُرجعه، لكن لا يتطلب إعادة تسجيل الدخول. لا تقتضي الحاجة إلى هذا الأسلوب عند استخدام تصنيف البوابة الإلكترونية لإنشاء الاستدعاءات داخل البوابة الإلكترونية. يتم توفير ذلك للحصول على مزايا إنشاء الاستدعاءات داخل البوابة الإلكترونية خارج تصنيف البوابة الإلكترونية.

تستخدم البوابة الإلكترونية آلية المصادقة المستندة إلى الرموز الفريدة حيث يقوم المستخدم بتوفير الاعتمادات وكذلك الرموز الفريدة القصيرة والمستخدمة في الاستدعاءات. تتطلب معظم الاستدعاءات في ArcGIS REST API وجود الرموز الفريدة ويمكن إلحاق ذلك بهذه الطلبات.

generate_token(self, username, password, expiration=60)

الوسيطات

معلمة	الوصف
اسم المستخدم	السلسلة المطلوبة، اسم المستخدم
كلمة السر	كلمة المرور المطلوبة، كلمة مرور المستخدم
‏‏انتهاء الصلاحية	عدد صحيح اختياري، عدد الدقائق حتي تنتهي صلاحية الرمز المميز.

إرجاع القيمة

السلسلة ذات الرموز الفريدة.

get_group

يُرجع معلومات المجموعة لـ group_id المُحدد.

get_group(self, group_id)

الوسيطات

معلمة	الوصف
group_id	السلسلة المطلوبة، تشير إلى المجموعة

إرجاع القيمة

كائن القاموس مع معلومات المجموعة. يمكن أن تتضمن المفاتيح في كائن القاموس ما يلي:

معلمة	الوصف
عنوان	اسم المجموعة
isInvitationOnly	إذا تم التعيين إلى "صحيح"، سيتعذر على المستخدمين التقدُّم للانضمام إلى المجموعة
المالك	اسم مستخدم مالك المجموعة
الوصف	يشرح المجموعة
جزء التعليمة البرمجية المتكررة	ملخص قصير للمجموعة
العلامات	العلامات التي يُعرّفها التي تصف المجموعة
الهاتف	معلومات الاتصال بالمجموعة
الصورة المصغرة	اسم الملف المرتبط بـ http://<community-url>/groups/<groupId>/info
الإنشاء	عند إنشاء المجموعة، مللي ثانية من 1 يناير 1970
تم التعديل	عند آخر تعديل للمجموعة، مللي ثانية من 1 يناير 1970
الوصول	يمكن أن يكون خاصًا أو مؤسسيًا عامًا
userMembership	قاموس به اسم المستخدم وmemberType الأساسين
memberType	يُوفر استدعاء وصول المستخدم (المالك، المسئول، العضو، لا شيء)

get_group_members

يُرجع أعضاء المجموعة المُحددة.

get_group_members(self, group_id)

الوسيطات

معلمة	الوصف
group_id	السلسلة المطلوبة، تشير إلى المجموعة

إرجاع القيمة

القاموس ذات المفاتيح: المالك والمسئولين والمستخدمين.

معلمة	الوصف
المالك	قيمة السلسلة، مالك المجموعة
المسئول	قائمة السلاسل، نمطيًا هذا هو نفس المالك
الحالين	قائمة السلاسل، أعضاء المجموعة

مثال

اطبع المستخدمين في المجموعة:

response = portal.get_group_members("67e1761068b7453693a0c68c92a62e2e")
for user in response['users'] :
   print user

get_group_thumbnail

يُرجع وحدات البايت التي تُنشئ الصورة المصغرة لـ group_id المُحدد.

get_group_thumbnail(self, group_id)

الوسيطات

معلمة	الوصف
group_id	السلسلة المطلوبة، تُحدد الصورة المصغرة للمجموعة

إرجاع القيمة

وحدات البايت التي تُمثل الصورة.

مثال

response = portal.get_group_thumbnail("67e1761068b7453693a0c68c92a62e2e")
f = open(filename, 'wb')
f.write(response)

get_users

يُرجع جميع المستخدمين داخل مؤسسة البوابة الإلكترونية.

get_users(self, max_users=1000)

الوسيطات

معلمة	الوصف
max_users	عدد صحيح اختياري، الحد الأقصى لعدد المستخدمين المُراد إرجاعهم

إرجاع القيمة

قائمة القواميس. كل قاموس به المفاتيح التالية:

مفتاح	قيمة
اسم المستخدم	السلسلة
storageUsage	عدد صحيح
storageQuota	عدد صحيح
الوصف	السلسلة
العلامات	قائمة السلاسل
المنطقة	السلسلة
الإنشاء	عدد صحيح، عند إنشاء الحساب، مللي ثانية من 1 يناير 1970
تم التعديل	عدد صحيح، منذ آخر تعديل للحساب، مللي ثانية من 1 يناير 1970
البريد الإلكتروني	السلسلة
الثقافة	السلسلة
orgId	السلسلة
preferredView	السلسلة
المجموعة	قائمة السلاسل
دور	السلسلة (المستخدم، الناشر، المسئول <custom_role_name>[حيث <custom_role_name> هو اسم الدول المخصص، على سبيل المثال hostedservicepublisher]) قديم: في Portal for ArcGIS 10.3 والإصدارات السابقة، كانت القيم المقبولة للأدوار غير المخصصة هي org_user, org_publisher, و org_admin. في الإصدار 10.3.1، لقد تم إهمال هذه القيم واستبدالها بالقيم المدرجة أعلاه. يمكنك الاستمرار لاستخدام القيم القديمة في الإصدار 10.3.1، لكن لاحظ أنه لا يمكن قبول القيم في الإصدارات المستقبلية.
fullName	السلسلة
الصورة المصغرة	السلسلة
idpUsername	السلسلة

مثال

طباعة جميع أسماء المستخدمين في البوابة الإلكترونية:

resp = portalAdmin.get_users() for user in resp:
   print user['username']

get_properties

يُ{جع خصائص البوابة الإلكترونية باستخدام ذاكرة التخزين المؤقت إذا لم تكن القوى = صواب.

get_properties(self, force=False)

get_user

يُرجع معلومات المستخدم لاسم المستخدم المُحدد.

get_user(self, username)

الوسيطات

معلمة	الوصف
اسم المستخدم	السلسلة المطلوبة، اسم المستخدم الذي تريد الحصول على معلوماته

إرجاع القيمة

عند إيجاد المستخدم، يتم إرجاع كائن القاموس مع المفاتيح التالية. إذا لم يتم العثور على المستخدم، لن يتم إرجاع شيء.

مفتاح	قيمة
الوصول	السلسلة
الإنشاء	عدد صحيح، عند إنشاء الحساب، مللي ثانية من 1 يناير 1970
الثقافة	السلسلة، كود لغة من حرفين (en)
الوصف	السلسلة
البريد الإلكتروني	السلسلة
fullName	السلسلة
idpUsername	السلسلة، اسم المستخدم في النظام المؤسسي
المجموعة	قائمة القواميس. فيما يتعلق بقائمة مفاتيح القواميس، راجع get_group.
تم التعديل	عدد صحيح، منذ آخر تعديل للحساب، مللي ثانية من 1 يناير 1970
orgId	السلسلة، مُعرف المؤسسة
preferredView	السلسلة، تكون القيمة إما ويب أو GIS أو لا شيء
المنطقة	السلسلة، لا شيء أو كود الدولة من حرفين
دور	السلسلة (المستخدم، الناشر، المسئول <custom_role_name>[حيث <custom_role_name> هو اسم الدول المخصص، على سبيل المثال hostedservicepublisher]) قديم: في Portal for ArcGIS 10.3 والإصدارات السابقة، كانت القيم المقبولة للأدوار غير المخصصة هي org_user, org_publisher, و org_admin. في الإصدار 10.3.1، لقد تم إهمال هذه القيم واستبدالها بالقيم المدرجة أعلاه. يمكنك الاستمرار لاستخدام القيم القديمة في الإصدار 10.3.1، لكن لاحظ أنه لا يمكن قبول القيم في الإصدارات المستقبلية.
storageUsage	عدد صحيح
storageQuota	عدد صحيح
العلامات	قائمة السلاسل
الصورة المصغرة	السلسلة
اسم المستخدم	السلسلة

get_version

يُرجع رقم إصدار البرنامج، باستخدام ذاكرة التخزين المؤقت إذا لم تكن القوى = صواب. يتم استرداد معلومات الإصدار عند إنشاء كائن البوابة الإلكترونية ويتم تخزينها مؤقتًا للطلبات المستقبلية. إذا أردت إنشاء طلب للبوابة الإلكترونية ولا يستند إلى ذاكرة التخزين المؤقت، قم بتعيين وسيطة القوة لتصبح "صحيح".

get_version(self, force=False)

الوسيطات

معلمة	الوصف
القوى	المنطق، صحيح=إنشاء طلب، خطأ=استخدام ذاكرة تخزين مؤقت

إرجاع القيمة

السلسلة ذات رقم الإصدار. الإصدار هو رقم داخلي يمكن ألا يتطابق مع إصدار المنتج المُثبت.

invite_group_users

دعوة المستخدمين إلى المجموعة. يرى المستخدم المدعو إلى المجموعة قائمة الدعوات في علامة تبويب المجموعات في البوابة الإلكترونية. يمكن للمستخدم إما قبول الدعوة أو رفضها. يتعين أن يكون المستخدم الذي يقوم بتنفيذ الأمر مالك المجموعة.

invite_group_users(self, user_names, group_id, role='group_member', expiration=10080)

الوسيطات

معلمة	الوصف
user_names	السلسلة المطلوبة، قائمة المستخدمين المفصول بينهم بفاصلة المراد دعوتهم
group_id	السلسلة المطلوبة، تحديد مُعرّف المجموعة التي تدعو المستخدمين إليها
دور	السلسلة الاختيارية، إما group_member أو group_admin
‏‏انتهاء الصلاحية	عدد صحيح اختياري، يُحدد فترة صلاحية الدعوة (بالدقائق)

إرجاع القيمة

يشير المنطق إلى نجاح أو فشل العملية.

is_all_ssl

يُرجع الصواب إذا تطلبت البوابة الإلكترونية HTTPS.

is_all_ssl(self)

is_logged_in

يُرجع الصواب عند تسجيل دخول المستخدم على البوابة الإلكترونية.

is_logged_in(self)

is_org

يُرجع الصواب إذا كانت البوابة الإلكترونية مؤسسة.

is_org(self)

leave_group

يزيل المستخدم الذي يقوم بتسجيل الدخول من المجموعة المحددة. يتعين أن يقوم المستخدم بتسجيل الدخول لاستخدام هذا الأسلوب.

leave_group(self, group_id)

الوسيطات

معلمة	الوصف
group_id	السلسلة المطلوبة وتحديد مُعرف المجموعة

إرجاع القيمة

يشير المنطق إلى نجاح أو فشل العملية.

logged_in_user

يُرجع المعلومات المتعلقة بالمستخدم الذي يقوم بتسجيل الدخول.

logged_in_user(self)

إرجاع القيمة

القاموس الذي يتضمن المفاتيح التالية:

مفتاح	قيمة
اسم المستخدم	السلسلة
storageUsage	عدد صحيح
الوصف	السلسلة
العلامات	السلسلة المفصولة بفاصلة
الإنشاء	عدد صحيح، عند إنشاء الحساب، مللي ثانية من 1 يناير 1970
تم التعديل	عدد صحيح، منذ آخر تعديل للحساب، مللي ثانية من 1 يناير 1970
fullName	السلسلة
البريد الإلكتروني	السلسلة
idpUsername	السلسلة، اسم المستخدم في النظام المؤسسي

تسجيل الدخول

تسجيل الدخول إلى البوابة الإلكترونية باستخدام اسم المستخدم وكلمة المرور. يمكن تسجيل الدخول على البوابة الإلكترونية عند تأسيس كائن البوابة الإلكترونية أو يمكنك تسجيل الدخول فيما بعد. تعمل هذه الوظيفة على تسجيل الدخول لاحقًا.

login(self, username, password, expiration=60)

الوسيطات

معلمة	الوصف
اسم المستخدم	السلسلة المطلوبة
كلمة السر	السلسلة المطلوبة
‏‏انتهاء الصلاحية	العدد الصحيح الاختياري، فترة استمرار الرمز المميز المُنشَأ

إرجاع القيمة

السلسة التي تتضمن الرموز الفريدة.

تسجيل الخروج

تسجيل الخروج من البوابة الإلكترونية. لن تحتفظ البوابة الإلكترونية بأي رموز مميزة موجودة مُستخدمة، وستصبح جميع استدعاءات البوابة الإلكترونية مجهولة حتى تتم إعادة تسجيل دخول مرة أخرى.

logout(self)

إرجاع القيمة

لا يتم إرجاع القيمة.

reassign_group

إعادة تعيين المجموعة لمالك آخر.

reassign_group(self, group_id, target_owner)

الوسيطات

معلمة	الوصف
group_id	السلسلة المطلوبة، المُعرف الفريد للمجموعة
target_owner	السلسلة المطلوبة، اسم المستخدم لمالك المجموعة الجديد

إرجاع القيمة

يشير المنطق إلى نجاح أو فشل العملية.

remove_group_users

يزيل المستخدمون من المجموعة.

remove_group_users(self, user_names, group_id)

الوسيطات

معلمة	الوصف
user_names	السلسة المطلوبة، قائمة المستخدمين المفصولة بفاصلة
group_id	السلسلة المطلوبة، المُعرف الفريد للمجموعة

إرجاع القيمة

القاموس ذات notRemoved الأساسي، يشير إلى عدم إزالة قائمة المستخدمين.

reset_user

يقوم بإعادة تعيين كلمة مرور المستخدم وسؤال الأمان وإجابته. لا يتم تطبيق هذه الوظيفة على البوابات الإلكترونية المُكونة مع الحسابات التي يتم الحصول عليها من مخزن الهوية المؤسسية مثل ActiveDirectory أو LDAP. يتم تطبيقها فقط على مستخدمين البوابة الإلكترونية الداخليين. عند تحديد سؤال أمان جديد، يتم توفير سؤال أمان جديد.

reset_user(self, username, password, new_password=None, new_security_question=None, new_security_answer=None)

الوسيطات

معلمة	الوصف
اسم المستخدم	السلسلة المطلوبة، يتم إعادة تعيين الحساب
كلمة السر	السلسلة المطلوبة، كلمة المرور الحالية
new_password	السلسلة الاختيارية، كلمة مرور جديد عند إعادة تعيين كلمة المرور
new_security_question	عدد صحيح اختياري، سؤال أمان جديد عند الرغبة في ذلك
new_security_answer	سلسلة اختيارية، إجابة سؤال أمان جديد عند الرغبة في ذلك

إرجاع القيمة

يشير المنطق إلى نجاح أو فشل العملية.

البحث

search(self, q, bbox=None, sort_field='title', sort_order='asc', max_results=1000, add_org=True)

search_groups

يبحث عن مجموعات البوابة الإلكترونية. ضع في الاعتبار ما يلي عند استخدام الأسلوب:

• تتميز بنية الاستعلام بالعديد من المزايا غير المذكورة هنا. لمراجعة جميع المزايا، راجع موضوع البحث في المرجع في ArcGIS REST API.
• عند البحث عن المجموعات، سيتم البحث داخل المؤسسة. كوسيلة للراحة، سيقوم الأسلوب بتضمين مُعرف المؤسسة تلقائيًا بالاستعلام افتراضيًا. إذا كنت لا ترغب في تضمين API بالاستعلام، قم بتعيين add_org لتصبح خطأ.

search_groups(self, q, sort_field='title', sort_order='asc', max_groups=1000, add_org=True)

الوسيطات

معلمة	الوصف
q	سلسلة مطلوبة، سلسلة استعلام
sort_field	السلسلة الافتراضية، يمكن أن تكون القيم الصحيحة عنوانًا أو مالكًا أو تم إنشاؤها
sort_order	السلسلة الافتراضية، القيم الصحيحة هي تصاعديًا أو تنازليًا
max_groups	عدد صحيح اختياري، الحد الأقصى لعدد المجموعات التي يتم إرجاعها
add_org	المنطق الاختياري، يتحكم في ما إذا كان البحث في المؤسسة

إرجاع القيمة

قائمة القواميس. كل قاموس به المفاتيح التالية:

مفتاح	قيمة
الوصول	السلسلة، القيم خاصة أو مؤسسية أو عامة
الإنشاء	عدد صحيح، عند إنشاء الحساب، مللي ثانية من 1 يناير 1970
الوصف	السلسلة
المعرف	السلسلة، مُعرف فريد للمجموعة
isInvitationOnly	.
isViewOnly	.
تم التعديل	عدد صحيح، منذ آخر تعديل للحساب، مللي ثانية من 1 يناير 1970
المالك	السلسلة، اسم مستخدم المالك
الهاتف	السلسلة
جزء التعليمة البرمجية المتكررة	السلسلة، ملخص قصير للمجموعة
sortField	السلسلة، كيفية فرز العناصر المشتركة
sortOrder	السلسلة، تصاعديًا أو تنازليًا
العلامات	قائمة السلاسل، العلامات التي يدعمها المستخدم للبحث
الصورة المصغرة	السلسلة، اسم الملف. لحاق بـ http://<community url>/groups/<group id>/info/
عنوان	السلسلة، اسم المجموعة كما هو مُوضح للمستخدمين

search_users

يبحث عن مستخدمين البوابة الإلكترونية. ضع في الاعتبار ما يلي عند استخدام الأسلوب:

• تتميز بنية الاستعلام بالعديد من المزايا غير المذكورة هنا. لعرض جميع المعالم، راجع Search reference في ArcGIS REST API.
• عند البحث عن المستخدمين، ستقوم بالبحث بشكل شائع في المؤسسة. كوسيلة للراحة، سيقوم الأسلوب بتضمين مُعرف المؤسسة تلقائيًا بالاستعلام افتراضيًا. إذا كنت لا ترغب في تضمين API بالاستعلام، قم بتعيين add_org لتصبح خطأ.

search_users(self, q, sort_field='username', sort_order='asc', max_users=1000, add_org=True)

الوسيطات

معلمة	الوصف
q	سلسلة مطلوبة، سلسلة استعلام
sort_field	السلسلة الافتراضية، يمكن أن تكون القيم الصحيحة عنوانًا أو مالكًا أو تم إنشاؤها
sort_order	السلسلة الافتراضية، القيم الصحيحة هي تصاعديًا أو تنازليًا
max_users	عدد صحيح اختياري، الحد الأقصى لعدد المستخدمين الذين يتم إرجاعهم
add_org	المنطق الاختياري، يتحكم في ما إذا كان البحث في المؤسسة

إرجاع القيمة

قائمة القواميس. كل قاموس به المفاتيح التالية:

مفتاح	قيمة
الإنشاء	عدد صحيح، عند إنشاء الحساب، مللي ثانية من 1 يناير 1970
الثقافة	السلسلة، كود لغة من حرفين
الوصف	السلسلة
fullName	السلسلة، اسم المستخدم
تم التعديل	عدد صحيح، منذ آخر تعديل للحساب، مللي ثانية من 1 يناير 1970
المنطقة	السلسلة، يمكن أن تكون لا شيء
العلامات	قائمة السلاسل، العلامات التي يدعمها المستخدم للبحث
الصورة المصغرة	السلسلة، اسم الملف. لحاق بـ http://<community url>/groups/<group id>/info/.
اسم المستخدم	السلسلة، اسم المستخدم

signup

تسجيل المستخدمين على Portal for ArcGIS. تنطبق هذه الطريقة فقط على Portal for ArcGIS ويمكن تسميتها بشكل مجهول. مع ذلك، يمكن تعطيل الاشتراك الذاتي في البوابة الإلكترونية. يُنشئ حسابات داخلية، لا تتعامل مع الحسابات المؤسسية التي يتم الحصول عليها من مخزن الهوية المؤسسي.

يوجد طريقة أخرى باسم createUser التي يمكن استخدامها دائمًا مقابل Portal for ArcGIS 10.2.1أو الإصدار الأحدث. يتطلب الأسلوب وصول المسئول ويمكن استخدامها لإنشاء المستخدمين الداخلين أو إضافة الحسابات المؤسسية إلى البوابة الإلكترونية.

signup(self, username, password, fullname, email)

الوسيطات

معلمة	الوصف
اسم المستخدم	السلسلة المطلوبة، تتعين أن تكون فريدة في البوابة الإلكترونية ,أكثر من 4 أحرف
كلمة السر	السلسلة المطلوبة، يجب أن تكون أكثر من أو تساوي 8 أحرف
fullname	السلسلة المطلوبة، اسم المستخدم
البريد الإلكتروني	السلسلة المطلوبة، يجب أن يكون عنوان بريد إلكتروني صحيح

إرجاع القيمة

يشير المنطق إلى نجاح أو فشل العملية.

update_group

يقوم بتحديث المجموعة. تحتاج فقط إلى توفير قيم للوسيطات التي تريد تحديثها.

update_group(self, group_id, title=None, tags=None, description=None, snippet=None, access=None, is_invitation_only=None, sort_field=None, sort_order=None, is_view_only=None, thumbnail=None)

الوسيطات

معلمة	الوصف
group_id	السلسلة المطلوبة، مُعرّف المجموعة المراد تعديلها
عنوان	السلسلة المطلوبة، اسم المجموعة المُراد تعديلها
العلامات	السلسلة المطلوبة وقائمة العلامات المفصولة بفاصلة
الوصف	السلسلة الاختيارية، تصف المجموعة بالتفصيل
جزء التعليمة البرمجية المتكررة	السلسلة الاختيارية، أقل من 250 حرفًا تُلخص المجموعة
الوصول	السلسلة الاختيارية، يمكن أن تكون خاصة أو عامة أو مؤسسة
الصورة المصغرة	السلسلة الاختيارية، عنوان URL لصورة المجموعة
isInvitationOnly	المنطق الاختياري، يُعرّف ما إن أمكن للمستخدمين الانضمام بالطلب
sort_field	السلسلة الاختيارية، تُحدد كيفية فرز العناصر المشتركة مع المجموعة
sort_order	السلسلة الاختيارية، تصاعديًا أو تنازليًا
is_view_only	المنطق الاختياري، يُعرّف ما إذا كان يمكن البحث عن المجموعة

إرجاع القيمة

يشير المنطق إلى نجاح أو فشل العملية.

update_user

يقوم بتحديث خصائص المستخدم. يوفر فقط قيم للوسيطات التي تريد تحديثها.

update_user(self, username, access=None, preferred_view=None, description=None, tags=None, thumbnail=None, fullname=None, email=None, culture=None, region=None)

الوسيطات

مفتاح	قيمة
اسم المستخدم	السلسلة المطلوبة، تحديث اسم المستخدم
الوصول	السلسلة الاختيارية، القيم: خاصة أو مؤسسية أو عامة
preferred_view	السلسلة الاختيارية، القيم: ويب أو GIS أو لا شيء
الوصف	السلسلة الاختيارية، وصف للمستخدم
العلامات	السلسلة الاختيارية، العلامات المفصولة بفاصلة للبحث
الصورة المصغرة	السلسلة الاختيارية، مسار أو عنوان URL لملف. يمكن أن تكون PNG أو GIF أو JPEG. الحجم الأقصى المسموح به للحجم هو 1 ميجابايت.
fullName	السلسلة الاختيارية، اسم المستخدم، للمستخدمين المُضمنين فقط
البريد الإلكتروني	السلسلة الاختيارية، عنوان البريد الإلكتروني، للمستخدمين المُضمنين فقط
الثقافة	السلسلة الاختيارية، كود لغة من حرفين، مثال fr.
المنطقة	السلسلة الاختيارية، كود بلد من حرفين، مثال FR

إرجاع القيمة

يشير المنطق إلى نجاح أو فشل العملية.

update_user_role

يقوم بتحديث دور المستخدم.

update_user_role(self, username, role)

الوسيطات

مفتاح	قيمة
اسم المستخدم	السلسلة المطلوبة، اسم المستخدم الذي يتغير دوره
دور	يتطلب سلسلة، إما مستخدم، ناشر، مسئول, <custom_role_ID> (حيث يكون <custom_role_ID> هو معرف الدور المخصص، على سبيل المثال 1eo7LSAhbNiG1q9t, الذي يتوفر أسفل الأدوار في موقع مشاركة دليل ArcGIS Portal. يكون عنوان URL بالتنسيق https://webadaptorhost.domain.com/<webadaptorname>/sharing/portals/0123456789ABCDEF/roles). قديم: في Portal for ArcGIS 10.3 والإصدارات السابقة، كانت القيم المقبولة للأدوار غير المخصصة هي org_user, org_publisher, و org_admin. في الإصدار 10.3.1، لقد تم إهمال هذه القيم واستبدالها بالقيم المدرجة أعلاه. يمكنك الاستمرار لاستخدام القيم القديمة في الإصدار 10.3.1، لكن لاحظ أنه لا يمكن قبول القيم في الإصدارات المستقبلية.

إرجاع القيمة

يشير المنطق إلى نجاح أو فشل العملية.