REST Resource: indexing.datasources.items

المرجع: عنصر

يمثل كائنًا واحدًا يمثل عنصرًا في فهرس البحث مثل ملف أو مجلد أو سجل قاعدة بيانات.

تمثيل JSON
{
  "name": string,
  "acl": {
    object (ItemAcl)
  },
  "metadata": {
    object (ItemMetadata)
  },
  "structuredData": {
    object (ItemStructuredData)
  },
  "content": {
    object (ItemContent)
  },
  "version": string,
  "status": {
    object (ItemStatus)
  },
  "queue": string,
  "payload": string,
  "itemType": enum (Item.ItemType)
}
الحقول
name

string

اسم السلعة. التنسيق: datasources/{sourceId}/items/{itemId}

هذا الحقل إلزامي. الحد الأقصى للطول هو 1536 حرفًا.

acl

object (ItemAcl)

قائمة التحكّم بالوصول لهذا العنصر.

metadata

object (ItemMetadata)

معلومات البيانات الوصفية

structuredData

object (ItemStructuredData)

البيانات المنظَّمة للعنصر الذي يجب أن تتوافق مع تعريف عنصر مسجَّل في مخطط مصدر البيانات.

content

object (ItemContent)

محتوى العنصر الذي ستتم فهرسته وجعل نصه قابلاً للبحث عنه.

version

string (bytes format)

مطلوبة. يخزّن نظام الفهرسة النسخة من مصدر البيانات كسلسلة بايت، كما يقارن إصدار العنصر في الفهرس بنسخة العنصر المُدرَج في قائمة الانتظار باستخدام الترتيب المعجمي.

لن تعمل فهرسة Cloud Search على فهرسة أو حذف أي عنصر في قائمة الانتظار تكون قيمة إصداره أقل من أو تساوي نسخة العنصر المفهرَس حاليًا. الحد الأقصى لطول هذا الحقل هو 1024 بايت.

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

سلسلة بترميز base64.

status

object (ItemStatus)

حالة السلعة. حقل النتائج فقط

queue

string

إضافة هذا العنصر إلى قائمة المحتوى التالي الحدّ الأقصى لعدد الأحرف المسموح به هو 100 حرف.

payload

string (bytes format)

يمكن تخزين موصِّل الحالة الإضافية لهذا العنصر. يبلغ الحد الأقصى للطول 10,000 بايت.

سلسلة بترميز base64.

itemType

enum (Item.ItemType)

نوع هذا العنصر.

ItemAcl

معلومات قائمة التحكّم في الوصول للعنصر لمزيد من المعلومات، راجع قوائم التحكم في الوصول (ACLs) للخريطة.

تمثيل JSON
{
  "inheritAclFrom": string,
  "aclInheritanceType": enum (ItemAcl.AclInheritanceType),
  "readers": [
    {
      object (Principal)
    }
  ],
  "deniedReaders": [
    {
      object (Principal)
    }
  ],
  "owners": [
    {
      object (Principal)
    }
  ]
}
الحقول
inheritAclFrom

string

اسم العنصر الذي سيكتسب منه قائمة أذونات الوصول (ACL). ملاحظة: يوفر الاكتساب في قائمة التحكم بالوصول فقط أذونات الوصول إلى العناصر الفرعية ولا يحدد العلاقات الهيكلية، كما أنه لا يوفر طرقًا ملائمة لحذف مجموعات كبيرة من العناصر. يؤدي حذف عنصر رئيسي ACL من الفهرس إلى تغيير أذونات الوصول إلى العناصر الفرعية التي تشير إلى العنصر الرئيسي في الحقل inheritAclFrom فقط. لا يزال العنصر في الفهرس، ولكن قد لا يظهر في نتائج البحث. وعلى النقيض من ذلك، يؤدي حذف عنصر الحاوية أيضًا إلى حذف جميع العناصر التي تشير إلى الحاوية عبر الحقل containerName. الحد الأقصى لطول هذا الحقل هو 1536 حرفًا.

aclInheritanceType

enum (ItemAcl.AclInheritanceType)

تحدِّد هذه السياسة نوع قواعد الوصول التي سيتم تطبيقها عندما يكتسب عنصر قائمة التحكّم بالوصول (ACL) من عنصر رئيسي. ويجب ضبط هذه السياسة دائمًا جنبًا إلى جنب مع الحقل inheritAclFrom. بالإضافة إلى ذلك، عند ضبط الحقل inheritAclFrom، يجب ضبط هذا الحقل على AclInheritanceType صالح.

