فضاء خاص

Français

العربية

إبداء رأيكم

دليل واجهة برمجة التطبيقات (API)

يوضح هذا القسم واجهة برمجة التطبيقات (API) الخاصة بـ CKAN، وهي موجهة للمستعملين الذين يرغبون في إعداد برمجيات للتفاعل مع مواقع CKAN وبياناتها.

تُعدّ واجهة برمجة التطبيقات للإجراءات الخاصة بـ CKAN واجهة قوية من نوع RPC تتيح للعملاء الوصول إلى جميع الميزات الرئيسية لـ CKAN. يمكن لأي كود خارجي يتصل بواجهة برمجة التطبيقات الاستفادة من كل وظائف موقع CKAN (بما في ذلك تلك المتوفرة عبر واجهة الويب والمزيد). على سبيل المثال، يمكن لتطبيقك باستخدام واجهة برمجة التطبيقات CKAN أن:

ملاحظة :

تحتوي وحدات FileStore وDataStore الخاصة بـ CKAN على واجهات برمجة تطبيقات خاصة بها، راجع:

ملاحظة :

للاطلاع على توثيق واجهات برمجة التطبيقات القديمة لـ CKAN، راجع واجهات برمجة التطبيقات القديمة.

ملاحظة :

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

إجراء طلب إلى واجهة برمجة التطبيقات (API)

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

إحدى الطرق لإرسال قاموس JSON إلى رابط هي استخدام عميل سطر الأوامر Curl. على سبيل المثال، للحصول على قائمة بأسماء جميع مجموعات البيانات في المجموعة data-explorer على الموقع demo.ckan.org، قم بتثبيت curl ونفّذ دالة واجهة برمجة التطبيقات group_list باستخدام هذا الأمر في الطرفية:

curl https://demo.ckan.org/api/3/action/group_list

سيكون رد CKAN مشابهًا لما يلي:

{
	"help": "...",
	"result": [
		"data-explorer",
		"department-of-ricky",
		"geo-examples",
		"geothermal-data",
		"reykjavik",
		"skeenawild-conservation-trust"
	],
	"success": true
}

الرد هو قاموس JSON يحتوي على ثلاثة مفاتيح:

  1. "success": true أو false.

    تُرجع واجهة برمجة التطبيقات دائمًا رمز الحالة HTTP 200 OK بغض النظر عن وجود أخطاء أم لا. لذلك، من المهم التحقق من قيمة المفتاح "success"، وإذا كانت success تساوي false، فيجب التحقق من قيمة المفتاح "error".

ملاحظة

في حالة وجود مشكلات كبيرة في التنسيق، قد تُرجع CKAN رد HTTP مع رمز حالة 409، 400، أو 500 (بالترتيب التصاعدي للشدة). في الإصدارات المستقبلية من CKAN، سيتم استبدال هذه الردود بـ 200 OK مع استخدام المفاتيح "success" و"error".

  1. "result": نتيجة الدالة المستدعاة. يختلف النوع والقيمة حسب الدالة. بالنسبة لدالة group_list، فهي عبارة عن قائمة من النصوص تحتوي على أسماء مجموعات البيانات في المجموعة.

  2. "help": النص التوضيحي للدالة المستدعاة.

يمكنك إجراء نفس طلب HTTP باستخدام الوحدة القياسية urllib2 في بايثون:

#!/usr/bin/env python
import urllib2
import json

# إجراء طلب HTTP.
response = urllib2.urlopen('https://data.gov.ma/data/api/3/action/group_list')

# تحميل الرد في قاموس.
response_dict = json.loads(response.read())

# طباعة النتيجة.
print(response_dict['result'])

مثال: استيراد مجموعات البيانات باستخدام واجهة برمجة التطبيقات CKAN

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

مطلوب التنفيذ

اجعل هذا البرنامج النصي أكثر إثارة (مثل قراءة البيانات من ملف CSV)، وضع البرنامج بأكمله في ملف .py مع اختبارات، ثم قم باستيراده هنا.

#!/usr/bin/env python
import urllib2
import urllib
import json
import pprint

# ضع تفاصيل مجموعة البيانات المراد إنشاؤها في قاموس.
dataset_dict = {
		'name': 'my_dataset_name',
		'notes': 'وصف طويل لمجموعة البيانات الخاصة بي',
		'owner_org': 'org_id_or_name'
}

# استخدم وحدة json لتحويل القاموس إلى سلسلة نصوص للإرسال.
data_string = urllib.quote(json.dumps(dataset_dict))

# استخدم الوظيفة package_create لإنشاء مجموعة بيانات جديدة.
request = urllib2.Request(
	'http://www.my_ckan_site.com/api/action/package_create')

# يتطلب إنشاء مجموعة بيانات عنوان تفويض.
# استبدل *** بمفتاح API الخاص بك، المتوفر في حسابك على موقع CKAN
# حيث تقوم بإنشاء مجموعة البيانات.
request.add_header('Authorization', '***')

# تنفيذ الطلب HTTP.
response = urllib2.urlopen(request, data_string)
assert response.code == 200

# استخدم وحدة json لتحميل رد CKAN في قاموس.
response_dict = json.loads(response.read())
assert response_dict['success'] is True

# تعيد package_create مجموعة البيانات التي تم إنشاؤها كنتيجة.
created_package = response_dict['result']
pprint.pprint(created_package)

لمزيد من الأمثلة، انظر أمثلة API.

تُصدر واجهات برمجة التطبيقات (APIs) الخاصة بـ CKAN وفق إصدارات محددة. إذا قمت بإرسال طلب إلى عنوان URL لواجهة برمجة التطبيقات دون تحديد رقم الإصدار، فسيقوم CKAN باستخدام أحدث إصدار متوفر من واجهة برمجة التطبيقات:

http://demo.ckan.org/api/action/package_list

يمكنك أيضًا تحديد رقم إصدار واجهة برمجة التطبيقات في عنوان URL الخاص بطلبك:

http://demo.ckan.org/api/3/action/package_list

حاليًا، الإصدار 3 هو الإصدار الوحيد المتوفر من واجهة API Action.

ننصحك بتحديد رقم إصدار واجهة برمجة التطبيقات في طلباتك، حيث يضمن ذلك عمل العميل الخاص بك (API Client) على مواقع مختلفة تعمل بإصدارات مختلفة من CKAN، وسيستمر العمل حتى في حالة تحديث هذه المواقع لإصدارات جديدة من CKAN. ونظرًا لأن أحدث إصدار من واجهة برمجة التطبيقات قد يتغير عند تحديث أحد مواقع CKAN أو قد يختلف بين مواقع تعمل بإصدارات مختلفة من CKAN، فإن نتيجة طلب API بدون تحديد رقم الإصدار قد لا تكون موثوقة.

المصادقة والرموز المميزة لواجهة برمجة التطبيقات (API)

تحذير

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

تتطلب بعض وظائف واجهة برمجة التطبيقات (API) الحصول على إذن. تعتمد API على نفس وظائف وتكوينات الإذن المستخدمة في واجهة الويب. وبالتالي، إذا كان لدى المستخدم إذن لتنفيذ إجراء معين عبر واجهة الويب، فسيكون لديه الإذن نفسه عبر واجهة برمجة التطبيقات (API).

عند استدعاء وظيفة API تتطلب إذنًا، يجب أن تصادق على طلبك عن طريق تقديم مفتاح مصادقة ضمن طلب HTTP الخاص بك. بدءًا من CKAN 2.9، الطريقة الموصى بها هي استخدام الرموز المميزة لواجهة برمجة التطبيقات (API Tokens). يمكن إنشاء هذه الرموز المشفرة يدويًا عبر واجهة المستخدم (ملف تعريف المستخدم > إدارة > الرموز المميزة لواجهة برمجة التطبيقات) أو عبر وظيفة api_token_create(). يمكن للمستخدم إنشاء أي عدد من الرموز المميزة لاستخدامات مختلفة وإلغائها في أي وقت. بالإضافة إلى ذلك، يسمح تفعيل الملحق expire_api_token بتحديد تاريخ انتهاء صلاحية للرمز المميز.

يمكن لمسؤولي الموقع تكوين إعدادات إنشاء الرموز المميزة عبر إعدادات الرموز المميزة لواجهة برمجة التطبيقات.

لا تزال مفاتيح API القديمة (UUIDs مثل ec5c0860-9e48-41f3-8850-4a7128b18df8) مدعومة، ولكن لا يُوصى باستخدامها لأنها أقل أمانًا من الرموز المميزة، ومحدودة بمفتاح واحد لكل مستخدم. سيتم التخلص من دعم مفاتيح API القديمة في الإصدارات المستقبلية من CKAN.

لتقديم الرمز المميز الخاص بك ضمن طلب HTTP، قم بإدراجه في رأس (Header) Authorization أو X-CKAN-API-Key. (يمكن تكوين اسم رأس HTTP باستخدام الخيار apikey_header_name في ملف تكوين CKAN.)

على سبيل المثال، للتحقق مما إذا كنت تتابع المستخدم markw حاليًا على demo.ckan.org باستخدام curl، يمكنك تنفيذ الأمر التالي:

curl -H "Authorization: XXX" https://demo.ckan.org/api/3/action/am_following_user?id=markw

(استبدل XXX برمز API الخاص بك.)

أو، للحصول على قائمة الأنشطة في لوحة القيادة الخاصة بك على demo.ckan.org، نفذ هذا الرمز بلغة Python:

request = urllib2.Request('https://demo.ckan.org/api/3/action/dashboard_activity_list')
request.add_header('Authorization', 'XXX')
response_dict = json.loads(urllib2.urlopen(request, '{}').read())

الدوال المتاحة عبر GET في API

يمكن استدعاء الدوال المعرفة في ckan.logic.action.get باستخدام طلب HTTP من نوع GET. على سبيل المثال، للحصول على قائمة مجموعات البيانات (packages) من demo.ckan.org، افتح هذا الرابط في متصفحك:

https://data.gov.ma/data/api/3/action/package_list

أو، للبحث عن مجموعات بيانات تتطابق مع الاستعلام spending على demo.ckan.org، افتح هذا الرابط في متصفحك:

https://data.gov.ma/data/api/3/action/package_search?q=spending

نصيحة

يمكن للإضافات مثل JSONView لمتصفح Firefox أو Chrome عرض استجابات JSON من CKAN مع تنسيق ملون في متصفحك.

يتم إرسال استعلام البحث كمعامل في URL ?q=spending. يمكن إضافة العديد من معلمات URL، مفصولة بعلامة &. على سبيل المثال، للحصول على أول 10 مجموعات بيانات فقط، افتح هذا الرابط:

https://data.gov.ma/data/api/3/action/package_search?q=spending&rows=10

عندما تتطلب إحدى الإجراءات قائمة من السلاسل كقيمة لمتغير ما، يمكن إرسال القيمة عن طريق تكرار المتغير عدة مرات في URL:

https://data.gov.ma/data/api/3/action/term_translation_show?terms=russian&terms=romantic%20novel

دعم JSONP

لتلبية احتياجات السكربتات القادمة من مواقع أخرى التي ترغب في الوصول إلى API، يمكن إرسال البيانات بتنسيق JSONP، حيث يتم "تغليف" بيانات JSON في استدعاء دالة. يتم تحديد اسم الدالة في معلمة «callback». على سبيل المثال:

https://data.gov.ma/data/api/3/action/package_show?id=adur_district_spending&callback=myfunction

ملاحظة

هذا يعمل فقط لطلبات GET

أمثلة على استخدام واجهة برمجة التطبيقات (API)

التصنيفات (غير مدرجة في قاموس)

قائمة بجميع التصنيفات :

أكثر 10 تصنيفات شيوعاً بين مجموعات البيانات :

جميع مجموعات البيانات التي تحتوي على التصنيف « الاقتصاد » :

قواميس التصنيفات

أهم 10 تصنيفات وقواميس التصنيفات المستخدمة في مجموعات البيانات :

على سبيل المثال، Facet : vocab_Topics يعني أنه يوجد قاموس يسمى Topics، وأهم التصنيفات تحت هذا القاموس.

قائمة مجموعات البيانات التي تستخدم التصنيف « التعليم » في القاموس « Topics » :

تحميل إصدار جديد من ملف المورد

يمكنك استخدام المعامل upload في دالة resource_patch() لتحميل إصدار جديد من ملف المورد. يتطلب ذلك طلب multipart/form-data. باستخدام curl، يمكنك فعل ذلك مع @file.csv :

curl -X POST  -H "Content-Type: multipart/form-data"  -H "Authorization: XXXX"  -F "id=<resource_id>" -F "upload=@updated_file.csv" https://demo.ckan.org/api/3/action/resource_patch

مرجع API للإجراءات

ملاحظة

إذا قمت باستدعاء إحدى دوال الإجراءات المدرجة أدناه وكان هذا الاستدعاء يؤدي إلى استثناء، سترسل API قاموس JSON يحتوي على المفتاح "success": false ومفتاح "error" الذي يحدد الاستثناء الذي تم رفعه.

على سبيل المثال، member_list() (التي تعيد قائمة أعضاء مجموعة) ترفع استثناء NotFound إذا كانت المجموعة غير موجودة. إذا قمت باستدعائها عبر API، ستحصل على قاموس JSON مشابه لما يلي :

{
	"success": false
	"error": {
		"__type": "نوع الخطأ Not Found",
		"message": "لم يتم العثور عليه"
	},
	"help": "...",
}

ckan.logic.action.get

دوال API للبحث واسترجاع البيانات من CKAN.

ckan.logic.action.get.site_read(context, data_dict=None)

ترجع True.

نوع العودة : bool
ckan.logic.action.get.package_list(context, data_dict)

ترجع قائمة بأسماء مجموعات البيانات (الباكاجات) من الموقع.

المعلمات :
  • limit (int) – إذا تم تحديده، سيتم تقسيم قائمة مجموعات البيانات إلى صفحات تحتوي على limit مجموعة بيانات في كل صفحة وسيتم إرجاع صفحة واحدة فقط في كل مرة (اختياري)
  • offset (int) – عندما يتم تحديد limit, الإزاحة التي سيتم بدء منها إرجاع مجموعات البيانات
نوع العودة :

قائمة من سلاسل الأحرف
ckan.logic.action.get.current_package_list_with_resources(context, data_dict)

ترجع قائمة بمجموعات البيانات (الباكاجات) من الموقع ومواردها.

تتم ترتيب القائمة حسب تاريخ التعديل، بحيث تظهر التعديلات الأحدث أولاً.