readers[]

object (Principal)

قائمة بالعناصر الأساسية المسموح لها بمشاهدة العنصر في نتائج البحث اختيارية في حال اكتساب الأذونات من عنصر آخر أو إذا لم يكن الغرض من العنصر أن يكون مرئيًا، مثل virtual containers. الحد الأقصى لعدد العناصر هو 1000.

deniedReaders[]

object (Principal)

قائمة بالعناصر الأساسية التي تم رفض وصولها صراحةً إلى العنصر في نتائج البحث يتم تلقائيًا رفض وصول القرّاء الرئيسيين، ولكن يتم استخدام حسابات القرّاء المرفوضة للتعامل مع الاستثناءات وإلغاء القائمة المسموح بها للقرّاء. الحد الأقصى لعدد العناصر هو 100.

owners[]

object (Principal)

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

ItemAcl.AclInheritanceType

أنواع البيانات الموروثة لقائمة التحكم بالوصول.

عمليات التعداد
NOT_APPLICABLE القيمة التلقائية عندما لا يكتسِب هذا العنصر قائمة التحكّم بالوصول (ACL). يتم استخدام NOT_APPLICABLE عندما يكون inheritAclFrom فارغًا. أي عنصر لا يتضمن البيانات الموروثة لقائمة التحكم بالوصول، قد يحتوي على قوائم التحكم بالوصول المُقدّمة من خلال حقلي readers وdeniedReaders الخاصين به.
CHILD_OVERRIDE أثناء تضارب التفويض، تحدد قائمة التحكم بالوصول (ACL) للعنصر الفرعي إمكانية الوصول للقراءة.
PARENT_OVERRIDE أثناء تضارب التفويض، تحدد قائمة التحكم بالوصول (ACL) للعنصر الرئيسي المحدد في حقل inheritAclFrom إمكانية الوصول للقراءة.
BOTH_PERMIT لا يتم منح الإذن بالوصول إلا إذا كان هذا العنصر والعنصر الرئيسي المحدّد في الحقل inheritAclFrom يسمحان بالوصول للقراءة.

المدير

الإشارة إلى مستخدم أو مجموعة أو نطاق

تمثيل JSON
{

  // Union field principal can be only one of the following:
  "gsuitePrincipal": {
    object (GSuitePrincipal)
  },
  "userResourceName": string,
  "groupResourceName": string
  // End of list of possible types for union field principal.
}
الحقول

حقل الاتحاد principal

يمكن أن تكون السمة "principal" واحدة فقط مما يلي:

gsuitePrincipal

object (GSuitePrincipal)

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

userResourceName

string

يتألف هذا المدير من مستخدم يتم تحديده باستخدام هوية خارجية. يجب أن يحدّد حقل "الاسم" اسم مورد المستخدم بالتنسيق التالي: identitysources/{sourceId}/users/{ID}.

groupResourceName

string

هذا النموذج الأساسي هو مجموعة يتم تحديدها باستخدام هوية خارجية. يجب أن يحدّد حقل الاسم اسم مورد المجموعة بالتنسيق التالي: identitysources/{sourceId}/groups/{ID}

ItemMetadata

حقول البيانات الوصفية المتاحة للعنصر.

تمثيل JSON
{
  "title": string,
  "sourceRepositoryUrl": string,
  "containerName": string,
  "objectType": string,
  "createTime": string,
  "updateTime": string,
  "interactions": [
    {
      object (Interaction)
    }
  ],
  "contentLanguage": string,
  "mimeType": string,
  "searchQualityMetadata": {
    object (SearchQualityMetadata)
  },
  "keywords": [
    string
  ],
  "hash": string,
  "contextAttributes": [
    {
      object (ContextAttribute)
    }
  ]
}
الحقول
title

string

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

sourceRepositoryUrl

string

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

containerName

string

اسم حاوية هذا العنصر يؤدي حذف الحاوية إلى الحذف التلقائي لهذه السلعة. ملاحظة: قوائم التحكم بالوصول غير موروثة من عنصر حاوية. لتوفير البيانات الموروثة لقائمة التحكم بالوصول إلى عنصر، استخدِم الحقل inheritAclFrom. الحد الأقصى للطول هو 1536 حرفًا.

objectType

string

نوع السلعة. يجب أن يتوافق هذا مع اسم تعريف الكائن في المخطط المسجَّل لمصدر البيانات. على سبيل المثال، إذا كان مخطط مصدر البيانات يحتوي على تعريف لكائن يحمل الاسم 'document'، يجب أن تضبط طلبات فهرسة العناصر للعناصر من هذا النوع نوع الكائن على "مستند". الحد الأقصى للطول هو 256 حرفًا.

createTime

string (Timestamp format)

الوقت الذي تم فيه إنشاء العنصر في مستودع المصدر.

طابع زمني بتنسيق RFC3339 UTC "Zulu" ، بدقة نانو ثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z"

updateTime

string (Timestamp format)

الوقت الذي تم فيه إجراء آخر تعديل على العنصر في مستودع المصدر.

طابع زمني بتنسيق RFC3339 UTC "Zulu" ، بدقة نانو ثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z"

interactions[]

object (Interaction)

قائمة بتفاعلات العنصر. تُستخدَم التفاعلات لتحسين جودة طلب البحث، ولكنها لا تظهر للمستخدمين النهائيين. الحد الأقصى لعدد العناصر هو 1000.

contentLanguage

string

رمز اللغة BCP-47 للسلعة، مثل en-US أو sr-Latn. لمزيد من المعلومات، يُرجى الاطّلاع على http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. الحد الأقصى لعدد الأحرف المسموح به هو 32 حرفًا.

mimeType

string

نوع MIME الأصلي لـ ItemContent.content في المستودع المصدر. الحد الأقصى للطول هو 256 حرفًا.

searchQualityMetadata

object (SearchQualityMetadata)

البيانات الوصفية الإضافية لجودة البحث الخاصة بالعنصر

keywords[]

string

الكلمات الرئيسية أو العبارات الإضافية التي يجب أن تتطابق مع العنصر. يتم استخدامه داخليًا للمحتوى من إنشاء المستخدمين. الحد الأقصى لعدد العناصر هو 100. الحد الأقصى للطول هو 8,192 حرفًا.

hash

string

قيمة التجزئة التي قدَّمها المتصل من واجهة برمجة التطبيقات ويمكن استخدام هذه البيانات مع طريقة items.push لاحتساب حالة التعديل. الحد الأقصى لعدد الأحرف هو 2048 حرفًا.

contextAttributes[]

object (ContextAttribute)

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

تفاعل

يمثل هذا التفاعل تفاعلاً بين مستخدم وعنصر.

تمثيل JSON
{
  "type": enum (Interaction.InteractionType),
  "principal": {
    object (Principal)
  },
  "interactionTime": string
}
الحقول
type

enum (Interaction.InteractionType)

principal

object (Principal)

المستخدِم الذي تفاعل مع العنصر.

interactionTime

string (Timestamp format)

تمثل هذه السمة الوقت الذي تفاعل فيه المستخدم مع العنصر. وفي حال توفُّر إجراءات متعددة من النوع نفسه لمستخدم واحد، سيتم تسجيل الإجراء الأحدث فقط.

طابع زمني بتنسيق RFC3339 UTC "Zulu" ، بدقة نانو ثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z"

Interaction.InteractionType

نوع النشاط الذي قام به المستخدم على العنصر.

عمليات التعداد
UNSPECIFIED القيمة غير صالحة.
VIEW يشير هذا التفاعل إلى أنّ المستخدم قد شاهد السلعة.
EDIT يشير هذا التفاعل إلى أنّ المستخدم قد عدَّل العنصر.

SearchQualityMetadata

بيانات وصفية إضافية لجودة البحث للعنصر

تمثيل JSON
{
  "quality": number
}
الحقول
quality

number

تشير هذه السمة إلى جودة السلعة، وتُستخدم للتأثير في جودة البحث. ويجب أن تتراوح القيمة بين 0.0 (أقل جودة) و1.0 (أعلى جودة). والقيمة التلقائية هي 0.0.

ContextAttribute

سمة مُسمّاة مرتبطة بعنصر يمكن استخدامها للتأثير في ترتيب السلعة بناءً على سياق الطلب.

تمثيل JSON
{
  "name": string,
  "values": [
    string
  ]
}
الحقول
name

string