المعلمات :
  • limit (int) – إذا تم تحديده، ستتم تقسيم قائمة مجموعات البيانات إلى صفحات تحتوي على limit مجموعة بيانات في كل صفحة وستتم إرجاع صفحة واحدة فقط في كل مرة (اختياري)
  • offset (int) – عندما يتم تحديد limit, الإزاحة التي سيتم بدء منها إرجاع مجموعات البيانات
  • page (int) – عندما يتم تحديد limit, أي صفحة سيتم إرجاعها، ولكنها قديمة: استخدم offset
نوع العودة :

قائمة من القواميس
ckan.logic.action.get.member_list(context, data_dict=None)

يرجع قائمة أعضاء المجموعة.

يجب أن يمتلك المستخدم إذن 'استرجاع' المجموعة.

المعلمات:
  • id (سلسلة نصية) – معرّف أو اسم المجموعة
  • object_type (سلسلة نصية) – تحديد نوع الأعضاء المعادين، مثل 'user' أو 'package' (اختياري، الافتراضي: None)
  • capacity (سلسلة نصية) – تحديد الأعضاء الذين لديهم قدرة معينة، مثل 'member'، 'editor'، 'admin'، 'public'، 'private' (اختياري، الافتراضي: None)
نوع الإرجاع:

قائمة من tuples (معرّف، نوع، قدرة)
يرتفع:

ckan.logic.NotFound : إذا كانت المجموعة غير موجودة
ckan.logic.action.get.package_collaborator_list(context, data_dict)

يعيد قائمة بجميع المتعاونين في الحزمة المحددة.

حاليًا، يجب أن تكون مسؤولًا في المنظمة المالكة للحزمة لإدارة المتعاونين.

ملاحظة: تتطلب هذه العملية تفعيل ميزة المتعاونين باستخدام خيار الإعداد ckan.auth.allow_dataset_collaborators.

المعلمات:
  • id (سلسلة نصية) – معرّف أو اسم الحزمة
  • capacity (سلسلة نصية) – (اختياري) إذا تم توفيره، يتم إرجاع المستخدمين الذين لديهم هذه القدرة فقط
الإرجاع:

قائمة بالمتعاونين، وكل متعاون عبارة عن قاموس يحتوي على معرف الحزمة ومعرف المستخدم، القدرة، وتاريخ آخر تعديل
نوع الإرجاع:

قائمة من القواميس
ckan.logic.action.get.package_collaborator_list_for_user(context, data_dict)

يعيد قائمة بجميع الحزم التي يكون فيها المستخدم متعاونًا.

ملاحظة: تتطلب هذه العملية تفعيل ميزة المتعاونين باستخدام خيار الإعداد ckan.auth.allow_dataset_collaborators.

المعلمات:
  • id (سلسلة نصية) – معرّف أو اسم المستخدم
  • capacity (سلسلة نصية) – (اختياري) إذا تم توفيره، يتم إرجاع الحزم التي يمتلك المستخدم هذه القدرة فيها فقط
الإرجاع:

قائمة بالحزم، كل حزمة عبارة عن قاموس يحتوي على معرف الحزمة، القدرة، وتاريخ آخر تعديل
نوع الإرجاع:

قائمة من القواميس
ckan.logic.action.get.group_list(context, data_dict)

يعيد قائمة بأسماء المجموعات في الموقع.

المعلمات:
  • data_dict (قاموس) – قاموس للمعلمات الاختيارية (اختياري) يحتوي على العناصر التالية:
    • filters (قاموس) – مجموعة من الفلاتر الاختيارية لتقييد قائمة المجموعات المُعادة (اختياري)
الإرجاع:

قائمة من القواميس تحتوي على معلومات حول كل مجموعة
نوع الإرجاع:

قائمة من القواميس
ckan.logic.action.get.organization_list(context, data_dict)

يعيد قائمة بأسماء المنظمات في الموقع.

المعلمات:
  • order_by (سلسلة) – الحقل الذي يتم عليه ترتيب القائمة، يجب أن يكون 'name' أو 'packages' (اختياري، الافتراضي: 'name'). غير مستحسن، يفضل استخدام sort.
  • sort (سلسلة) – ترتيب نتائج البحث. اختياري. الافتراضي: « title asc »، سلسلة تحتوي على اسم الحقل ونوع الترتيب. الحقول المسموح بها: ‘name’، ‘package_count’، و ‘title’.
  • limit (عدد صحيح) – العدد الأقصى للمنظمات المُعادة (اختياري). الافتراضي: 1000 عند ضبط all_fields=false، إلا إذا تم تعيينه في إعدادات الموقع ckan.group_and_organization_list_max. الافتراضي: 25 عند ضبط all_fields=true، إلا إذا تم تعيينه في إعدادات الموقع ckan.group_and_organization_list_all_fields_max.
  • offset (عدد صحيح) – عند ضبط limit، الإزاحة لبدء إرجاع المنظمات.
  • organizations (قائمة سلاسل) – قائمة بأسماء المجموعات المُعادة. إذا تم توفيرها، ستُعاد فقط المجموعات التي تكون أسماؤها ضمن هذه القائمة (اختياري).
  • all_fields (منطقي) – يعيد قواميس للمنظمات بدلاً من الأسماء فقط. يتم إرجاع الحقول الأساسية فقط – للحصول على المزيد، استخدم الخيارات include_*. إرجاع قائمة الحزم مكلف للغاية، لذا الخاصية packages لكل مجموعة غير مستحسنة، ولكن يوجد عداد الحزم في الخاصية package_count. (اختياري، الافتراضي: False)
  • include_dataset_count (منطقي) – عند ضبط all_fields، تضمين package_count كامل في كل منظمة (اختياري، الافتراضي: True)
  • include_extras (منطقي) – عند ضبط all_fields، تضمين الحقول الإضافية للمنظمة (اختياري، الافتراضي: False)
  • include_tags (منطقي) – عند ضبط all_fields، تضمين العلامات الخاصة بالمنظمة (اختياري، الافتراضي: False)
  • include_groups (منطقي) – عند ضبط all_fields، تضمين المجموعات التي تنتمي إليها المنظمات (اختياري، الافتراضي: False)
  • include_users (منطقي) – عند ضبط all_fields، تضمين المستخدمين في المنظمة (اختياري، الافتراضي: False)
نوع الإرجاع:

قائمة من سلاسل النصوص
ckan.logic.action.get.group_list_authz(context, data_dict)

يعيد قائمة بالمجموعات التي يُسمح للمستخدم بتعديلها.

المعلمات:
  • available_only (منطقي) – يستبعد المجموعات الموجودة بالفعل في الحزمة (اختياري، الافتراضي: False)
  • am_member (منطقي) – إذا كان True يعيد فقط المجموعات التي يكون المستخدم عضواً فيها، وإلا يعيد جميع المجموعات التي يُسمح للمستخدم بتعديلها (على سبيل المثال، يُسمح لمستخدمي sysadmin بتعديل جميع المجموعات) (اختياري، الافتراضي: False)
نوع الإرجاع:

قائمة بالمجموعات على شكل قواميس يمكن للمستخدم تعديلها.
شكل الإرجاع:

قائمة من القواميس
ckan.logic.action.get.organization_list_for_user(context, data_dict)

يعيد قائمة المنظمات التي يمتلك المستخدم إذناً معيناً للتعامل معها.

على وجه التحديد، تُعيد هذه الدالة قائمة بالمنظمات التي يمتلك المستخدم المصرّح حالياً إذناً معيناً لها (على سبيل المثال: «manage_group»).

بشكل افتراضي، تُعيد الدالة قائمة المنظمات التي يكون المستخدم المصرّح حالياً عضواً فيها بأي صفة.

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

المعلمات:
  • user (نص) – المستخدم الذي سيتم إرجاع قائمة المنظمات له. إذا لم يتم تحديد المستخدم، فسيُستخدم المستخدم المتصل حالياً (اختياري).
  • permission (نص) – الإذن الذي يمتلكه المستخدم على المنظمة. قد يكون هذا الإذن عاماً (مثل: 'manage_group') أو أكثر تحديداً (مثل: 'administer_organization').
  • groups (قائمة) – قائمة المجموعات التي يمتلك المستخدم أذونات عليها. إذا لم تُحدد أي مجموعة، فسيتم إرجاع قائمة المجموعات التي يمتلك المستخدم أذونات عليها.
  • sort (نص) – ترتيب النتائج. اختياري. الافتراضي: «title asc»، نص يتضمن اسم الحقل وترتيب الفرز. الحقول المسموح بها: ‘name’, ‘package_count’ و ‘title’.
  • include_dataset_count (منطقي) – إذا كان True، يتم تضمين عدد مجموعات البيانات لكل منظمة (اختياري، الافتراضي: False).
  • include_extras (منطقي) – إذا كان True، يتم تضمين الحقول الإضافية للمنظمة (اختياري، الافتراضي: False).
  • include_tags (منطقي) – إذا كان True، يتم تضمين العلامات الخاصة بالمنظمة (اختياري، الافتراضي: False).
  • include_groups (منطقي) – إذا كان True، يتم تضمين المجموعات التي تنتمي إليها المنظمة (اختياري، الافتراضي: False).
  • include_users (منطقي) – إذا كان True، يتم تضمين المستخدمين المرتبطين بالمنظمة (اختياري، الافتراضي: False).
نوع الإرجاع:

قائمة من النصوص.
ckan.logic.action.get.tag_list(context, data_dict)

يعيد قائمة العلامات الموجودة على الموقع.

بشكل افتراضي، يتم إرجاع العلامات الحرة فقط (تلك التي لا تنتمي إلى أي مفردات). إذا تم تقديم الوسيطة vocabulary_id، سيتم إرجاع العلامات التي تنتمي إلى تلك المفردات فقط.

المعلمات:
  • query (نص) – استعلام للبحث عن العلامات حسب الاسم. إذا تم تقديمه، سيتم إرجاع العلامات التي تحتوي أسماؤها على النص المطلوب فقط (اختياري).
  • vocabulary_id (نص) – المعرف أو اسم المفردات. إذا تم تقديمه، سيتم إرجاع العلامات التي تنتمي إلى تلك المفردات فقط (اختياري).
  • all_fields (منطقي) – إذا كان True، يتم إرجاع قواميس كاملة للعلامات بدلاً من أسمائها فقط (اختياري، الافتراضي: False).
نوع الإرجاع:

قائمة من القواميس.
ckan.logic.action.get.user_list(context, data_dict)

يعيد قائمة حسابات المستخدمين على الموقع.

المعلمات:
  • q (نص) – تصفية المستخدمين الذين يتم إرجاعهم بناءً على الأسماء التي تحتوي على النص المطلوب (اختياري).
  • email (نص) – تصفية المستخدمين بناءً على عناوين البريد الإلكتروني المطابقة (اختياري، يتطلب أن تكون مسؤول نظام).
  • order_by (نص) – الحقل الذي يتم من خلاله ترتيب القائمة (اختياري، الافتراضي: 'display_name'). يمكن ترتيب المستخدمين باستخدام الحقول التالية: 'id', 'name', 'fullname', 'display_name', 'created', 'about', 'sysadmin', أو 'number_created_packages'.
  • all_fields (منطقي) – إذا كان True، يتم إرجاع قواميس كاملة للمستخدمين بدلاً من أسمائهم فقط (اختياري، الافتراضي: True).
  • include_site_user (منطقي) – إضافة site_user إلى النتيجة (اختياري، الافتراضي: False).
نوع الإرجاع:

قائمة من القواميس تحتوي على بيانات المستخدمين. الخصائص المدرجة للمستخدمين تشمل: number_created_packages الذي يستثني مجموعات البيانات الخاصة أو الموجودة في حالة المسودة.
ckan.logic.action.get.package_relationships_list(context, data_dict)

يعيد العلاقات بين مجموعة بيانات (package).

المعلمات:
  • id (نص) – المعرف أو اسم مجموعة البيانات الأولى.
  • id2 (نص) – المعرف أو اسم مجموعة البيانات الثانية.
  • rel – العلاقة بصيغة نص (راجع package_relationship_create() للحصول على أنواع العلاقات) (اختياري).
نوع الإرجاع:

قائمة من القواميس.
ckan.logic.action.get.package_show(context, data_dict)

يعيد بيانات التعريف لمجموعة بيانات (package) ومواردها.

المعلمات:
  • id (نص) – المعرف أو اسم مجموعة البيانات.
نوع الإرجاع:

قاموس يمثل مجموعة البيانات.
ckan.logic.action.get.package_list(context, data_dict)

يعيد قائمة من مجموعات البيانات (packages).

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

يتم البحث عن الكلمات المفتاحية باستخدام معيار q على الحقول التالية: name, title, notes, author, author_email, maintainer, maintainer_email، وtags.

المعلمات:
  • q (نص) – سلسلة بحث، مثل كلمة مفتاحية للبحث في العنوان، الملاحظات، العلامات، إلخ. (اختياري).
  • tags (نص) – سلسلة من العلامات للبحث عنها (اختياري).
  • vocabulary_id (نص) – معرف أو اسم المفردات (اختياري).
  • all_fields (منطقي) – إرجاع قواميس كاملة لمجموعات البيانات بدلاً من الأسماء فقط (اختياري، الافتراضي: False).
  • start (عدد صحيح) – لتصفح النتائج، يشير إلى فهرس مجموعة البيانات الأولى (اختياري).
  • limit (عدد صحيح) – يحدد عدد مجموعات البيانات التي سيتم إرجاعها (اختياري، الافتراضي: 10).
نوع الإرجاع:

قائمة من القواميس.
ckan.logic.action.get.resource_view_show(context, data_dict)

يعيد البيانات الوصفية لعرض المورد.

المعلمات: id (نص) – معرف عرض المورد
نوع الإرجاع: قاموس
ckan.logic.action.get.resource_view_list(context, data_dict)

يعيد قائمة بعروض الموارد لمورد معين.

المعلمات: id (نص) – معرف المورد
نوع الإرجاع: قائمة من القواميس
ckan.logic.action.get.group_show(context, data_dict)

يعيد تفاصيل مجموعة.

php نسخ الكود
المعلمات:
  • id (نص) – معرف أو اسم المجموعة
  • include_datasets (منطقي) – تضمين قائمة مختصرة من مجموعات البيانات الخاصة بالمجموعة (اختياري، الافتراضي: False)
  • include_dataset_count (منطقي) – تضمين العدد الإجمالي لمجموعات البيانات (اختياري، الافتراضي: True)
  • include_extras (منطقي) – تضمين الحقول الإضافية للمجموعة (اختياري، الافتراضي: True)
  • include_users (منطقي) – تضمين مستخدمي المجموعة (اختياري، الافتراضي: True)
  • include_groups (منطقي) – تضمين المجموعات الفرعية للمجموعة (اختياري، الافتراضي: True)
  • include_tags (منطقي) – تضمين العلامات الخاصة بالمجموعة (اختياري، الافتراضي: True)
  • include_followers (منطقي) – تضمين عدد متابعين المجموعة (اختياري، الافتراضي: True)