اسم السمة. يجب ألا يكون الحقل فارغًا. الحد الأقصى لعدد الأحرف المسموح به هو 32 حرفًا. يجب أن يبدأ الاسم بحرف ويمكن أن يحتوي فقط على أحرف (A-Z أو a-z) أو أرقام (0-9). وستتم تسوية الاسم (بأحرف صغيرة) قبل مطابقته.

values[]

string

تمثّل هذه السمة القيم النصية للسمة. الحد الأقصى لعدد العناصر هو 10. يبلغ الحد الأقصى لطول العنصر في الصفيفة 32 حرفًا. سيتم تسوية القيمة (بأحرف صغيرة) قبل مطابقتها.

ItemStructuredData

حقول البيانات المنظَّمة المتاحة للعنصر.

تمثيل JSON
{
  "object": {
    object (StructuredDataObject)
  },
  "hash": string
}
الحقول
object

object (StructuredDataObject)

تمثّل هذه السمة كائن البيانات المنظَّمة الذي يجب أن يتوافق مع تعريف العنصر المسجّل في المخطط الخاص بمصدر البيانات.

hash

string

قيمة التجزئة التي قدَّمها المتصل من واجهة برمجة التطبيقات ويمكن استخدام هذه البيانات مع طريقة items.push لاحتساب حالة التعديل. الحد الأقصى لعدد الأحرف هو 2048 حرفًا.

StructuredDataObject

يشير ذلك المصطلح إلى كائن بيانات منظَّمة يتألّف من سمات مُسمّاة.

تمثيل JSON
{
  "properties": [
    {
      object (NamedProperty)
    }
  ]
}
الحقول
properties[]

object (NamedProperty)

خصائص الكائن. الحد الأقصى لعدد العناصر هو 1000.

NamedProperty

زوج مكتوب من الاسم والقيمة للبيانات المنظَّمة. يجب أن يكون نوع القيمة مطابقًا للنوع المسجَّل للسمة name في تعريف الكائن objectType.

تمثيل JSON
{
  "name": string,

  // Union field value can be only one of the following:
  "integerValues": {
    object (NamedProperty.IntegerValues)
  },
  "doubleValues": {
    object (NamedProperty.DoubleValues)
  },
  "timestampValues": {
    object (NamedProperty.TimestampValues)
  },
  "booleanValue": boolean,
  "objectValues": {
    object (NamedProperty.ObjectValues)
  },
  "enumValues": {
    object (NamedProperty.EnumValues)
  },
  "dateValues": {
    object (NamedProperty.DateValues)
  },
  "textValues": {
    object (NamedProperty.TextValues)
  },
  "htmlValues": {
    object (NamedProperty.HtmlValues)
  }
  // End of list of possible types for union field value.
}
الحقول
name

string

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

حقل الاتحاد value قيم السمة المُسمّاة. تجدر الإشارة إلى أنّ الموقع يمكن أن يحتوي على قيم من نوع واحد فقط. يمكن أن تكون السمة "value" واحدة فقط مما يلي:
integerValues

object (NamedProperty.IntegerValues)

doubleValues

object (NamedProperty.DoubleValues)

timestampValues

object (NamedProperty.TimestampValues)

booleanValue

boolean

objectValues

object (NamedProperty.ObjectValues)

enumValues

object (NamedProperty.EnumValues)

dateValues

object (NamedProperty.DateValues)

textValues

object (NamedProperty.TextValues)

htmlValues

object (NamedProperty.HtmlValues)

NamedProperty.IntegerValues

قائمة بقيم الأعداد الصحيحة

تمثيل JSON
{
  "values": [
    string
  ]
}
الحقول
values[]

string (int64 format)

NamedProperty.DoubleValues

قائمة تتضمّن قيمًا مزدوجة

تمثيل JSON
{
  "values": [
    number
  ]
}
الحقول
values[]

number

NamedProperty.TimestampValues

قائمة قيم الطوابع الزمنية

تمثيل JSON
{
  "values": [
    string
  ]
}
الحقول
values[]

string (Timestamp format)

طابع زمني بتنسيق RFC3339 UTC "Zulu" ، بدقة نانو ثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z"

NamedProperty.ObjectValues

قائمة بقيم الكائنات

تمثيل JSON
{
  "values": [
    {
      object (StructuredDataObject)
    }
  ]
}
الحقول
values[]

object (StructuredDataObject)

NamedProperty.EnumValues

قائمة بقيم التعداد

تمثيل JSON
{
  "values": [
    string
  ]
}
الحقول
values[]