نوع الإرجاع:

قاموس

ملاحظة

يتم إرجاع أول 1000 مجموعة بيانات فقط

ckan.logic.action.get.organization_show(context, data_dict)

يعيد تفاصيل المنظمة.

php نسخ الكود
المعلمات:
  • id (نص) – معرف أو اسم المنظمة
  • include_datasets (منطقي) – تضمين قائمة مختصرة من مجموعات البيانات الخاصة بالمنظمة (اختياري، الافتراضي: False)
  • include_dataset_count (منطقي) – تضمين العدد الإجمالي لمجموعات البيانات (اختياري، الافتراضي: True)
  • include_extras (منطقي) – تضمين الحقول الإضافية للمنظمة (اختياري، الافتراضي: True)
  • include_users (منطقي) – تضمين مستخدمي المنظمة (اختياري، الافتراضي: True)
  • include_groups (منطقي) – تضمين المجموعات الفرعية للمنظمة (اختياري، الافتراضي: True)
  • include_tags (منطقي) – تضمين العلامات الخاصة بالمنظمة (اختياري، الافتراضي: True)
  • include_followers (منطقي) – تضمين عدد متابعين المنظمة (اختياري، الافتراضي: True)
نوع الإرجاع:

قاموس

ملاحظة

يتم إرجاع أول 10 مجموعات بيانات فقط

ckan.logic.action.get.group_package_show(context, data_dict)

يعيد مجموعات البيانات (الحزم) الخاصة بمجموعة.

المعلمات:
  • id (نص) – معرف أو اسم المجموعة
  • limit (عدد صحيح) – الحد الأقصى لعدد مجموعات البيانات التي سيتم إرجاعها (اختياري)
نوع الإرجاع:

قائمة من القواميس
ckan.logic.action.get.tag_show(context, data_dict)

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

المعلمات:
  • id (نص) – اسم أو معرف العلامة
  • vocabulary_id (نص) – معرف أو اسم المفردات الخاصة بالعلامة. إذا لم يتم تحديده، سيتم افتراض أنها علامة حرة. (اختياري)
  • include_datasets (منطقي) – تضمين قائمة من مجموعات البيانات المرتبطة بالعلامة. (محدودة إلى 1000 - للحصول على مرونة أكبر، استخدم package_search() كمثال.) (اختياري، الافتراضي: False)
يُرجع:

تفاصيل العلامة، بما في ذلك قائمة بجميع مجموعات البيانات المرتبطة بالعلامة وتفاصيلها
نوع الإرجاع:

قاموس
ckan.logic.action.get.user_show(context, data_dict)

يعيد حساب المستخدم.

يجب توفير إما المعامل id أو المعامل user_obj.

المعلمات:
  • id (نص) – معرف أو اسم المستخدم (اختياري)
  • user_obj (قاموس مستخدم) – قاموس المستخدم (اختياري)
  • include_datasets (منطقي) – تضمين قائمة بمجموعات البيانات التي أنشأها المستخدم. إذا كان نفس المستخدم أو sysadmin هو من يقوم بالطلب، يتم تضمين مجموعات البيانات التي هي في وضع المسودة أو خاصة. (اختياري، الافتراضي: False, الحد الأقصى: 50)
  • include_num_followers (منطقي) – تضمين عدد المتابعين للمستخدم (اختياري، الافتراضي: False)
  • include_password_hash (منطقي) – تضمين تجزئة كلمة المرور المخزنة (مخصص فقط لـ sysadmins، اختياري، الافتراضي: False)
  • include_plugin_extras (منطقي) – تضمين الكائن الداخلي للإضافات الخاصة بالملحق (مخصص فقط لـ sysadmins، اختياري، الافتراضي: False)
يرجع:

تفاصيل المستخدم. يشمل email_hash و number_created_packages (يستثني مجموعات البيانات التي هي في المسودة أو خاصة ما لم يكن نفس المستخدم أو sysadmin هو من يقوم بالطلب). يستثني كلمة المرور (التجزئة) ورمز إعادة التعيين. إذا كان نفس المستخدم أو sysadmin هو من يقوم بالطلب، يتم تضمين البريد الإلكتروني ورمز API.
نوع الإرجاع:

قاموس
ckan.logic.action.get.package_autocomplete(context, data_dict)

يعيد قائمة بمجموعات البيانات (الحزم) التي تتطابق مع سلسلة معينة.

سيتم إرجاع مجموعات البيانات التي تحتوي أسماؤها أو عناوينها على السلسلة المدخلة.

المعلمات:
  • q (نص) – السلسلة التي يتم البحث عنها
  • limit (عدد صحيح) – الحد الأقصى لعدد أنواع الموارد التي سيتم إرجاعها (اختياري، الافتراضي: 10)
نوع الإرجاع:

قائمة من القواميس
ckan.logic.action.get.format_autocomplete(context, data_dict)

يرجع قائمة من تنسيقات الموارد التي تحتوي أسماؤها على سلسلة معينة.

المعلمات:
  • q (نص) – السلسلة التي سيتم البحث عنها
  • limit (عدد صحيح) – الحد الأقصى لعدد تنسيقات الموارد التي سيتم إرجاعها (اختياري، الافتراضي: 5)
نوع الإرجاع:

قائمة من السلاسل النصية
ckan.logic.action.get.user_autocomplete(context, data_dict)

يرجع قائمة بأسماء المستخدمين التي تحتوي على سلسلة معينة.

المعلمات:
  • q (نص) – السلسلة التي سيتم البحث عنها
  • limit (عدد صحيح) – الحد الأقصى لعدد أسماء المستخدمين التي سيتم إرجاعها (اختياري، الافتراضي: 20)
نوع الإرجاع:

قائمة من قواميس المستخدمين، كل منها يحتوي على المفاتيح 'name', 'fullname' و 'id'
ckan.logic.action.get.group_autocomplete(context, data_dict)

يرجع قائمة بأسماء المجموعات التي تحتوي على سلسلة معينة.

المعلمات:
  • q (نص) – السلسلة التي سيتم البحث عنها
  • limit (عدد صحيح) – الحد الأقصى لعدد المجموعات التي سيتم إرجاعها (اختياري، الافتراضي: 20)
نوع الإرجاع:

قائمة من قواميس المجموعات، كل منها يحتوي على المفاتيح 'name', 'title' و 'id'
ckan.logic.action.get.organization_autocomplete(context, data_dict)

يرجع قائمة بأسماء المنظمات التي تحتوي على سلسلة معينة.

المعلمات:
  • q (نص) – السلسلة التي سيتم البحث عنها
  • limit (عدد صحيح) – الحد الأقصى لعدد المنظمات التي سيتم إرجاعها (اختياري، الافتراضي: 20)
نوع الإرجاع:

قائمة من قواميس المنظمات، كل منها يحتوي على المفاتيح 'name', 'title' و 'id'

بحث عن مجموعات البيانات التي تلبي معايير البحث المحددة.

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

معلمات Solr:

للمعالجة المتعمقة لكل معلمة، يرجى الرجوع إلى وثائق Solr.

تقبل هذه العملية مجموعة فرعية من معلمات استعلام البحث الخاصة بـ Solr:

المعلمات:
  • q (سلسلة نصية) – استعلام Solr. اختياري. الافتراضي: "*:*"
  • fq (سلسلة نصية) – أي استعلام فلترة لتطبيقه. ملاحظة: +site_id:{ckan_site_id} يضاف إلى هذه السلسلة قبل تنفيذ الاستعلام.
  • fq_list (قائمة من السلاسل) – استعلامات فلترة إضافية لتطبيقها.
  • sort (سلسلة نصية) – ترتيب نتائج البحث. اختياري. الافتراضي: 'score desc, metadata_modified desc'. كما هو موضح في وثائق Solr، هذه سلسلة مفصولة بفواصل من أسماء الحقول وترتيبها.
  • rows (عدد صحيح) – العدد الأقصى للصفوف التي تطابق معايير البحث لإرجاعها. (اختياري، الافتراضي: 10, الحد الأقصى: 1000 ما لم يتم تحديده في إعدادات الموقع ckan.search.rows_max)
  • start (عدد صحيح) – الترحيل في النتيجة الكاملة لتحديد مكان بدء مجموعة البيانات المسترجعة.
  • facet (سلسلة نصية) – لتمكين نتائج الفئات. الافتراضي: True.
  • facet.mincount (عدد صحيح) – العدد الأدنى الذي يجب أن يكون عليه الحقل في الفئات ليتم تضمينه في النتائج.
  • facet.limit (عدد صحيح) – الحد الأقصى لعدد القيم التي ستقوم الفئات بإرجاعها. القيمة السلبية تعني غير محدودة. يمكن تكوين هذا على مستوى الموقع مع الخيار search.facets.limit. الافتراضي هو 50.
  • facet.field (قائمة من السلاسل) – الحقول التي سيتم تطبيق الفئة عليها. الافتراضي فارغ. إذا كان فارغاً، فإن معلومات الفئة المسترجعة ستكون أيضاً فارغة.
  • include_drafts (منطقي) – إذا كان True, فسيتم تضمين مجموعات البيانات المسودة في النتائج. سيرى المستخدم فقط مجموعات البيانات المسودة الخاصة به، بينما سيرى المسؤول النظامي جميع مجموعات البيانات المسودة. اختياري، القيمة الافتراضية هي False.
  • include_private (منطقي) – إذا كان True, فسيتم تضمين مجموعات البيانات الخاصة في النتائج. ستتم إعادة مجموعات البيانات الخاصة فقط من المنظمات الخاصة بالمستخدم، بينما سيرى المسؤول النظامي جميع مجموعات البيانات الخاصة. اختياري، القيمة الافتراضية هي False.
  • use_default_schema (منطقي) – استخدم المخطط الافتراضي للحزم بدلاً من المخطط المخصص المحدد باستخدام ملحق IDatasetForm (الافتراضي: False)

يتم دعم معلمات Solr المتقدمة التالية أيضاً. ملاحظة أن بعضها متاح فقط في إصدارات معينة من Solr. راجع وثائق DisMax Plugin ووثائق edismax للمزيد من التفاصيل:

qf, wt, bf, boost, tie, defType, mm

أمثلة:

q=flood مجموعات بيانات تحتوي على الكلمة flood، floods أو flooding fq=tags:economy مجموعات بيانات بها العلامة economy facet.field=["tags"] facet.limit=10 rows=0 أفضل 10 علامات

النتائج:

نتيجة هذه العملية هي قاموس يحتوي على المفاتيح التالية:

المفتاح:

النتائج (قائمة) – قائمة تحتوي على package_dict لأسماء الحزم التي تطابق معايير البحث.

التعداد (عدد صحيح) – عدد الحزم التي تم العثور عليها.

المجموعات (قائمة من القواميس) – تمثيل خاص لكل مجموعة بيانات في النتيجة.

ملاحظات:

  • يرجى ملاحظة أن العملية تقتصر على بحث الفئات في الحزم.

يرجع قائمة بالعلامات التي تحتوي أسماؤها على سلسلة معينة.

بشكل افتراضي، يتم البحث فقط في العلامات الحرة (تلك التي لا تنتمي إلى أي مفردات). إذا تم تقديم المعامل vocabulary_id، فسيتم البحث فقط في العلامات التي تنتمي إلى هذه المفردات.

المعلمات:
  • query (سلسلة نصية أو قائمة من السلاسل) – السلسلة أو السلاسل التي سيتم البحث عنها.
  • vocabulary_id (سلسلة نصية) – معرّف أو اسم المفردات الخاصة بالعلامات للبحث عنها (اختياري).
  • fields (قاموس) – عفا عليها الزمن.
  • limit (عدد صحيح) – الحد الأقصى لعدد العلامات التي سيتم إرجاعها.
  • offset (عدد صحيح) – عند إعطاء limit، يتم تحديد الانزياح الذي سيبدأ من خلاله إرجاع العلامات.
الإرجاع:

قاموس يحتوي على المفاتيح التالية:

'count'

عدد العلامات في النتيجة.

'results'

قائمة بالعلامات التي تحتوي أسماؤها على السلسلة المعطاة، على شكل قائمة من القواميس.
نوع الإرجاع:

قاموس
ckan.logic.action.get.tag_autocomplete(السياق, قاموس_البيانات)

يرجع قائمة بأسماء العلامات التي تحتوي على سلسلة معينة.

بشكل افتراضي، يتم البحث فقط في العلامات الحرة (تلك التي لا تنتمي إلى أي مفردات). إذا تم تقديم المعامل vocabulary_id، فسيتم البحث فقط في العلامات التي تنتمي إلى هذه المفردات.

المعلمات:
  • query (سلسلة نصية) – السلسلة التي سيتم البحث عنها.
  • vocabulary_id (سلسلة نصية) – معرّف أو اسم المفردات الخاصة بالعلامات للبحث عنها (اختياري).
  • fields (قاموس) – عفا عليها الزمن.
  • limit (عدد صحيح) – الحد الأقصى لعدد العلامات التي سيتم إرجاعها.
  • offset (عدد صحيح) – عند إعطاء limit، يتم تحديد الانزياح الذي سيبدأ من خلاله إرجاع العلامات.
نوع الإرجاع:

قائمة من السلاسل النصية
ckan.logic.action.get.task_status_show(السياق, قاموس_البيانات)

يرجع حالة المهمة.

يجب تقديم المعامل id أو المعاملات entity_id، task_type و key.

المعلمات:
  • id (سلسلة نصية) – معرّف حالة المهمة (اختياري).
  • entity_id (سلسلة نصية) – معرّف الكائن لحالة المهمة (اختياري).
  • task_type (سلسلة نصية) – نوع المهمة لحالة المهمة (اختياري).
  • key (سلسلة نصية) – المفتاح لحالة المهمة (اختياري).
نوع الإرجاع:

قاموس
ckan.logic.action.get.term_translation_show(السياق, قاموس_البيانات)

يرجع الترجمات للمصطلحات واللغات المعطاة.

المعلمات:
  • terms (قائمة من السلاسل النصية) – المصطلحات التي سيتم البحث عن ترجماتها، على سبيل المثال 'Russian'، 'romantic novel'.
  • lang_codes (قائمة من رموز اللغة) – الرموز اللغوية التي سيتم البحث عن الترجمات فيها، على سبيل المثال 'en'، 'de' (اختياري، بشكل افتراضي، يتم البحث في جميع اللغات).
نوع الإرجاع:

قائمة من القواميس الخاصة بترجمات المصطلحات، كل منها يحتوي على المفاتيح 'term' (المصطلح المطلوب، باللغة المصدر)، 'term_translation' (ترجمة المصطلح باللغة المستهدفة) و 'lang_code' (رمز اللغة للغة المستهدفة).
ckan.logic.action.get.get_site_user(السياق, قاموس_البيانات)