string

الحد الأقصى لطول قيم السلسلة المسموح به هو 32 حرفًا.

NamedProperty.DateValues

قائمة بقيم التاريخ

تمثيل JSON
{
  "values": [
    {
      object (Date)
    }
  ]
}
الحقول
values[]

object (Date)

NamedProperty.TextValues

قائمة القيم النصية

تمثيل JSON
{
  "values": [
    string
  ]
}
الحقول
values[]

string

الحد الأقصى لطول القيم النصية المسموح به هو 2048 حرفًا.

NamedProperty.HtmlValues

قائمة قيم html

تمثيل JSON
{
  "values": [
    string
  ]
}
الحقول
values[]

string

الحد الأقصى لطول قيم html المسموح به هو 2048 حرفًا.

ItemContent

محتوى عنصر ستتم فهرسته وعرضه من خلال Cloud Search. يُسمح فقط باستخدام السلاسل بترميز UTF-8 مثل inlineContent. إذا تم تحميل المحتوى وليس بنظام ثنائي، يجب أن يكون بترميز UTF-8.

تمثيل JSON
{
  "contentFormat": enum (ItemContent.ContentFormat),
  "hash": string,

  // Union field content can be only one of the following:
  "inlineContent": string,
  "contentDataRef": {
    object (UploadItemRef)
  }
  // End of list of possible types for union field content.
}
الحقول
contentFormat

enum (ItemContent.ContentFormat)

hash

string

معلومات التجزئة التي يحتسبها وقدّمها عميل واجهة برمجة التطبيقات للمحتوى يمكن استخدامها مع الطريقة items.push لحساب الحالة المعدَّلة. الحد الأقصى لعدد الأحرف هو 2048 حرفًا.

حقل الاتحاد content

يمكن أن تكون السمة "content" واحدة فقط مما يلي:

inlineContent

string (bytes format)

المحتوى الذي يتم تضمينه في طريقة التعديل الحد الأقصى للطول هو 102400 بايت (100 كيبيبايت).

سلسلة بترميز base64.

contentDataRef

object (UploadItemRef)

تحميل المعرّف المرجعي لمحتوى تم تحميله سابقًا عبر طريقة الكتابة

ItemContent.ContentFormat

تنسيق المحتوى. إذا كان التنسيق RAW، يجب أن يكون المحتوى بالتنسيق المحدَّد في mimeType.

عمليات التعداد
UNSPECIFIED القيمة غير صالحة.
HTML contentFormat هو HTML.
TEXT contentFormat هو نص حر.
RAW contentFormat هو بايت أولية.

UploadItemRef

يمثّل مرجعًا لجلسة تحميل. تم إنشاء هذا المرجع عبر upload method. هذا المرجع صالح لمدة 30 يومًا بعد إنشائه. قد يشير تعديل محتوى السلعة إلى هذا المحتوى الذي تم تحميله عبر contentDataRef.

تمثيل JSON
{
  "name": string
}
الحقول
name

string

اسم مرجع المحتوى الحد الأقصى لعدد الأحرف هو 2048 حرفًا.

ItemStatus

يحتوي هذا على حالة العنصر وأي أخطاء.

تمثيل JSON
{
  "code": enum (ItemStatus.Code),
  "processingErrors": [
    {
      object (ProcessingError)
    }
  ],
  "repositoryErrors": [
    {
      object (RepositoryError)
    }
  ]
}
الحقول
code

enum (ItemStatus.Code)

رمز الحالة.

processingErrors[]

object (ProcessingError)

تفاصيل الخطأ في حال كان العنصر في حالة "ERROR".

repositoryErrors[]

object (RepositoryError)

تم الإبلاغ عن خطأ في المستودع من قِبل الموصِّل.

ProcessingError

تمثيل JSON
{
  "code": enum (ProcessingErrorCode),
  "errorMessage": string,
  "fieldViolations": [
    {
      object (FieldViolation)
    }
  ]
}
الحقول
code

enum (ProcessingErrorCode)

رمز خطأ يشير إلى طبيعة الخطأ.

errorMessage

string

وصف الخطأ.

fieldViolations[]

object (FieldViolation)

في حال كانت حقول السلع غير صالحة، يحتوي هذا الحقل على تفاصيل حول أخطاء التحقّق من الصحة.

ProcessingErrorCode

رموز للإشارة إلى الخطأ الذي حدث أثناء معالجة خادم Cloud Search للعناصر يمكن أن يحتوي سلعة واحدة على عدة أخطاء في المعالجة.

عمليات التعداد
PROCESSING_ERROR_CODE_UNSPECIFIED إدخال قيمة فقط استخدِم هذه القيمة في "العناصر".
MALFORMED_REQUEST قائمة التحكم بالوصول أو البيانات الوصفية أو المحتوى مكتوب بشكل غير صحيح أو في حالة غير صالحة. تحتوي انتهاكات الحقول على مزيد من التفاصيل حول مكان المشكلة.
UNSUPPORTED_CONTENT_FORMAT صيغة العدّ غير متوافقة.
INDIRECT_BROKEN_ACL العناصر التي تحتوي على معلومات غير مكتملة في قائمة التحكم بالوصول (ACL) بسبب اكتساب عناصر أخرى ذات قائمة التحكم بالوصول (ACL) تالفة أو وجود مجموعات ذات عناصر تابعة غير مخصصة.
ACL_CYCLE شكّل الرسم البياني للوراثة في قائمة التحكم بالوصول (ACL) دورة.

FieldViolation

تمثيل JSON
{
  "field": string,
  "description": string
}
الحقول
field

string

مسار الحقل الذي يحتوي على انتهاك.

description

string

وصف الخطأ.

RepositoryError

الأخطاء عند اتصال الموصل بمستودع المصدر.

تمثيل JSON
{
  "type": enum (RepositoryError.Type),
  "httpStatusCode": integer,
  "errorMessage": string
}
الحقول
type

enum (RepositoryError.Type)

نوع الخطأ.

httpStatusCode

integer

رموز الخطأ. يتطابق مع تعريف رموز حالة HTTP.

errorMessage

string

الرسالة التي تصف الخطأ. يبلغ الحد الأقصى لطول الرسالة المسموح به 8192 حرفًا.

RepositoryError.Type

قائمة برموز الأخطاء الخاصة بمشاكل الاتصال بالمستودع

عمليات التعداد
UNKNOWN حدث خطأ غير معروف.
NETWORK_ERROR مضيف غير معروف أو لا يمكن الوصول إليه.
DNS_ERROR مشكلة في نظام أسماء النطاقات، مثل عدم استجابة خادم نظام أسماء النطاقات.
CONNECTION_ERROR لا يمكن الاتصال بخادم المستودع.
AUTHENTICATION_ERROR تعذّرت المصادقة بسبب عدم صحة بيانات الاعتماد.
AUTHORIZATION_ERROR حساب الخدمة غير مُصرّح به للمستودع.
SERVER_ERROR حدث خطأ في خادم المستودع.
QUOTA_EXCEEDED تمّ تجاوز الحصة المخصصة.
SERVICE_UNAVAILABLE الخادم غير متاح مؤقتًا.
CLIENT_ERROR خطأ متعلق بالعميل، مثل طلب غير صالح من الموصِّل إلى خادم المستودع.

Item.ItemType

عمليات التعداد
UNSPECIFIED
CONTENT_ITEM تمثّل هذه السمة سلعة تتم فهرستها لغرض وحيد وهو عرض المعلومات. لا يمكن إحالة هذه العناصر في حقل containerName أو inheritAclFrom.
CONTAINER_ITEM يشير ذلك المصطلح إلى عنصر تتم فهرسته ويهدف إلى تزويد عناصر أخرى بقوائم ACL و/أو يحتوي على عناصر أخرى.
VIRTUAL_CONTAINER_ITEM عنصر لم تتم فهرسته، ولكن له نفس الغرض كـ CONTAINER_ITEM.

الطُرق

delete

لحذف Item resource لاسم المورد المحدّد.

deleteQueueItems

حذف جميع العناصر في قائمة المحتوى التالي

get

الحصول على Item resource حسب اسم الملف

index

تعديل قائمة التحكّم بالوصول (ACL) والبيانات الوصفية والمحتوى في "Item"

list

يسرد كل ملفات Item resources أو مجموعة فرعية منها.

poll

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

push

لوضع عنصر في قائمة الانتظار لاستطلاعات الرأي والتحديث لاحقًا

unreserve

إلغاء حجز جميع العناصر من قائمة الانتظار، ما يجعلها كلّها مؤهّلة للاستطلاع

upload

ينشئ جلسة تحميل لتحميل محتوى العنصر.