يرجع المستخدم لموقع CKAN.

في الوضع الافتراضي (أو إذا تم تحديده على false)، سيتحقق get_site_user من المعاملة الحالية ويقوم بتسويتها وتنظيفها. إذا تم تحديده على true، فإن الشخص الذي استدعى الوظيفة يكون مسؤولاً عن التحقق من المعاملة بعد استدعاء get_site_user. قد يؤدي ترك الاتصالات مفتوحة إلى تجميد أوامر CLI! (اختياري، افتراضي: False)

المعلمات: defer_commit (منطقي) – بشكل افتراضي (أو إذا تم تحديده على false)، يقوم get_site_user بالتحقق من المعاملة الحالية وتنظيفها. إذا تم تحديده على true، يكون المستدعي مسؤولاً عن التحقق من المعاملة بعد استدعاء get_site_user. ترك الاتصال مفتوحاً قد يؤدي إلى تجميد الأوامر! (اختياري، افتراضي: False)
ckan.logic.action.get.status_show(السياق, قاموس_البيانات)

يرجع قاموسًا يحتوي على معلومات حول تكوين الموقع.

نوع الإرجاع: قاموس
ckan.logic.action.get.vocabulary_list(السياق, قاموس_البيانات)

يرجع قائمة بجميع مفردات العلامات للموقع.

نوع الإرجاع: قائمة من القواميس
ckan.logic.action.get.vocabulary_show(السياق, قاموس_البيانات)

يرجع مفردة علامة واحدة.

المعلمات: id (سلسلة) – المعرف أو اسم المفردة
يرجع: المفردة.
نوع الإرجاع: قاموس
ckan.logic.action.get.user_activity_list(السياق, قاموس_البيانات)

يرجع تدفق الأنشطة العامة لمستخدم.

يجب أن تكون لديك الصلاحية لرؤية ملف المستخدم الشخصي.

المعلمات:
  • id (سلسلة) – المعرف أو اسم المستخدم
  • offset (عدد صحيح) – من أي نقطة يجب البدء في استرجاع الأنشطة (اختياري، الافتراضي: 0)
  • limit (عدد صحيح) – الحد الأقصى لعدد الأنشطة التي سيتم إرجاعها (اختياري، الافتراضي: 31، ما لم يتم تحديده في تكوين الموقع ckan.activity_list_limit، الحد الأعلى: 100، ما لم يتم تحديده في تكوين الموقع ckan.activity_list_limit_max)
نوع الإرجاع:

قائمة من القواميس
ckan.logic.action.get.package_activity_list(السياق, قاموس_البيانات)

يرجع تدفق الأنشطة لحزمة (دون التفاصيل)

يجب أن يكون لديك الصلاحية لرؤية الحزمة.

المعلمات:
  • id (سلسلة) – المعرف أو اسم الحزمة
  • offset (عدد صحيح) – من أي نقطة يجب البدء في استرجاع الأنشطة (اختياري، الافتراضي: 0)
  • limit (عدد صحيح) – الحد الأقصى لعدد الأنشطة التي سيتم إرجاعها (اختياري، الافتراضي: 31، ما لم يتم تحديده في تكوين الموقع ckan.activity_list_limit، الحد الأعلى: 100، ما لم يتم تحديده في تكوين الموقع ckan.activity_list_limit_max)
  • include_hidden_activity (منطقي) – إذا كان يجب تضمين الأنشطة "المخفية"، والتي لا تظهر في صفحة تدفق الأنشطة. تشمل الأنشطة المخفية إجراءات يقوم بها المستخدم الموقع، مثل الحصاد، والتي لا تظهر في تدفق الأنشطة لأنها قد تكون كثيرة جدًا، أو أنشطة من مستخدمين آخرين يتم تحديدها في إعدادات التكوين ckan.hide_activity_from_users. ملاحظة: فقط المسؤولون يمكنهم تعيين include_hidden_activity إلى صحيح. (افتراضي: خاطئ)
نوع الإرجاع:

قائمة من القواميس
ckan.logic.action.get.group_activity_list(السياق, قاموس_البيانات)

يرجع تدفق الأنشطة لمجموعة.

يجب أن يكون لديك الصلاحية لرؤية المجموعة.

المعلمات:
  • id (سلسلة) – المعرف أو اسم المجموعة
  • offset (عدد صحيح) – من أي نقطة يجب البدء في استرجاع الأنشطة (اختياري، الافتراضي: 0)
  • limit (عدد صحيح) – الحد الأقصى لعدد الأنشطة التي سيتم إرجاعها (اختياري، الافتراضي: 31، ما لم يتم تحديده في تكوين الموقع ckan.activity_list_limit، الحد الأعلى: 100، ما لم يتم تحديده في تكوين الموقع ckan.activity_list_limit_max)
  • include_hidden_activity (منطقي) – إذا كان يجب تضمين الأنشطة "المخفية"، والتي لا تظهر في صفحة تدفق الأنشطة. تشمل الأنشطة المخفية إجراءات يقوم بها المستخدم الموقع، مثل الحصاد، والتي لا تظهر في تدفق الأنشطة لأنها قد تكون كثيرة جدًا، أو أنشطة من مستخدمين آخرين يتم تحديدها في إعدادات التكوين ckan.hide_activity_from_users. ملاحظة: فقط المسؤولون يمكنهم تعيين include_hidden_activity إلى صحيح. (افتراضي: خاطئ)
نوع الإرجاع:

قائمة من القواميس
ckan.logic.action.get.organization_activity_list(السياق, قاموس_البيانات)

يرجع تدفق الأنشطة لمنظمة.

المعلمات:
  • id (سلسلة) – المعرف أو اسم المنظمة
  • offset (عدد صحيح) – من أي نقطة يجب البدء في استرجاع الأنشطة (اختياري، الافتراضي: 0)
  • limit (عدد صحيح) – الحد الأقصى لعدد الأنشطة التي سيتم إرجاعها (اختياري، الافتراضي: 31، ما لم يتم تحديده في تكوين الموقع ckan.activity_list_limit، الحد الأعلى: 100، ما لم يتم تحديده في تكوين الموقع ckan.activity_list_limit_max)
  • include_hidden_activity (منطقي) – إذا كان يجب تضمين الأنشطة "المخفية"، والتي لا تظهر في صفحة تدفق الأنشطة. تشمل الأنشطة المخفية إجراءات يقوم بها المستخدم الموقع، مثل الحصاد، والتي لا تظهر في تدفق الأنشطة لأنها قد تكون كثيرة جدًا، أو أنشطة من مستخدمين آخرين يتم تحديدها في إعدادات التكوين ckan.hide_activity_from_users. ملاحظة: فقط المسؤولون يمكنهم تعيين include_hidden_activity إلى صحيح. (افتراضي: خاطئ)
نوع الإرجاع:

قائمة من القواميس
ckan.logic.action.get.recently_changed_packages_activity_list(السياق, قاموس_البيانات)

يرجع تدفق الأنشطة لجميع الحزم التي تم إضافتها أو تعديلها مؤخرًا.

المعلمات:
  • offset (عدد صحيح) – من أي نقطة يجب البدء في استرجاع الأنشطة (اختياري، الافتراضي: 0)
  • limit (عدد صحيح) – الحد الأقصى لعدد الأنشطة التي سيتم إرجاعها (اختياري، الافتراضي: 31، ما لم يتم تحديده في تكوين الموقع ckan.activity_list_limit، الحد الأعلى: 100، ما لم يتم تحديده في تكوين الموقع ckan.activity_list_limit_max)
نوع الإرجاع:

قائمة من القواميس
ckan.logic.action.get.user_follower_count(السياق, قاموس_البيانات)

يرجع عدد المتابعين للمستخدم.

المعلمات: id (سلسلة) – المعرف أو اسم المستخدم
نوع الإرجاع: عدد صحيح
ckan.logic.action.get.dataset_follower_count(السياق, قاموس_البيانات)

يرجع عدد المتابعين لمجموعة البيانات.

المعلمات: id (سلسلة) – المعرف أو اسم مجموعة البيانات
نوع الإرجاع: عدد صحيح
ckan.logic.action.get.group_follower_count(السياق, قاموس_البيانات)

يرجع عدد المتابعين لمجموعة.

المعلمات: id (سلسلة) – المعرف أو اسم المجموعة
نوع الإرجاع: عدد صحيح
ckan.logic.action.get.organization_follower_count(السياق, قاموس_البيانات)

يرجع عدد المتابعين لمنظمة.

نسخ الكود
المعلمات: id (سلسلة) – المعرف أو اسم المنظمة
نوع الإرجاع: عدد صحيح
ckan.logic.action.get.user_follower_list(السياق, قاموس_البيانات)

يرجع قائمة المستخدمين الذين يتابعون المستخدم المعطى.

نسخ الكود
المعلمات: id (سلسلة) – المعرف أو اسم المستخدم
نوع الإرجاع: قائمة من القواميس
ckan.logic.action.get.dataset_follower_list(السياق, قاموس_البيانات)

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

نسخ الكود
المعلمات: id (سلسلة) – المعرف أو اسم مجموعة البيانات
نوع الإرجاع: قائمة من القواميس
ckan.logic.action.get.group_follower_list(السياق, قاموس_البيانات)

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

نسخ الكود
المعلمات: id (سلسلة) – المعرف أو اسم المجموعة
نوع الإرجاع: قائمة من القواميس
ckan.logic.action.get.organization_follower_list(السياق, قاموس_البيانات)

يرجع قائمة المستخدمين الذين يتابعون المنظمة المعطاة.

نسخ الكود
المعلمات: id (سلسلة) – المعرف أو اسم المنظمة
نوع الإرجاع: قائمة من القواميس
ckan.logic.action.get.am_following_user(السياق, قاموس_البيانات)

يرجع True إذا كنت تتابع المستخدم المعطى، False إذا لم تكن تتابعه.

نسخ الكود
المعلمات: id (سلسلة) – المعرف أو اسم المستخدم
نوع الإرجاع: منطقي
ckan.logic.action.get.am_following_dataset(السياق, قاموس_البيانات)

يرجع True إذا كنت تتابع مجموعة البيانات المعطاة، False إذا لم تكن تتابعها.

نسخ الكود
المعلمات: id (سلسلة) – المعرف أو اسم مجموعة البيانات
نوع الإرجاع: منطقي
ckan.logic.action.get.am_following_group(السياق, قاموس_البيانات)

يرجع True إذا كنت تتابع المجموعة المعطاة، False إذا لم تكن تتابعها.

نسخ الكود
المعلمات: id (سلسلة) – المعرف أو اسم المجموعة
نوع الإرجاع: منطقي
ckan.logic.action.get.followee_count(السياق, قاموس_البيانات)

يرجع عدد الكائنات التي يتابعها المستخدم المعطى.

نسخ الكود

يحسب جميع الكائنات من جميع الأنواع التي يتابعها المستخدم المعطى (على سبيل المثال، المستخدمون الذين يتبعهم، مجموعات البيانات التي يتابعها، المجموعات التي يتابعها).

المعلمات: id (سلسلة) – المعرف الخاص بالمستخدم
نوع الإرجاع: عدد صحيح
ckan.logic.action.get.user_followee_count(السياق, قاموس_البيانات)

يرجع عدد المستخدمين الذين يتبعهم المستخدم المعطى.

نسخ الكود
المعلمات: id (سلسلة) – المعرف الخاص بالمستخدم
نوع الإرجاع: عدد صحيح
ckan.logic.action.get.dataset_followee_count(السياق, قاموس_البيانات)

يرجع عدد مجموعات البيانات التي يتابعها المستخدم المعطى.

نسخ الكود
المعلمات: id (سلسلة) – المعرف الخاص بالمستخدم
نوع الإرجاع: عدد صحيح
ckan.logic.action.get.group_followee_count(السياق, قاموس_البيانات)

يرجع عدد المجموعات التي يتابعها المستخدم المعطى.

نسخ الكود
المعلمات: id (سلسلة) – المعرف الخاص بالمستخدم
نوع الإرجاع: عدد صحيح
ckan.logic.action.get.followee_list(السياق, قاموس_البيانات)

يرجع قائمة الكائنات التي يتابعها المستخدم المعطى.

نسخ الكود

يرجع جميع الكائنات من أي نوع يتابعها المستخدم المعطى (على سبيل المثال: المستخدمون الذين يتبعهم، مجموعات البيانات التي يتابعها، المجموعات التي يتابعها، إلخ).

المعلمات:
  • id (سلسلة) – المعرف الخاص بالمستخدم
  • q (سلسلة) – سلسلة استعلام لتحديد النتائج، فقط الكائنات التي يبدأ اسم العرض الخاص بها بالسلسلة المعطاة (غير حساس لحالة الأحرف) سيتم إرجاعها (اختياري)
نوع الإرجاع:

قائمة من القواميس، كل قاموس يحتوي على المفاتيح 'type' (على سبيل المثال، 'user'، 'dataset' أو 'group')، 'display_name' (على سبيل المثال، اسم العرض للمستخدم أو عنوان حزمة)، و 'dict' (على سبيل المثال، قاموس يمثل المستخدم، الحزمة أو المجموعة التي يتابعها، مماثل لما سيتم إرجاعه من قبل user_show(), package_show() أو group_show()).
ckan.logic.action.get.user_followee_list(السياق, قاموس_البيانات)

يرجع قائمة المستخدمين الذين يتابعهم المستخدم المعطى.

نسخ الكود
المعلمات: id (سلسلة) – المعرف الخاص بالمستخدم
نوع الإرجاع: قائمة من القواميس
ckan.logic.action.get.dataset_followee_list(السياق, قاموس_البيانات)

يرجع قائمة مجموعات البيانات التي يتابعها المستخدم المعطى.

نسخ الكود
المعلمات: id (سلسلة) – المعرف أو اسم المستخدم
نوع الإرجاع: قائمة من القواميس
ckan.logic.action.get.group_followee_list(السياق, القاموس_البيانات)

يعيد قائمة المجموعات التي يتابعها المستخدم المحدد.

نسخ الكود
المعلمات: id (سلسلة) – معرف المستخدم أو اسمه
نوع العودة: قائمة من القواميس
ckan.logic.action.get.organization_followee_list(السياق, القاموس_البيانات)

يعيد قائمة المنظمات التي يتابعها المستخدم المحدد.

المعلمات: id (سلسلة) – معرف المستخدم أو اسمه
نوع العودة: قائمة من القواميس
ckan.logic.action.get.dashboard_activity_list(السياق, القاموس_البيانات)
يعيد تدفق الأنشطة في لوحة التحكم للمستخدم المصرح به (عن طريق تسجيل الدخول أو مفتاح API)
التدفق.

على عكس القواميس التي تحتوي على الأنشطة التي تعود من إجراءات أخرى *_activity_list، تحتوي هذه القواميس على قيمة بوليانية إضافية باستخدام المفتاح is_new التي تشير ما إذا كانت الأنشطة قد حدثت منذ أن قام المستخدم بمراجعة لوحة التحكم الخاصة به ('is_new': True) أو لا ('is_new': False).

الأنشطة الخاصة بالمستخدم نفسه دائمًا ما تكون مُعلمة بـ 'is_new': False.

المعلمات:
  • offset (عدد صحيح) – من أي عنصر يجب البدء في جلب الأنشطة (اختياري، افتراضي: 0)
  • limit (عدد صحيح) – الحد الأقصى لعدد الأنشطة التي يجب إرجاعها (اختياري، افتراضي: 31, الحد الأعلى: 100 ما لم يتم تعيينه في إعدادات الموقع ckan.activity_list_limit)
نوع العودة:

قائمة من القواميس الخاصة بالأنشطة
ckan.logic.action.get.dashboard_new_activities_count(السياق, القاموس_البيانات)

يعيد عدد الأنشطة الجديدة في لوحة تحكم المستخدم.

يعيد عدد الأنشطة الجديدة في تدفق الأنشطة في لوحة تحكم المستخدم المصرح به.

الأنشطة الخاصة بالمستخدم نفسه لا يتم احتسابها بواسطة هذه الوظيفة حتى لو ظهرت في لوحة التحكم (المستخدمون لا يرغبون في أن يتم إعلامهم بالأشياء التي قاموا بها بأنفسهم).

نوع العودة: عدد صحيح
ckan.logic.action.get.activity_show(السياق, القاموس_البيانات)

يعرض تفاصيل عنصر نشاط (جزء من تدفق الأنشطة).

المعلمات:
  • id (سلسلة) – معرف النشاط
  • include_data (منطقي) – تضمين حقل البيانات، الذي يحتوي على قاموس كامل للكائن (وإلا، سيتم إرجاع حقل البيانات فقط مع عنوان الكائن)
نوع العودة:

قاموس
ckan.logic.action.get.activity_data_show(السياق, القاموس_البيانات)

يعرض بيانات عنصر "نشاط" (جزء من تدفق النشاط).

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

المعلمات:
  • id (سلسلة) – معرف النشاط
  • object_type (سلسلة) – "حزمة"، "مستخدم"، "مجموعة" أو "منظمة"
نوع العودة:

قاموس
ckan.logic.action.get.activity_diff(السياق, القاموس_البيانات)

يعيد الفرق في النشاط، مقارنة بالنسخة السابقة من الكائن.

المعلمات:
  • id (سلسلة) – معرف النشاط
  • object_type (سلسلة) – "حزمة"، "مستخدم"، "مجموعة" أو "منظمة"
  • diff_type (سلسلة) – "موحد"، "سياق"، "HTML"
ckan.logic.action.get.member_roles_list(السياق, القاموس_البيانات)

يعيد الأدوار الممكنة لأعضاء المجموعات والمنظمات.

المعلمات: group_type (سلسلة) – نوع المجموعة، إما "group" أو "organization" (اختياري، الافتراضي هو "organization")
الرجوع: قائمة من القواميس، كل منها يحتوي على مفتاحين: "text" (اسم الدور المعروض، مثل "Admin") و "value" (الاسم الداخلي للدور، مثل "admin")
نوع العودة: قائمة من القواميس
ckan.logic.action.get.help_show(السياق, القاموس_البيانات)

يعيد سلسلة المساعدة لإجراء معين من واجهة برمجة التطبيقات.

المعلمات: name (سلسلة) – اسم وظيفة الإجراء (مثل: user_create, package_search)
الرجوع: سلسلة المساعدة لوظيفة الإجراء، أو None إذا كانت الوظيفة لا تحتوي على docstring.
نوع العودة: سلسلة
يرمي: ckan.logic.NotFound : إذا لم تكن وظيفة الإجراء موجودة.
ckan.logic.action.get.config_option_show(السياق, القاموس_البيانات)

يعرض القيمة الحالية لخيار تكوين معين.

يعيد فقط خيارات التكوين القابلة للتعديل في وقت التشغيل (تلك التي تم إرجاعها بواسطة config_option_list()), والتي يمكن تحديثها باستخدام الإجراء config_option_update().

المعلمات: key (سلسلة) – مفتاح خيار التكوين
الرجوع: قيمة خيار التكوين التي تأتي إما من جدول system_info أو من ملف ini.
نوع العودة: سلسلة
يرمي: ckan.logic.ValidationError : إذا لم يكن خيار التكوين موجودًا في المخطط (غير مدرج كخيار قابل للتعديل).
ckan.logic.action.get.config_option_list(السياق, القاموس_البيانات)
يعيد قائمة مفاتيح خيارات التكوين القابلة للتعديل في وقت التشغيل والتي يمكن
تحديثها باستخدام config_option_update().
الرجوع: قائمة من مفاتيح خيارات التكوين.
نوع العودة: قائمة
ckan.logic.action.get.job_list(السياق, القاموس_البيانات)

يعرض قائمة الوظائف في الخلفية في قائمة الانتظار.

المعلمات: queues (قائمة) – قوائم الانتظار التي ترغب في عرض الوظائف لها. إذا لم يتم تحديدها، سيتم عرض جميع الوظائف من جميع قوائم الانتظار.
الرجوع: الوظائف الحالية في قائمة انتظار الخلفية.
نوع العودة: قائمة

ميزة جديدة في الإصدار 2.7.

ckan.logic.action.get.job_show(السياق, القاموس_البيانات)

يعرض تفاصيل الوظيفة في الخلفية.

المعلمات: id (سلسلة) – معرف الوظيفة في الخلفية.
الرجوع: تفاصيل الوظيفة في الخلفية.
نوع العودة: قاموس

ميزة جديدة في الإصدار 2.7.

ckan.logic.action.get.api_token_list(السياق, القاموس_البيانات)

يعيد قائمة بجميع رموز API المتاحة للمستخدم الحالي.

الرجوع: مجموعة من جميع رموز API
نوع العودة: قائمة

ميزة جديدة في الإصدار 2.9.

ckan.logic.action.create

وظائف API لإضافة البيانات إلى CKAN.

ckan.logic.action.create.package_create(السياق, قاموس_البيانات)

ينشئ مجموعة بيانات جديدة (حزمة).

يجب أن تكون لديك إذن لإنشاء مجموعات بيانات جديدة. إذا حددت مجموعات لمجموعة البيانات الجديدة، يجب أن يكون لديك أيضًا إذن لتعديل هذه المجموعات.

يمكن للإضافات تعديل معلمات هذه الوظيفة بناءً على قيمة المعامل type، راجع واجهة الإضافة IDatasetForm.

المعلمات:
  • name (سلسلة) – اسم مجموعة البيانات الجديدة، يجب أن يكون بين 2 و100 حرفًا ولا يحتوي إلا على حروف أبجدية رقمية صغيرة، - و _، مثل 'warandpeace'
  • title (سلسلة) – عنوان مجموعة البيانات (اختياري، افتراضيًا: نفس قيمة name)
  • private (منطقي) – إذا كانت True، ينشئ مجموعة بيانات خاصة
  • author (سلسلة) – اسم مؤلف مجموعة البيانات (اختياري)
  • author_email (سلسلة) – البريد الإلكتروني للمؤلف (اختياري)
  • maintainer (سلسلة) – اسم المسؤول عن مجموعة البيانات (اختياري)
  • maintainer_email (سلسلة) – البريد الإلكتروني للمسؤول (اختياري)
  • license_id (معرف الترخيص) – معرف الترخيص لمجموعة البيانات، راجع license_list() للقيم المتاحة (اختياري)
  • notes (سلسلة) – وصف لمجموعة البيانات (اختياري)
  • url (سلسلة) – رابط لمصدر مجموعة البيانات (اختياري)
  • version (سلسلة, لا تتجاوز 100 حرفًا) – (اختياري)
  • state (سلسلة) – الحالة الحالية لمجموعة البيانات، مثل 'active' أو 'deleted'، فقط مجموعات البيانات النشطة تظهر في نتائج البحث والقوائم الأخرى لمجموعات البيانات، سيتم تجاهل هذا المعامل إذا لم يكن لديك إذن لتغيير الحالة (اختياري، افتراضيًا: 'active')
  • type (سلسلة) – نوع مجموعة البيانات (اختياري)، الإضافات IDatasetForm تتصل بأنواع مختلفة من مجموعات البيانات وتوفر سلوكًا مخصصًا لتلك الأنواع
  • resources (قائمة من قواميس الموارد) – موارد مجموعة البيانات، راجع resource_create() من أجل تنسيق قواميس الموارد (اختياري)
  • tags (قائمة من قواميس العلامات) – علامات مجموعة البيانات، راجع tag_create() من أجل تنسيق قواميس العلامات (اختياري)
  • extras (قائمة من قواميس الإضافات) – إضافات مجموعة البيانات (اختياري)، الإضافات هي عناصر ميتاداتا عشوائية (مفتاح : قيمة) يمكن إضافتها إلى مجموعات البيانات
  • relationships_as_object (قائمة من قواميس العلاقات) – راجع package_relationship_create() من أجل تنسيق قواميس العلاقات (اختياري)
  • relationships_as_subject (قائمة من قواميس العلاقات) – راجع package_relationship_create() من أجل تنسيق قواميس العلاقات (اختياري)
  • groups (قائمة من القواميس) – المجموعات التي تنتمي إليها مجموعة البيانات (اختياري)، يجب أن يحتوي كل قاموس مجموعة على واحدة أو أكثر من المفاتيح التالية: 'id' (معرف المجموعة، سلسلة) أو 'name' (اسم المجموعة، سلسلة)، لرؤية المجموعات الموجودة، استخدم group_list()
  • owner_org (سلسلة) – معرف المنظمة المالكة لمجموعة البيانات، راجع organization_list() من أجل القيم المتاحة. قد يكون هذا المعامل اختياريًا إذا كانت إعدادات التكوين ckan.auth.create_unowned_dataset مضبوطة على True.
الإرجاع:

مجموعة البيانات التي تم إنشاؤها حديثًا (ما لم يتم تعيين 'return_id_only' إلى True في السياق، وفي هذه الحالة سيتم إرجاع معرف مجموعة البيانات فقط)
نوع الإرجاع:

قاموس
ckan.logic.action.create.resource_create(السياق, قاموس_البيانات)

يضيف موردًا جديدًا إلى قائمة الموارد لمجموعة بيانات.

المعلمات:
  • package_id (سلسلة) – معرف الحزمة التي يجب إضافة المورد إليها.
  • url (سلسلة) – عنوان URL للمورد
  • description (سلسلة) – (اختياري)
  • format (سلسلة) – (اختياري)
  • hash (سلسلة) – (اختياري)
  • name (سلسلة) – (اختياري)
  • resource_type (سلسلة) – (اختياري)
  • mimetype (سلسلة) – (اختياري)
  • mimetype_inner (سلسلة) – (اختياري)
  • cache_url (سلسلة) – (اختياري)
  • size (عدد صحيح) – (اختياري)
  • created (سلسلة تاريخ ISO) – (اختياري)
  • last_modified (سلسلة تاريخ ISO) – (اختياري)
  • cache_last_updated (سلسلة تاريخ ISO) – (اختياري)
  • upload (FieldStorage (اختياري) يتطلب multipart/form-data) – (اختياري)
الإرجاع:

المورد الجديد الذي تم إنشاؤه
نوع الإرجاع:

قاموس
ckan.logic.action.create.resource_view_create(السياق, قاموس_البيانات)

ينشئ عرضًا جديدًا للمورد.

المعلمات:
  • resource_id (سلسلة) – معرف المورد
  • title (سلسلة) – عنوان العرض
  • description (سلسلة) – وصف العرض (اختياري)
  • view_type (سلسلة) – نوع العرض
  • config (سلسلة JSON) – الخيارات اللازمة لإعادة إنشاء حالة العرض (اختياري)
الإرجاع:

عرض المورد الجديد الذي تم إنشاؤه
نوع الإرجاع:

قاموس
ckan.logic.action.create.resource_create_default_resource_views(السياق, قاموس_البيانات)

ينشئ العروض الافتراضية (إذا لزم الأمر) على المورد المقدم.

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

إذا لم يتم توفير الأخير، سيتم استدعاء الدالة package_show لاسترجاعه.

بشكل افتراضي، يتم استدعاء الإضافات الخاصة بالعروض التي لا تتطلب أن تكون بيانات المورد موجودة في DataStore فقط. راجع ckan.logic.action.create.package_create_default_resource_views.`() للحصول على مزيد من التفاصيل حول المعامل create_datastore_views.

المعلمات:
  • resource (dict) – القاموس الكامل للمورد
  • package (dict) – القاموس الكامل لمجموعة البيانات (اختياري، إذا لم يتم تقديمه، سيتم استدعاء package_show()).
  • create_datastore_views (bool) – إذا كانت العروض التي تعتمد على بيانات DataStore يجب أن تُنشأ (اختياري، الافتراضي False)
الإرجاع:

قائمة بالعروض التي تم إنشاؤها (فارغة إذا لم يتم إنشاء أي عرض)
نوع الإرجاع:

قائمة من القواميس
ckan.logic.action.create.package_create_default_resource_views(السياق, قاموس_البيانات)

ينشئ العروض الافتراضية على جميع الموارد في مجموعة البيانات المقدمة.

بشكل افتراضي، يتم استدعاء الإضافات الخاصة بالعروض التي لا تتطلب أن تكون بيانات المورد موجودة في DataStore فقط. إذا تم تمرير create_datastore_views إلى True، سيتم إنشاء العروض التي تتطلب أن تكون البيانات موجودة في DataStore فقط. تحدث الحالة الأولى عندما يتم استدعاء الدالة من package_create أو package_update، بينما تحدث الحالة الثانية عندما يتم استدعاء الدالة من DataPusher عندما يتم تحميل البيانات إلى DataStore.

المعلمات:
  • package (dict) – القاموس الكامل لمجموعة البيانات (أي الذي يتم الحصول عليه عند استدعاء package_show()).
  • create_datastore_views (bool) – إذا كانت العروض التي تعتمد على بيانات DataStore يجب أن تُنشأ (اختياري، الافتراضي False)
الإرجاع:

قائمة بالعروض التي تم إنشاؤها (فارغة إذا لم يتم إنشاء أي عرض)
نوع الإرجاع:

قائمة من القواميس
ckan.logic.action.create.package_relationship_create(السياق, قاموس_البيانات)

ينشئ علاقة بين مجموعتي بيانات (الحزم).

يجب أن تكون لديك صلاحية تعديل مجموعتي البيانات، الموضوع والمفعول به في العلاقة.

المعلمات:
  • subject (string) – معرّف أو اسم مجموعة البيانات التي هي الموضوع في العلاقة
  • object – معرّف أو اسم مجموعة البيانات التي هي المفعول به في العلاقة
  • type (string) – نوع العلاقة، أحد القيم التالية: 'depends_on', 'dependency_of', 'derives_from', 'has_derivation', 'links_to', 'linked_from', 'child_of' أو 'parent_of'
  • comment (string) – تعليق على العلاقة (اختياري)
الإرجاع:

العلاقة بين مجموعات البيانات التي تم إنشاؤها حديثًا
نوع الإرجاع:

قاموس
ckan.logic.action.create.member_create(السياق, قاموس_البيانات=None)

يضيف كائنًا (مثل مستخدم أو مجموعة بيانات أو مجموعة) كعضو في مجموعة.

إذا كان الكائن بالفعل عضوًا في المجموعة، فسيتم تحديث قدرة العضوية.

يجب أن تكون لديك صلاحية تعديل المجموعة.

المعلمات:
  • id (string) – معرّف أو اسم المجموعة التي سيتم إضافة الكائن إليها
  • object (string) – معرّف أو اسم الكائن الذي سيتم إضافته
  • object_type (string) – نوع الكائن الذي سيتم إضافته، مثل 'package' أو 'user'
  • capacity (string) – قدرة العضوية
الإرجاع:

العضوية التي تم إنشاؤها حديثًا (أو التي تم تحديثها)
نوع الإرجاع:

قاموس
ckan.logic.action.create.package_collaborator_create(context, data_dict)

جعل المستخدم متعاونًا في مجموعة البيانات.

إذا كان المستخدم بالفعل متعاونًا في مجموعة البيانات، سيتم تحديث صلاحياته.

حاليًا، يجب أن تكون مسؤولًا في المنظمة المالكة لمجموعة البيانات لإدارة المتعاونين.

ملاحظة: تتطلب هذه العملية أن تكون ميزة المتعاونين مفعلة باستخدام الخيار ckan.auth.allow_dataset_collaborators.

المعلمات:
  • id (string) – معرّف أو اسم مجموعة البيانات
  • user_id (string) – معرّف أو اسم المستخدم الذي سيتم إضافته أو تعديله
  • capacity (string) – القدرة أو الدور للمستخدم. يجب أن تكون واحدة من القيم التالية: « editor » (محرر) أو « member » (عضو). بالإضافة إلى ذلك، إذا تم تفعيل الخيار ckan.auth.allow_admin_collaborators، فإن « admin » مسموح أيضًا.
النتيجة:

المتعاون الذي تم إنشاؤه أو تحديثه حديثًا
نوع الإرجاع:

قاموس
ckan.logic.action.create.group_create(context, data_dict)

إنشاء مجموعة جديدة.

يجب أن يكون لديك إذن لإنشاء المجموعات.

يمكن للإضافات تعديل معلمات هذه الوظيفة بناءً على قيمة المعلمة type، راجع واجهة IGroupForm للإضافة.

المعلمات:
  • name (string) – اسم المجموعة، يجب أن يكون سلسلة من 2 إلى 100 حرفًا، تحتوي فقط على أحرف أبجدية رقمية صغيرة، - و_
  • id (string) – معرّف المجموعة (اختياري)
  • title (string) – عنوان المجموعة (اختياري)
  • description (string) – وصف المجموعة (اختياري)
  • image_url (string) – عنوان URL للصورة التي سيتم عرضها في صفحة المجموعة (اختياري)
  • type (string) – نوع المجموعة (اختياري، الافتراضي: 'group')، تقوم الإضافات بتخصيص سلوكيات لأنواع مختلفة من المجموعات. لا يمكن أن يكون « organization » (منظمة)
  • state (string) – الحالة الحالية للمجموعة، مثل 'active' أو 'deleted'، فقط المجموعات النشطة تظهر في نتائج البحث والقوائم الأخرى للمجموعات. سيتم تجاهل هذه المعلمة إذا لم يكن لديك إذن لتغيير حالة المجموعة (اختياري، الافتراضي: 'active')
  • approval_status (string) – (اختياري)
  • extras (list of dataset extra dictionaries) – إضافات المجموعة (اختياري)، الإضافات هي عناصر من البيانات الوصفية (مفتاح: قيمة) التي يمكن إضافتها إلى المجموعات. يجب أن تحتوي كل إضافة على المفاتيح 'key' (سلسلة)، 'value' (سلسلة)، ويمكن أن تحتوي على 'deleted'
  • packages (list of dictionaries) – مجموعات البيانات (الحزم) التي تنتمي إلى المجموعة، وهي قائمة من القواميس التي تحتوي كل منها على المفاتيح 'name' (سلسلة، معرّف أو اسم مجموعة البيانات) وربما 'title' (سلسلة، عنوان مجموعة البيانات)
  • groups (list of dictionaries) – المجموعات التي تنتمي إلى المجموعة، وهي قائمة من القواميس التي تحتوي كل منها على المفتاح 'name' (سلسلة، معرّف أو اسم المجموعة) وربما 'capacity' (سلسلة، القدرة التي يكون فيها المجموعة عضوًا في المجموعة)
  • users (list of dictionaries) – المستخدمين المنتمين إلى المجموعة، وهي قائمة من القواميس التي تحتوي كل منها على المفتاح 'name' (سلسلة، معرّف أو اسم المستخدم) وربما 'capacity' (سلسلة، القدرة التي يكون فيها المستخدم عضوًا في المجموعة)
النتيجة:

المجموعة التي تم إنشاؤها حديثًا (إلا إذا تم تعيين ‘return_id_only’ إلى True في السياق، في هذه الحالة سيتم إرجاع معرّف المجموعة فقط)
نوع الإرجاع:

قاموس
ckan.logic.action.create.organization_create(context, data_dict)

إنشاء منظمة جديدة.

يجب أن تكون لديك صلاحيات لإنشاء المنظمات.

يمكن للإضافات تعديل معلمات هذه الوظيفة بناءً على قيمة المعامل type، انظر واجهة الإضافة IGroupForm.

المعلمات:
  • name (سلسلة نصية) – اسم المنظمة، سلسلة من 2 إلى 100 حرفًا، تحتوي فقط على أحرف أبجدية رقمية صغيرة، - و _
  • id (سلسلة نصية) – معرف المنظمة (اختياري)
  • title (سلسلة نصية) – عنوان المنظمة (اختياري)
  • description (سلسلة نصية) – وصف المنظمة (اختياري)
  • image_url (سلسلة نصية) – عنوان URL لصورة لعرضها في صفحة المنظمة (اختياري)
  • state (سلسلة نصية) – الحالة الحالية للمنظمة، مثل 'active' أو 'deleted'، تظهر المنظمات النشطة فقط في نتائج البحث والقوائم الأخرى للمنظمات. سيتم تجاهل هذه المعلمة إذا لم تكن لديك صلاحية لتغيير حالة المنظمة (اختياري، الافتراضي: 'active')
  • approval_status (سلسلة نصية) – (اختياري)
  • extras (قائمة من قواميس إضافات البيانات) – الإضافات الخاصة بالمنظمة (اختياري)، وهي عناصر بيانات وصفية (مفتاح: قيمة) يمكن إضافتها للمنظمات. يجب أن يحتوي كل قاموس إضافي على المفاتيح 'key' (سلسلة نصية)، 'value' (سلسلة نصية)، وربما 'deleted'
  • packages (قائمة من القواميس) – مجموعات البيانات (الحزم) التابعة للمنظمة، قائمة من القواميس كل منها يحتوي على المفاتيح 'name' (سلسلة نصية، المعرف أو اسم مجموعة البيانات) وربما 'title' (سلسلة نصية، عنوان مجموعة البيانات)
  • users (قائمة من القواميس) – المستخدمون التابعون للمنظمة، قائمة من القواميس كل منها يحتوي على المفتاح 'name' (سلسلة نصية، المعرف أو اسم المستخدم) وربما 'capacity' (سلسلة نصية، السعة التي يكون فيها المستخدم عضوًا في المنظمة)
يرجع:

المنظمة التي تم إنشاؤها حديثًا (إلا إذا تم تعيين ‘return_id_only’ إلى True في السياق، وفي هذه الحالة سيتم إرجاع معرف المنظمة فقط)
نوع الإرجاع:

قاموس
ckan.logic.action.create.rating_create(context, data_dict)

تقييم مجموعة بيانات (حزمة).

يجب عليك توفير مفتاح API في رأس المصادقة.

المعلمات:
  • package (سلسلة نصية) – اسم أو معرف مجموعة البيانات لتقييمها
  • rating (عدد صحيح) – التقييم الذي سيتم منحه لمجموعة البيانات، عدد صحيح بين 1 و 5
يرجع:

قاموس يحتوي على مفتاحين: 'rating average' (متوسط التقييم لمجموعة البيانات التي قمت بتقييمها) و 'rating count' (عدد المرات التي تم فيها تقييم مجموعة البيانات)
نوع الإرجاع:

قاموس
ckan.logic.action.create.user_create(context, data_dict)

إنشاء مستخدم جديد.

يجب أن تكون لديك صلاحيات لإنشاء المستخدمين.

المعلمات:
  • name (سلسلة نصية) – اسم المستخدم الجديد، سلسلة من 2 إلى 100 حرفًا، تحتوي فقط على أحرف أبجدية رقمية صغيرة، - و _
  • email (سلسلة نصية) – عنوان البريد الإلكتروني للمستخدم
  • password (سلسلة نصية) – كلمة مرور المستخدم
  • fullname (سلسلة نصية) – الاسم الكامل للمستخدم (اختياري)
  • groups (قائمة من القواميس) – مجموعة من المستخدمين، قائمة من القواميس كل منها يحتوي على المفتاح name (سلسلة نصية، اسم المجموعة)
يرجع:

المستخدم الذي تم إنشاؤه حديثًا (إلا إذا تم تعيين return_id_only إلى True في السياق، وفي هذه الحالة سيتم إرجاع معرف المستخدم فقط)
نوع الإرجاع:

قاموس
ckan.logic.action.create.user_invite(contexte, dictionnaire_de_données)

دعوة مستخدم جديد.

يجب أن تكون لديك صلاحية لإنشاء أعضاء المجموعة.

المعلمات:
  • email (سلسلة نصية) – البريد الإلكتروني للمستخدم الذي سيتم دعوته إلى المجموعة
  • group_id (سلسلة نصية) – معرف أو اسم المجموعة
  • role (سلسلة نصية) – الدور الذي سيأخذه المستخدم في المجموعة. أحد الأدوار التالية: member، editor، أو admin
يرجع:

المستخدم الذي تم إنشاؤه حديثًا
نوع الإرجاع:

قاموس
ckan.logic.action.create.vocabulary_create(contexte, dictionnaire_de_données)

إنشاء مفردات جديدة للوسوم (Tags).

يجب أن تكون مشرفًا (sysadmin) لإنشاء المفردات.

المعلمات:
  • name (سلسلة نصية) – اسم المفردات الجديدة، مثل 'Genre'
  • tags (قائمة من القواميس الخاصة بالوسوم) – الوسوم الجديدة التي سيتم إضافتها إلى المفردات. لهيكل القواميس الخاصة بالوسوم، انظر tag_create()
يرجع:

المفردات التي تم إنشاؤها حديثًا
نوع الإرجاع:

قاموس
ckan.logic.action.create.activity_create(contexte, dictionnaire_d_activité, **kw)

إنشاء نشاط جديد في سجل الأنشطة.

يجب أن تكون مشرفًا (sysadmin) لإنشاء أنشطة جديدة.

المعلمات:
  • user_id (سلسلة نصية) – اسم أو معرف المستخدم الذي قام بالنشاط، مثل 'seanh'
  • object_id – اسم أو معرف الكائن المرتبط بالنشاط، مثل 'mon_jeu_de_données'
  • activity_type (سلسلة نصية) – نوع النشاط، يجب أن يكون نوع نشاط يمكن لـ CKAN عرضه، مثل 'nouveau package'، 'utilisateur_modifié'، 'groupe_supprimé'، إلخ.
  • data (قاموس) – بيانات إضافية تتعلق بالنشاط
يرجع:

النشاط الذي تم إنشاؤه حديثًا
نوع الإرجاع:

قاموس
ckan.logic.action.create.tag_create(contexte, dictionnaire_de_données)

إنشاء علامة جديدة ضمن مفردات الوسوم.

يجب أن تكون مشرفًا (sysadmin) لإنشاء علامات مفردات.

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

المعلمات:
  • name (سلسلة نصية) – اسم العلامة الجديدة، يجب أن يكون اسمًا مكونًا من 2 إلى 100 حرفًا يحتوي على أحرف وأرقام فقط بالإضافة إلى -، _ و .، مثل 'Jazz'
  • vocabulary_id (سلسلة نصية) – معرف المفردات التي يجب إضافة العلامة الجديدة إليها، مثل معرف المفردات 'Genre'
يرجع:

العلامة التي تم إنشاؤها حديثًا
نوع الإرجاع:

قاموس
ckan.logic.action.create.follow_user(contexte, dictionnaire_de_données)

بدء متابعة مستخدم آخر.

يجب عليك توفير مفتاح API في رأس التوثيق.

المعلمات: id (سلسلة نصية) – معرف أو اسم المستخدم الذي سيتم متابعته، مثل 'joeuser'
يرجع: تمثيل للعلاقة بينك وبين المستخدم الآخر في متابعة المستخدم
نوع الإرجاع: قاموس
ckan.logic.action.create.follow_dataset(contexte, dictionnaire_de_données)

بدء متابعة مجموعة بيانات.

يجب عليك توفير مفتاح API في رأس التوثيق.

المعلمات: id (سلسلة نصية) – معرف أو اسم مجموعة البيانات التي سيتم متابعتها، مثل 'warandpeace'
يرجع: تمثيل للعلاقة بينك وبين مجموعة البيانات في متابعة مجموعة البيانات
نوع الإرجاع: قاموس
ckan.logic.action.create.group_member_create(contexte, dictionnaire_de_données)

إضافة مستخدم كعضو في مجموعة.

يجب أن تكون لديك صلاحية تعديل المجموعة.

المعلمات:
  • id (سلسلة نصية) – معرف أو اسم المجموعة
  • username (سلسلة نصية) – اسم أو معرف المستخدم الذي سيتم إضافته كعضو في المجموعة
  • role (سلسلة نصية) – دور المستخدم في المجموعة. يمكن أن يكون أحد الأدوار التالية: member، editor، أو admin
يرجع:

العضو الذي تم إنشاؤه حديثًا (أو تحديثه)
نوع الإرجاع:

قاموس
ckan.logic.action.create. organization_member_create (contexte, dictionnaire_de_données)

جعل مستخدم عضواً في مؤسسة.

يجب أن تكون لديك صلاحية لتعديل المؤسسة.

المعلمات:
  • id (سلسلة نصية) – المعرف أو اسم المؤسسة
  • username (سلسلة نصية) – اسم المستخدم أو معرفه الذي سيتم إضافته كعضو في المؤسسة
  • role (سلسلة نصية) – دور المستخدم في المؤسسة. أحد الأدوار التالية: member، editor، أو admin.
يرجع:

العضو الذي تم إنشاؤه حديثاً (أو تحديثه)
نوع الإرجاع:

قاموس
ckan.logic.action.create. follow_group (contexte, dictionnaire_de_données)

بدء متابعة مجموعة.

يجب عليك توفير مفتاح API في رأس التوثيق.

المعلمات: id (سلسلة نصية) – معرف أو اسم المجموعة التي سيتم متابعتها، على سبيل المثال 'roger'.
يرجع: تمثيل العلاقة "متابعة" بينك وبين المجموعة.
نوع الإرجاع: قاموس
ckan.logic.action.create. api_token_create (contexte, dictionnaire_de_données)

إنشاء رمز API جديد للمستخدم الحالي.

بالإضافة إلى الحقول user وname المطلوبة في التنفيذ الافتراضي، يمكن أن تكون هناك حقول إضافية مسجلة من قبل الإضافات.

المعلمات:
  • user (سلسلة نصية) – اسم المستخدم أو معرفه الذي يملك رمز API الجديد.
  • name (سلسلة نصية) – اسم مميز لرمز API.
يرجع:

يُرجع قاموساً يحتوي على المفتاح "token" بقيمة الرمز المشفر. الإضافات يمكنها توفير حقول إضافية عبر الطريقة add_extra من IApiToken .
نوع الإرجاع:

قاموس

ckan.logic.action.update

وظائف API لتحديث البيانات الحالية في CKAN.

ckan.logic.action.update. resource_update (context, data_dict)

تحديث مورد.

لتحديث مورد، يجب أن يكون لديك إذن بتحديث مجموعة البيانات التي ينتمي إليها المورد.

ملاحظة

قد تقوم طرق التحديث بإزالة المعلمات التي لم تُذكر صراحة في data_dict. إذا كنت ترغب فقط في تعديل سمة معينة، استخدم resource_patch بدلاً من ذلك.

للمزيد من المعلمات، انظر resource_create() .

المعلمات: id (سلسلة نصية) – معرف المورد الذي سيتم تحديثه.
يرجع: المورد الذي تم تحديثه.
نوع الإرجاع: سلسلة نصية.
ckan.logic.action.update. resource_view_update (context, data_dict)

تحديث عرض المورد.

لتحديث عرض المورد، يجب أن يكون لديك إذن لتحديث المورد الذي ينتمي إليه العرض.

للحصول على معلمات إضافية، انظر resource_view_create().

المعلمات: id (سلسلة نصية) – معرف عرض المورد المراد تحديثه.
يرجع: عرض المورد المحدث.
نوع الإرجاع: سلسلة نصية.
ckan.logic.action.update. resource_view_reorder (context, data_dict)

إعادة ترتيب عروض الموارد.

المعلمات:
  • id (سلسلة نصية) – معرف المورد.
  • order (قائمة من السلاسل النصية) – قائمة بمعرفات عروض المورد لإعادة ترتيبها.
يرجع:

الترتيب المحدث للعروض.
نوع الإرجاع:

قاموس.
ckan.logic.action.update. package_update (context, data_dict)

تحديث مجموعة بيانات (package).

يجب أن يكون لديك إذن لتعديل مجموعة البيانات والمجموعات التي تنتمي إليها.

ملاحظة

يمكن لطرق التحديث إزالة المعلمات التي لم يتم توفيرها صراحةً في قاموس البيانات. إذا كنت ترغب فقط في تعديل خاصية محددة، فاستخدم package_patch بدلاً من ذلك.

يوصى باستدعاء ckan.logic.action.get.package_show() ، ثم تعديل العناصر المطلوبة في النتيجة، ثم استدعاء package_update() باستخدام هذه النتيجة.

يمكن للإضافات تعديل معلمات هذه الوظيفة بناءً على قيمة الخاصية type الخاصة بمجموعة البيانات. انظر واجهة الإضافات IDatasetForm .

للحصول على معلمات إضافية، انظر package_create() .

المعلمات: id (سلسلة نصية) – الاسم أو المعرف لمجموعة البيانات التي يجب تحديثها.
القيمة المُعادة: مجموعة البيانات المُحدثة (إذا كانت 'return_id_only' تساوي False في السياق، وهو الوضع الافتراضي. خلاف ذلك، يتم إرجاع المعرف فقط).
نوع الإرجاع: قاموس.
ckan.logic.action.update. package_revise (context, data_dict)

تعديل مجموعة بيانات (package) بشكل انتقائي باستخدام معايير match وfilter وupdate.

يجب أن يكون لديك إذن لتعديل مجموعة البيانات والمجموعات التي تنتمي إليها.

المعلمات:
  • match (قاموس) – قاموس يحتوي على قيم "id" أو "name" الخاصة بمجموعة البيانات المراد تعديلها. يجب أن تتطابق جميع القيم المُقدمة مع القيم الحالية لمجموعة البيانات وإلا سيتم رفع خطأ في التحقق. مثال: {"name": "my-data", "resources": [{"name": "big.csv"}]} سيؤدي إلى خطأ إذا لم يكن اسم المورد الأول في مجموعة البيانات "my-data" هو "big.csv".
  • filter (سلسلة أنماط مفصولة بفواصل أو قائمة أنماط كـسلاسل نصية) – قائمة بالأنماط التي تمثل الحقول المطلوب إزالتها من مجموعة البيانات الحالية. مثال: "-resources__1" سيزيل المورد الثاني، و "+title, +resources, -*" سيزيل جميع الحقول على مستوى المجموعة باستثناء العنوان والموارد (القيمة الافتراضية: []).
  • update (قاموس) – قاموس يحتوي على القيم المطلوب تحديثها/إنشاؤها بعد التصفية. مثال: {"resources": [{"description": "file here"}]} سيُحدث الوصف للمورد الأول.
  • include (سلسلة أنماط مفصولة بفواصل أو قائمة أنماط كـسلاسل نصية) – قائمة بأنماط الحقول المطلوب تضمينها في النتيجة. مثال: "-*" لعدم إعادة أي شيء (القيمة الافتراضية: [] تعيد جميع الحقول).

يمكن تمرير match وupdate كـ "مفاتيح مسطحة"، باستخدام إما الفهرس الرقمي أو معرف العنصر الفريد (على الأقل 5 أحرف). على سبيل المثال: update__resource__1f9ab__description="guidebook" يعيّن وصف المورد الذي يبدأ معرفه بـ"1f9ab" إلى "guidebook"، و update__resource__-1__description="guidebook" يفعل الشيء نفسه لأخر مورد في المجموعة.

يمكن استخدام اللاحقة extend في معلمة التحديث لإضافة عنصر جديد إلى قائمة. مثال: update__resources__extend=[{"name": "new resource", "url": "https://example.com"}] ستضيف مورداً جديداً بمجموعة البيانات مع name وurl.

ckan.logic.action.update. package_resource_reorder (context, data_dict)

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

المعلمات:
  • id (سلسلة نصية) – معرف أو اسم مجموعة البيانات التي سيتم تحديثها.
  • order (قائمة) – قائمة بمعرفات الموارد بالترتيب المطلوب.
ckan.logic.action.update.package_relationship_update(context, data_dict)

يُحدث علاقة بين مجموعتين من البيانات (الحزم).

يُطلب تحديد المعايير "الموضوع"، "الكائن"، و"النوع" لتعريف العلاقة. فقط التعليق يمكن تحديثه.

يجب أن تكون مخولًا لتعديل كل من مجموعة البيانات الخاصة بالموضوع ومجموعة البيانات الخاصة بالكائن.

المعلمات:
  • subject (نص) – اسم أو معرف مجموعة البيانات التي تكون موضوع العلاقة
  • object (نص) – اسم أو معرف مجموعة البيانات التي تكون كائن العلاقة
  • type (نص) – نوع العلاقة، أحد الخيارات التالية: 'depends_on', 'dependency_of', 'derives_from', 'has_derivation', 'links_to', 'linked_from', 'child_of' أو 'parent_of'
  • comment (نص) – تعليق حول العلاقة (اختياري)
الناتج:

العلاقة المحدثة
نوع الناتج:

قاموس
ckan.logic.action.update.group_update(context, data_dict)

يُحدث مجموعة.

يجب أن تكون مخولًا لتعديل المجموعة.

ملاحظة

طرق التحديث قد تحذف المعايير التي لم يتم تقديمها بشكل صريح في data_dict. إذا كنت ترغب فقط في تعديل سمة محددة، فاستخدم group_patch بدلاً من ذلك.

يمكن أن تعدل الإضافات معايير هذه الوظيفة استنادًا إلى قيمة السمة type الخاصة بالمجموعة، راجع واجهة الإضافة IGroupForm.

لمزيد من المعايير، راجع group_create().

المعلمات: id (نص) – اسم أو معرف المجموعة التي سيتم تحديثها
الناتج: المجموعة المحدثة
نوع الناتج: قاموس
ckan.logic.action.update.organization_update(context, data_dict)

يُحدث منظمة.

يجب أن تكون مخولًا لتعديل المنظمة.

ملاحظة

طرق التحديث قد تحذف المعايير التي لم يتم تقديمها بشكل صريح في data_dict. إذا كنت ترغب فقط في تعديل سمة محددة، فاستخدم organization_patch بدلاً من ذلك.

لمزيد من المعايير، راجع organization_create().

المعلمات:
  • id (نص) – اسم أو معرف المنظمة التي سيتم تحديثها
  • packages – يتم تجاهله. استخدم package_owner_org_update() لتعديل ملكية الحزم
الناتج:

المنظمة المحدثة
نوع الناتج:

قاموس
ckan.logic.action.update.user_update(context, data_dict)

يُحدث حساب مستخدم.

يمكن للمستخدمين العاديين تحديث حساباتهم الخاصة فقط. يمكن لمسؤولي النظام تحديث أي حساب مستخدم. لا يمكن تعديل اسم المستخدم الحالي.

ملاحظة

طرق التحديث قد تحذف المعايير التي لم يتم تقديمها بشكل صريح في data_dict. إذا كنت ترغب فقط في تعديل سمة محددة، فاستخدم user_patch بدلاً من ذلك.

لمزيد من المعايير، راجع user_create().

المعلمات: id (نص) – اسم أو معرف المستخدم الذي سيتم تحديثه
الناتج: الحساب المستخدم المحدث
نوع الناتج: قاموس
ckan.logic.action.update.user_generate_apikey(context, data_dict)

ينشئ مفتاح API جديدًا للمستخدم

المعلمات: id (نص) – اسم أو معرف المستخدم الذي يجب تحديث مفتاحه
الناتج: المستخدم المحدث
نوع الناتج: قاموس
ckan.logic.action.update.task_status_update(context, data_dict)

يُحدث حالة مهمة.

المعلمات:
  • id (نص) – معرف حالة المهمة المراد تحديثها
  • entity_id (نص) –
  • entity_type (نص) –
  • task_type (نص) –
  • key (نص) –
  • value – (اختياري)
  • state – (اختياري)
  • last_updated – (اختياري)
  • error – (اختياري)
الناتج:

حالة المهمة المحدثة
نوع الناتج:

قاموس
ckan.logic.action.update.task_status_update_many(context, data_dict)

يُحدث حالات مهام متعددة دفعة واحدة.

المعلمات: data (قائمة من القواميس) – قواميس حالات المهام التي يجب تحديثها. للحصول على تنسيق قواميس حالات المهام، راجع task_status_update()
الناتج: حالات المهام المحدثة
نوع الناتج: قائمة من القواميس
ckan.logic.action.update.term_translation_update(context, data_dict)

إنشاء أو تحديث ترجمة مصطلح.

يجب أن تكون مسؤول نظام لإنشاء أو تحديث ترجمات المصطلحات.

المعلمات:
  • term (نص) – المصطلح المراد ترجمته، باللغة الأصلية، على سبيل المثال 'romantic novel'
  • term_translation (نص) – ترجمة المصطلح، على سبيل المثال 'Liebesroman'
  • lang_code (نص) – رمز اللغة للترجمة، على سبيل المثال 'de'
الناتج:

ترجمة المصطلح التي تم إنشاؤها أو تحديثها حديثًا
نوع الناتج:

قاموس
ckan.logic.action.update.term_translation_update_many(context, data_dict)

إنشاء أو تحديث العديد من ترجمات المصطلحات دفعة واحدة.

المعلمات: data (قائمة من القواميس) – القواميس الخاصة بترجمات المصطلحات التي يجب إنشاؤها أو تحديثها. للحصول على تنسيق قواميس ترجمة المصطلحات، راجع term_translation_update()
الناتج: قاموس يحتوي على المفتاح 'success' الذي تكون قيمته سلسلة نصية تشير إلى عدد الترجمات التي تم تحديثها
نوع الناتج: سلسلة نصية
ckan.logic.action.update.vocabulary_update(context, data_dict)

تحديث قاموس الكلمات المفتاحية.

يجب أن تكون مسؤول النظام لتتمكن من تحديث القواميس.

لمزيد من المعلمات، راجع vocabulary_create().

المعلمات: id (نص) – معرّف القاموس الذي سيتم تحديثه
الناتج: القاموس الذي تم تحديثه
نوع الناتج: قاموس
ckan.logic.action.update.dashboard_mark_activities_old(context, data_dict)

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

سيؤدي ذلك إلى إعادة تعيين dashboard_new_activities_count() إلى 0.

ckan.logic.action.update.send_email_notifications(context, data_dict)

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

يجب عليك توفير مفتاح API الخاص بالمسؤول في رأس التفويض للطلب، أو يمكنك استدعاء هذا الإجراء من خلال سطر الأوامر عبر أمر paster post ….

ckan.logic.action.update.package_owner_org_update(context, data_dict)

تحديث المنظمة المالكة لمجموعة بيانات.

المعلمات:
  • id (نص) – اسم أو معرّف مجموعة البيانات التي يجب تحديثها
  • organization_id (نص) – اسم أو معرّف المنظمة المالكة
ckan.logic.action.update.bulk_update_private(context, data_dict)

جعل مجموعة من مجموعات البيانات خاصة.

المعلمات:
  • datasets (قائمة من النصوص) – قائمة معرّفات مجموعات البيانات التي يجب تحديثها
  • org_id (عدد صحيح) – معرّف المنظمة المالكة
ckan.logic.action.update.bulk_update_public(context, data_dict)

جعل مجموعة من مجموعات البيانات عامة.

المعلمات:
  • datasets (قائمة نصوص) – قائمة معرّفات مجموعات البيانات التي يجب تحديثها
  • org_id (عدد صحيح) – معرّف المنظمة المالكة
ckan.logic.action.update.bulk_update_delete(context, data_dict)

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

المعلمات:
  • datasets (قائمة نصوص) – قائمة معرّفات مجموعات البيانات التي يجب حذفها
  • org_id (عدد صحيح) – معرّف المنظمة المالكة
ckan.logic.action.update.mise_à_jour_option_de_configuration(contexte, dictionnaire_de_données)

جديد في الإصدار 2.4.

يسمح بتعديل بعض خيارات التكوين القابلة للتعديل أثناء التشغيل في CKAN.

يأخذ الأزواج من المفاتيح والقيم العشوائية ويتحقق من المفاتيح بالنسبة إلى مخطط تحديث خيارات التكوين. إذا كانت بعض المفاتيح المقدمة غير موجودة في المخطط، سيتم رفع ValidationError. بعد ذلك، يتم التحقق من القيم ضد المخطط، وإذا نجح التحقق، لكل مفتاح، قيمة خيار التكوين:

  • يتم تخزينها في جدول قاعدة البيانات system_info.
  • يتم تحديث كائن Pylons config.
  • يتم تحديث كائن app_globals (g) (يحدث ذلك فقط بالنسبة للخيارات التي تم تحديدها بشكل صريح في وحدة app_globals).

فيما يلي مثال على معلمة key، ولكن يجب استبدالها بخيارات التكوين التي ترغب في تحديثها، على سبيل المثال:

get_action('config_option_update',{}, {  
	'ckan.site_title': 'موقع البيانات المفتوحة الخاص بي',  
	'ckan.homepage_layout': 2,  
})
المعلمات: key (نص) – مفتاح خيار التكوين (مثل ckan.site_title). يجب أن يكون موجودًا في update_configuration_schema
الرجوع: قاموس يحتوي على الخيارات المحددة
نوع العودة: قاموس

ملاحظة

يمكنك رؤية جميع خيارات التكوين القابلة للتعديل أثناء التشغيل عبر استدعاء الإجراء config_option_list().

ملاحظة

يمكن للإضافات تعديل خيارات التكوين القابلة للتعديل أثناء التشغيل. لمزيد من التفاصيل، راجع جعل خيارات التكوين قابلة للتعديل أثناء التشغيل.

تحذير

يجب عليك إضافة فقط خيارات التكوين التي تكون مرتاحًا لتعديلها أثناء التشغيل، مثل تلك التي أضفتها في إضافتك الخاصة أو التي راجعتها في قلب CKAN.

ckan.logic.action.patch

جديد في الإصدار 2.3.

وظائف API للتحديثات الجزئية للبيانات الموجودة في CKAN

ckan.logic.action.patch.package_patch(context, data_dict)

تحديث جزئي لمجموعة بيانات (حزمة).

المعلمات: id (سلسلة) – المعرف أو اسم مجموعة البيانات

الفرق بين طرق التحديث وطرق التصحيح هو أن التصحيح سيقوم بتحديث المعلمات المقدمة مع ترك باقي المعلمات دون تغيير، بينما ستقوم طريقة التحديث بحذف جميع المعلمات التي لم تُقدم بشكل صريح في data_dict.

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

يجب أن يكون لديك إذن لتعديل مجموعة البيانات والمجموعات التي تنتمي إليها.

ckan.logic.action.patch.resource_patch(context, data_dict)

تحديث المورد

المعلمات: id (سلسلة) – معرف المورد

الفرق بين طرق التحديث وطرق التصحيح هو أن التصحيح سيقوم بتحديث المعلمات المقدمة مع ترك باقي المعلمات دون تغيير، بينما ستقوم طريقة التحديث بحذف جميع المعلمات التي لم تُقدم بشكل صريح في data_dict.

ckan.logic.action.patch.group_patch(context, data_dict)

تحديث مجموعة

المعلمات: id (سلسلة) – المعرف أو اسم المجموعة

الفرق بين طرق التحديث وطرق التصحيح هو أن التصحيح سيقوم بتحديث المعلمات المقدمة مع ترك باقي المعلمات دون تغيير، بينما ستقوم طريقة التحديث بحذف جميع المعلمات التي لم تُقدم بشكل صريح في data_dict.

ckan.logic.action.patch.organization_patch(context, data_dict)

تحديث منظمة

المعلمات: id (سلسلة) – المعرف أو اسم المنظمة

الفرق بين طرق التحديث وطرق التصحيح هو أن التصحيح سيقوم بتحديث المعلمات المقدمة مع ترك باقي المعلمات دون تغيير، بينما ستقوم طريقة التحديث بحذف جميع المعلمات التي لم تُقدم بشكل صريح في data_dict.

ckan.logic.action.patch.user_patch(context, data_dict)

تحديث مستخدم:
:param id: المعرف أو اسم المستخدم
:type id: سلسلة
الفرق بين طرق التحديث وطرق التصحيح هو أن التصحيح سيقوم بتحديث المعلمات المقدمة مع ترك باقي المعلمات دون تغيير، بينما ستقوم طريقة التحديث بحذف جميع المعلمات التي لم تُقدم بشكل صريح في data_dict.

ckan.logic.action.delete

وظائف واجهة برمجة التطبيقات لحذف البيانات في CKAN.

ckan.logic.action.delete.user_delete(context, data_dict)

حذف مستخدم.

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

المعلمات: id (سلسلة) – المعرف أو اسم المستخدم للمستخدم الذي سيتم حذفه
ckan.logic.action.delete.package_delete(context, data_dict)

حذف مجموعة بيانات (حزمة).

هذا سيؤدي إلى اختفاء مجموعة البيانات من جميع العروض على الويب وواجهة برمجة التطبيقات، باستثناء سلة المهملات.

يجب أن تكون لديك صلاحية لحذف مجموعة البيانات.

المعلمات: id (سلسلة) – المعرف أو اسم مجموعة البيانات التي سيتم حذفها
ckan.logic.action.delete.dataset_purge(context, data_dict)

محو مجموعة بيانات.

تحذير

لا يمكن التراجع عن محو مجموعة البيانات!

المحو من قاعدة البيانات يزيل مجموعة البيانات تمامًا من قاعدة بيانات CKAN، بينما الحذف ببساطة يضع علامة على مجموعة البيانات على أنها محذوفة (لن تظهر في الواجهة الأمامية، ولكنها تظل في قاعدة البيانات).

يجب أن تكون لديك صلاحية لمحو مجموعة البيانات.

المعلمات: id (سلسلة) – اسم أو معرف مجموعة البيانات التي سيتم محوها
ckan.logic.action.delete.resource_delete(context, data_dict)

حذف مورد من مجموعة بيانات.

يجب أن تكون مسؤولًا على النظام أو مالكًا للمورد لكي تتمكن من حذفه.

المعلمات: id (سلسلة) – المعرف الخاص بالمورد
ckan.logic.action.delete.resource_view_delete(context, data_dict)

حذف عرض مورد (resource_view).

المعلمات: id (سلسلة) – المعرف الخاص بعرض المورد (resource_view)
ckan.logic.action.delete.resource_view_clear(context, data_dict)

حذف جميع عروض الموارد، أو تلك التي من نوع معين.

المعلمات: view_types (قائمة) – أنواع محددة للحذف (اختياري)
ckan.logic.action.delete.package_relationship_delete(context, data_dict)

حذف علاقة بين مجموعات بيانات (حزم).

يجب أن تكون لديك صلاحية لحذف العلاقات بين مجموعات البيانات، وكذلك تعديل مجموعات البيانات التي تمثل الموضوع والكائن.

المعلمات:
  • subject (سلسلة) – المعرف أو اسم مجموعة البيانات التي هي موضوع العلاقة
  • object (سلسلة) – المعرف أو اسم مجموعة البيانات التي هي كائن العلاقة
  • type (سلسلة) – نوع العلاقة
ckan.logic.action.delete.member_delete(context, data_dict=None)

حذف كائن (مثل مستخدم، مجموعة بيانات أو مجموعة) من مجموعة.

يجب أن يكون لديك صلاحية لتعديل المجموعة لكي تتمكن من حذف الكائنات منها.

المعلمات:
  • id (سلسلة) – المعرف الخاص بالمجموعة
  • object (سلسلة) – المعرف أو اسم الكائن المراد حذفه
  • object_type (سلسلة) – نوع الكائن المراد حذفه، مثل package أو user
ckan.logic.action.delete.package_collaborator_delete(context, data_dict)

إزالة متعاون من مجموعة بيانات.

حاليًا، يجب أن تكون مسؤولًا في المنظمة المالكة لمجموعة البيانات لكي تتمكن من إدارة المتعاونين.

ملاحظة: يتطلب هذا الإجراء أن تكون ميزة التعاون مفعلة مع خيار التكوين ckan.auth.allow_dataset_collaborators.

المعلمات:
  • id (سلسلة) – المعرف أو اسم مجموعة البيانات
  • user_id (سلسلة) – المعرف أو اسم المستخدم الذي سيتم إزالته
ckan.logic.action.delete.group_delete(context, data_dict)

حذف مجموعة.

يجب أن يكون لديك صلاحية لحذف المجموعة.

المعلمات: id (سلسلة) – اسم أو معرف المجموعة
ckan.logic.action.delete.organization_delete(context, data_dict)

حذف منظمة.

يجب أن يكون لديك صلاحية لحذف المنظمة وألا تكون هناك أي قواعد بيانات تابعة لها، ما لم يكن خيار « ckan.auth.create_unowned_dataset=True » مفعلًا.

المعلمات: id (سلسلة) – اسم أو معرف المنظمة
ckan.logic.action.delete.group_purge(context, data_dict)

تنظيف مجموعة.

تحذير

تنظيف مجموعة لا يمكن التراجع عنه!

تنظيف مجموعة يعني إزالة المجموعة بشكل كامل من قاعدة بيانات CKAN، بينما حذف المجموعة يعني فقط وسمها على أنها محذوفة (لن تظهر في واجهة المستخدم ولكنها تظل موجودة في قاعدة البيانات).

ستظل مجموعات البيانات في المنظمة متاحة، ولكنها لن تكون جزءًا من المجموعة التي تم تنظيفها.

يجب أن يكون لديك صلاحية لتنظيف المجموعة.

المعلمات: id (سلسلة) – اسم أو معرف المجموعة التي سيتم تنظيفها
ckan.logic.action.delete.organization_purge(context, data_dict)

تنظيف منظمة.

تحذير

تنظيف منظمة لا يمكن التراجع عنه!

تنظيف منظمة يعني إزالة المنظمة بشكل كامل من قاعدة بيانات CKAN، بينما حذف منظمة يعني فقط وسمها على أنها محذوفة (لن تظهر في واجهة المستخدم ولكنها تظل موجودة في قاعدة البيانات).

ستظل مجموعات البيانات التابعة للمنظمة متاحة، ولكنها لن تكون جزءًا من المنظمة بعد تنظيفها.

يجب أن يكون لديك صلاحية لتنظيف المنظمة.

المعلمات: id (سلسلة) – اسم أو معرف المنظمة التي سيتم تنظيفها
ckan.logic.action.delete.task_status_delete(context, data_dict)

حذف حالة مهمة.

يجب أن تكون مدير نظام لحذف حالات المهام.

المعلمات: id (سلسلة) – معرف حالة المهمة التي سيتم حذفها
ckan.logic.action.delete.vocabulary_delete(context, data_dict)

حذف مفردات الوسوم.

يجب أن تكون مدير نظام لحذف المفردات.

المعلمات: id (سلسلة) – معرف المفردات
ckan.logic.action.delete.tag_delete(context, data_dict)

حذف وسم.

يجب أن تكون مدير نظام لحذف الوسوم.

المعلمات:
  • id (سلسلة) – المعرف أو اسم الوسم
  • vocabulary_id (سلسلة) – المعرف أو اسم المفردات التي ينتمي إليها الوسم (اختياري، الافتراضي: لا شيء)
ckan.logic.action.delete.unfollow_user(context, data_dict)

التوقف عن متابعة مستخدم.

المعلمات: id (سلسلة) – المعرف أو اسم المستخدم الذي لن تتم متابعته بعد الآن
ckan.logic.action.delete.unfollow_dataset(context, data_dict)

التوقف عن متابعة مجموعة بيانات.

المعلمات: id (سلسلة) – المعرف أو اسم مجموعة البيانات التي لن تتم متابعتها بعد الآن
ckan.logic.action.delete.group_member_delete(context, data_dict=None)

حذف مستخدم من مجموعة.

يجب أن يكون لديك صلاحية تعديل المجموعة.

المعلمات:
  • id (سلسلة) – المعرف أو اسم المجموعة
  • username (سلسلة) – اسم أو معرف المستخدم الذي سيتم حذفه
ckan.logic.action.delete.organization_member_delete(context, data_dict=None)

حذف مستخدم من منظمة.

يجب أن يكون لديك صلاحية تعديل المنظمة.

المعلمات:
  • id (سلسلة) – المعرف أو اسم المنظمة
  • username (سلسلة) – اسم أو معرف المستخدم الذي سيتم حذفه
ckan.logic.action.delete.unfollow_group(context, data_dict)

التوقف عن متابعة مجموعة.

المعلمات: id (سلسلة) – المعرف أو اسم المجموعة التي لن تتم متابعتها بعد الآن
ckan.logic.action.delete.job_clear(context, data_dict)

مسح قوائم انتظار المهام في الخلفية.

لا يشمل المهام التي هي قيد المعالجة بالفعل.

المعلمات: queues (قائمة) – قوائم الانتظار التي سيتم مسحها. إذا لم يتم تحديدها، سيتم مسح جميع قوائم الانتظار.
القيمة المعادة: قوائم الانتظار التي تم مسحها.
نوع الإرجاع: قائمة

جديد في الإصدار 2.7.

ckan.logic.action.delete.job_cancel(context, data_dict)

إلغاء مهمة في الخلفية في قائمة الانتظار.

يتم حذف المهمة من قائمة الانتظار وحذفها نهائيًا.

المعلمات: id (سلسلة) – المعرف الخاص بالمهمة في الخلفية.

جديد في الإصدار 2.7.

ckan.logic.action.delete.api_token_revoke(context, data_dict)

حذف رمز API.

المعلمات:
  • token (سلسلة) – الرمز المراد حذفه (إلزامي إذا لم يتم تحديد jti).
  • jti (سلسلة) – معرف الرمز المراد حذفه (يستبدل token إذا تم تحديده).

جديد في الإصدار 3.0.