REST Resource: indexing.datasources.items

Ressource: Artikel

Stellt ein einzelnes Objekt dar, bei dem es sich um ein Element im Suchindex handelt, z. B. eine Datei, einen Ordner oder einen Datenbankeintrag.

JSON-Darstellung
{
  "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)
}
Felder
name

string

Der Name des Artikels. Format: datasources/{sourceId}/items/{itemId}

Dies ist ein Pflichtfeld. Die maximale Länge beträgt 1.536 Zeichen.

acl

object (ItemAcl)

Zugriffssteuerungsliste für dieses Element.

metadata

object (ItemMetadata)

Die Metadaten-Informationen.

structuredData

object (ItemStructuredData)

Die strukturierten Daten für das Element, die einer registrierten Objektdefinition im Schema für die Datenquelle entsprechen müssen.

content

object (ItemContent)

Inhalt des Artikels, der indexiert und der Text suchbar gemacht werden soll.

version

string (bytes format)

Erforderlich. Das Indexierungssystem speichert die Version aus der Datenquelle als Bytestring und vergleicht die Elementversion im Index mit der Version des Elements in der Warteschlange unter Verwendung der lexikalischen Reihenfolge.

Durch die Cloud Search-Indexierung werden keine Elemente in der Warteschlange indexiert oder gelöscht, deren Versionswert kleiner oder gleich der Version des aktuell indexierten Elements ist. Die maximale Länge für dieses Feld beträgt 1.024 Byte.

Informationen dazu, wie sich die Artikelversion auf den Löschvorgang auswirkt, finden Sie unter Umgang mit Überarbeitungen nach manuellen Löschvorgängen.

Ein base64-codierter String.

status

object (ItemStatus)

Status des Artikels Nur Ausgabefeld.

queue

string

Warteschlange, zu der dieses Element gehört. Die maximale Länge beträgt 100 Zeichen.

payload

string (bytes format)

Ein zusätzlicher Status-Connector kann für dieses Element speichern. Die maximale Länge beträgt 10.000 Byte.

Ein base64-codierter String.

itemType

enum (Item.ItemType)

Der Typ für dieses Element.

ItemAcl

Informationen zur Zugriffssteuerungsliste für das Element. Weitere Informationen finden Sie unter ACLs zuordnen.

JSON-Darstellung
{
  "inheritAclFrom": string,
  "aclInheritanceType": enum (ItemAcl.AclInheritanceType),
  "readers": [
    {
      object (Principal)
    }
  ],
  "deniedReaders": [
    {
      object (Principal)
    }
  ],
  "owners": [
    {
      object (Principal)
    }
  ]
}
Felder
inheritAclFrom

string

Der Name des Elements, von dem die Access Permission List (ACL) übernommen werden soll. Hinweis: Bei der ACL-Vererbung werden ausschließlich Zugriffsberechtigungen für untergeordnete Elemente gewährt. Es werden weder strukturelle Beziehungen definiert noch lässt sich auf einfache Weise große Gruppen von Elementen löschen. Wenn Sie ein übergeordnetes ACL-Element aus dem Index löschen, werden nur die Zugriffsberechtigungen für untergeordnete Elemente geändert, die im Feld inheritAclFrom auf das übergeordnete Element verweisen. Das Element ist weiterhin im Index enthalten, wird aber möglicherweise nicht in den Suchergebnissen angezeigt. Im Gegensatz dazu werden beim Löschen eines Containerelements auch alle Elemente gelöscht, die über das Feld containerName auf den Container verweisen. Die maximale Länge dieses Felds beträgt 1.536 Zeichen.

aclInheritanceType

enum (ItemAcl.AclInheritanceType)

Legt den Typ der Zugriffsregeln fest, die angewendet werden sollen, wenn ein Element die ACL eines übergeordneten Elements erbt. Dieser sollte immer zusammen mit dem Feld inheritAclFrom festgelegt werden. Wenn das Feld inheritAclFrom festgelegt ist, sollte dieses Feld auf einen gültigen AclInheritanceType festgelegt werden.

readers[]

object (Principal)

Liste der Hauptkonten, die das Element in den Suchergebnissen sehen dürfen. Optional, wenn Berechtigungen von einem anderen Element übernommen werden oder wenn das Element nicht sichtbar sein soll, z. B. virtual containers. Es sind maximal 1.000 Elemente zulässig.

deniedReaders[]

object (Principal)

Liste der Hauptkonten, denen der Zugriff auf das Element in den Suchergebnissen explizit verweigert wird. Während Hauptkonten der Zugriff standardmäßig verweigert wird, verwenden Sie „Verweigerte Leser“, um Ausnahmen zu verarbeiten und die Liste der zugelassenen Leser zu überschreiben. Es sind maximal 100 Elemente zulässig.

owners[]

object (Principal)

Optional. Liste der Eigentümer des Elements. Dieses Feld hat keinen Einfluss auf Berechtigungen für den Dokumentzugriff. Sie bietet jedoch ein leichtes Ranking Booster für Elemente, bei denen der anfragende Nutzer Inhaber ist. Es sind maximal fünf Elemente zulässig.

ItemAcl.AclInheritanceType

Die Arten der ACL-Vererbung.

Enums
NOT_APPLICABLE Der Standardwert, wenn für dieses Element keine ACL übernommen wird. Verwenden Sie NOT_APPLICABLE, wenn inheritAclFrom leer ist. Für Elemente ohne ACL-Vererbung können ACLs weiterhin über die eigenen Felder readers und deniedReaders angegeben werden.
CHILD_OVERRIDE Während eines Autorisierungskonflikts wird der Lesezugriff durch die ACL des untergeordneten Elements bestimmt.
PARENT_OVERRIDE Während eines Autorisierungskonflikts wird der Lesezugriff durch die ACL des übergeordneten Elements bestimmt, das im Feld inheritAclFrom angegeben ist.
BOTH_PERMIT Der Zugriff wird nur gewährt, wenn sowohl dieses Element als auch das im Feld inheritAclFrom angegebene übergeordnete Element Lesezugriff gewähren.

Hauptkonto

Verweis auf einen Nutzer, eine Gruppe oder eine Domain

JSON-Darstellung
{

  // 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.
}
Felder

Union-Feld principal.

Für principal ist nur einer der folgenden Werte zulässig:

gsuitePrincipal

object (GSuitePrincipal)

Dieses Hauptkonto ist ein Nutzer, eine Gruppe oder eine Domain von Google Workspace.

userResourceName

string

Dieses Hauptkonto ist ein Nutzer, der mithilfe einer externen Identität identifiziert wurde. Im Feld „Name“ muss der Name der Nutzerressource in folgendem Format angegeben werden: identitysources/{sourceId}/users/{ID}

groupResourceName

string

Dieses Hauptkonto ist eine Gruppe, die mithilfe einer externen Identität identifiziert wird. Im Feld „Name“ muss der Name der Gruppenressource in folgendem Format angegeben werden: Identitysources/{Quell-ID}/groups/{ID}

ItemMetadata

Verfügbare Metadatenfelder für das Element.

JSON-Darstellung
{
  "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)
    }
  ]
}
Felder
title

string

Der Titel des Artikels. Falls angegeben, ist dies der angezeigte Titel des query.search-Ergebnisses. Die maximale Länge beträgt 2.048 Zeichen.

sourceRepositoryUrl

string

Link zum Quell-Repository, das die Daten bereitstellt. Bei Suchergebnissen wird dieser Link auf den Titel angewendet. Leerräume oder Sonderzeichen können dazu führen, dass Cloud Search-Ergebnislinks eine Weiterleitung auslösen. Um dies zu vermeiden, sollten Sie die URL codieren. Die maximale Länge beträgt 2.048 Zeichen.

containerName

string

Der Name des Containers für dieses Element. Wenn Sie das Containerelement löschen, wird es automatisch gelöscht. Hinweis: ACLs werden nicht von einem Containerelement übernommen. Verwenden Sie das Feld inheritAclFrom, um die ACL-Vererbung für ein Element bereitzustellen. Die maximale Länge beträgt 1.536 Zeichen.

objectType

string

Der Typ des Elements. Er sollte dem Namen einer Objektdefinition im für die Datenquelle registrierten Schema entsprechen. Wenn beispielsweise das Schema für die Datenquelle eine Objektdefinition mit dem Namen „document“ enthält, sollte bei Anfragen zur Elementindexierung für Objekte dieses Typs „objectType“ auf „document“ festgelegt werden. Die maximale Länge beträgt 256 Zeichen.

createTime

string (Timestamp format)

Der Zeitpunkt, zu dem das Element im Quell-Repository erstellt wurde.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Der Zeitpunkt, zu dem das Element zuletzt im Quell-Repository geändert wurde.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

interactions[]

object (Interaction)

Eine Liste der Interaktionen für das Element. Interaktionen werden verwendet, um die Qualität von „query.search“ zu verbessern, sind aber nicht für Endnutzer sichtbar. Es sind maximal 1.000 Elemente zulässig.

contentLanguage

string

Der BCP-47-Sprachcode für den Artikel, z. B. „en-US“ oder „sr-Latn“. Weitere Informationen finden Sie unter http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Die maximale Länge beträgt 32 Zeichen.

mimeType

string

Der ursprüngliche MIME-Typ von ItemContent.content im Quell-Repository. Die maximale Länge beträgt 256 Zeichen.

searchQualityMetadata

object (SearchQualityMetadata)

Zusätzliche Metadaten zur Suchqualität des Elements

keywords[]

string

Zusätzliche Keywords oder Wortgruppen, die dem Artikel entsprechen sollten. Wird intern für von Nutzern erstellte Inhalte verwendet. Es sind maximal 100 Elemente zulässig. Die maximale Länge beträgt 8.192 Zeichen.

hash

string

Vom API-Aufrufer bereitgestellter Hashwert. Dies kann mit der Methode items.push verwendet werden, um den geänderten Status zu berechnen. Die maximale Länge beträgt 2.048 Zeichen.

contextAttributes[]

object (ContextAttribute)

Eine Gruppe benannter Attribute, die mit dem Element verknüpft sind. Dies kann verwendet werden, um das Ranking des Elements basierend auf dem Kontext in der Anfrage zu beeinflussen. Es sind maximal 10 Elemente zulässig.

Interaktion

Interaktion zwischen einem Nutzer und einem Artikel

JSON-Darstellung
{
  "type": enum (Interaction.InteractionType),
  "principal": {
    object (Principal)
  },
  "interactionTime": string
}
Felder
type

enum (Interaction.InteractionType)

principal

object (Principal)

Der Nutzer, der eine Aktion für den Artikel ausgeführt hat.

interactionTime

string (Timestamp format)

Die Zeit, zu der der Nutzer eine Aktion für das Element ausgeführt hat. Wenn für einen einzelnen Nutzer mehrere Aktionen desselben Typs vorhanden sind, wird nur die letzte Aktion erfasst.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

Interaction.InteractionType

Die Art der Aktivität, die der Nutzer für den Artikel ausgeführt hat.

Enums
UNSPECIFIED Ungültiger Wert.
VIEW Diese Interaktion zeigt an, dass der Nutzer den Artikel angesehen hat.
EDIT Diese Interaktion zeigt an, dass der Nutzer das Element bearbeitet hat.

SearchQualityMetadata

Zusätzliche Metadaten zur Suchqualität des Elements.

JSON-Darstellung
{
  "quality": number
}
Felder
quality

number

Gibt die Qualität des Elements an, die zur Beeinflussung der Suchqualität verwendet wird. Der Wert sollte zwischen 0,0 (niedrigste Qualität) und 1,0 (höchste Qualität) liegen. Der Standardwert ist 0,0.

ContextAttribute

Ein benanntes Attribut, das mit einem Artikel verknüpft ist und dazu verwendet werden kann, das Ranking des Artikels basierend auf dem Kontext in der Anfrage zu beeinflussen.

JSON-Darstellung
{
  "name": string,
  "values": [
    string
  ]
}
Felder
name

string

Der Name des Attributs. Dieses Feld darf nicht leer sein. Die maximale Länge beträgt 32 Zeichen. Der Name muss mit einem Buchstaben beginnen und darf nur Buchstaben (A–Z, a–z) oder Zahlen (0–9) enthalten. Der Name wird normalisiert (in Kleinbuchstaben), bevor er abgeglichen wird.

values[]

string

Textwerte des Attributs. Es sind maximal 10 Elemente zulässig. Ein Element im Array darf maximal 32 Zeichen lang sein. Der Wert wird normalisiert (kleingeschrieben), bevor er abgeglichen wird.

ItemStructuredData

Verfügbare strukturierte Datenfelder für das Element.

JSON-Darstellung
{
  "object": {
    object (StructuredDataObject)
  },
  "hash": string
}
Felder
object

object (StructuredDataObject)

Das strukturierte Datenobjekt, das einer registrierten Objektdefinition im Schema für die Datenquelle entsprechen muss.

hash

string

Vom API-Aufrufer bereitgestellter Hashwert. Dies kann mit der Methode items.push verwendet werden, um den geänderten Status zu berechnen. Die maximale Länge beträgt 2.048 Zeichen.

StructuredDataObject

Ein strukturiertes Datenobjekt, das aus benannten Properties besteht.

JSON-Darstellung
{
  "properties": [
    {
      object (NamedProperty)
    }
  ]
}
Felder
properties[]

object (NamedProperty)

Die Eigenschaften des Objekts. Es sind maximal 1.000 Elemente zulässig.

NamedProperty

Ein typisiertes Name/Wert-Paar für strukturierte Daten. Der Typ des Werts muss mit dem registrierten Typ für das Attribut name in der Objektdefinition von objectType übereinstimmen.

JSON-Darstellung
{
  "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.
}
Felder
name

string

Der Name der Eigenschaft. Dieser Name sollte dem Namen der Eigenschaft entsprechen, die für die Objektdefinition im Schema registriert wurde. Die maximal zulässige Länge für diese Property beträgt 256 Zeichen.

Union-Feld value. Wert(e) der benannten Eigenschaft Beachten Sie, dass ein Attribut nur Werte eines Typs enthalten kann. Für value ist nur einer der folgenden Werte zulässig:
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

Liste mit Ganzzahlwerten.

JSON-Darstellung
{
  "values": [
    string
  ]
}
Felder
values[]

string (int64 format)

NamedProperty.DoubleValues

Liste mit doppelten Werten.

JSON-Darstellung
{
  "values": [
    number
  ]
}
Felder
values[]

number

NamedProperty.TimestampValues

Liste der Zeitstempelwerte.

JSON-Darstellung
{
  "values": [
    string
  ]
}
Felder
values[]

string (Timestamp format)

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

NamedProperty.ObjectValues

Liste der Objektwerte.

JSON-Darstellung
{
  "values": [
    {
      object (StructuredDataObject)
    }
  ]
}
Felder
values[]

object (StructuredDataObject)

NamedProperty.EnumValues

Liste der enum-Werte.

JSON-Darstellung
{
  "values": [
    string
  ]
}
Felder
values[]

string

Die maximal zulässige Länge für Zeichenfolgenwerte beträgt 32 Zeichen.

NamedProperty.DateValues

Liste der Datumswerte

JSON-Darstellung
{
  "values": [
    {
      object (Date)
    }
  ]
}
Felder
values[]

object (Date)

NamedProperty.TextValues

Liste mit Textwerten.

JSON-Darstellung
{
  "values": [
    string
  ]
}
Felder
values[]

string

Die maximal zulässige Länge für Textwerte beträgt 2.048 Zeichen.

NamedProperty.HtmlValues

Liste der HTML-Werte.

JSON-Darstellung
{
  "values": [
    string
  ]
}
Felder
values[]

string

Die maximal zulässige Länge für HTML-Werte beträgt 2.048 Zeichen.

ItemContent

Inhalt eines Elements, das von Cloud Search indexiert und angezeigt werden soll. Als inlineContent sind nur UTF-8-codierte Strings zulässig. Wenn die hochgeladenen Inhalte nicht binär sind, müssen sie UTF-8-codiert sein.

JSON-Darstellung
{
  "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.
}
Felder
contentFormat

enum (ItemContent.ContentFormat)

hash

string

Hash-Informationen, die vom API-Client für Inhalte berechnet und bereitgestellt werden. Kann mit der Methode items.push zur Berechnung des geänderten Status verwendet werden. Die maximale Länge beträgt 2.048 Zeichen.

Union-Feld content.

Für content ist nur einer der folgenden Werte zulässig:

inlineContent

string (bytes format)

Inhalte, die innerhalb der Aktualisierungsmethode bereitgestellt werden. Die maximale Länge beträgt 102.400 Byte (100 KiB).

Ein base64-codierter String.

contentDataRef

object (UploadItemRef)

Referenz-ID eines zuvor hochgeladenen Inhalts mithilfe der Schreibmethode hochladen.

ItemContent.ContentFormat

Das Format des Inhalts. Im RAW-Format müssen die Inhalte in dem unter mimeType angegebenen Format vorliegen.

Enums
UNSPECIFIED Ungültiger Wert.
HTML contentFormat ist HTML.
TEXT contentFormat ist Freitext.
RAW contentFormat ist Rohbyte.

UploadItemRef

Stellt eine Uploadsitzungsreferenz dar. Diese Referenz wird über upload method erstellt. Diese Referenz ist nach ihrer Erstellung 30 Tage lang gültig. Wenn du den Inhalt des Artikels aktualisierst, kann über contentDataRef auf diese hochgeladenen Inhalte zugegriffen werden.

JSON-Darstellung
{
  "name": string
}
Felder
name

string

Der Name der Inhaltsreferenz. Die maximale Länge beträgt 2.048 Zeichen.

ItemStatus

Sie enthält den Status des Artikels und etwaige Fehler.

JSON-Darstellung
{
  "code": enum (ItemStatus.Code),
  "processingErrors": [
    {
      object (ProcessingError)
    }
  ],
  "repositoryErrors": [
    {
      object (RepositoryError)
    }
  ]
}
Felder
code

enum (ItemStatus.Code)

Statuscode.

processingErrors[]

object (ProcessingError)

Fehlerdetails, falls sich das Element im Status ERROR befindet

repositoryErrors[]

object (RepositoryError)

Vom Connector gemeldeter Repository-Fehler.

ProcessingError

JSON-Darstellung
{
  "code": enum (ProcessingErrorCode),
  "errorMessage": string,
  "fieldViolations": [
    {
      object (FieldViolation)
    }
  ]
}
Felder
code

enum (ProcessingErrorCode)

Fehlercode, der die Art des Fehlers angibt.

errorMessage

string

Die Beschreibung des Fehlers.

fieldViolations[]

object (FieldViolation)

Falls die Artikelfelder ungültig sind, enthält dieses Feld Details zu den Validierungsfehlern.

ProcessingErrorCode

Codes zur Angabe des Fehlers, der während der Verarbeitung von Elementen durch den Cloud Search-Server aufgetreten ist. Ein einzelner Artikel kann mehrere Verarbeitungsfehler aufweisen.

Enums
PROCESSING_ERROR_CODE_UNSPECIFIED Nur Eingabewert. Verwenden Sie diesen Wert unter „Artikel“.
MALFORMED_REQUEST Die ACL, die Metadaten oder der Inhalt des Elements ist fehlerhaft oder ungültig. Feldverstoß enthält weitere Details zum Ort des Problems.
UNSUPPORTED_CONTENT_FORMAT Das Zählformat wird nicht unterstützt.
INDIRECT_BROKEN_ACL Elemente mit unvollständigen ACL-Informationen, weil andere Elemente mit einer fehlerhaften ACL übernommen wurden oder Gruppen mit nicht zugeordneten untergeordneten Elementen enthalten sind.
ACL_CYCLE Die ACL-Vererbungsgrafik bildete einen Zyklus.

FieldViolation

JSON-Darstellung
{
  "field": string,
  "description": string
}
Felder
field

string

Pfad des Felds mit dem Verstoß.

description

string

Die Beschreibung des Fehlers.

RepositoryError

Fehler, wenn der Connector mit dem Quell-Repository kommuniziert

JSON-Darstellung
{
  "type": enum (RepositoryError.Type),
  "httpStatusCode": integer,
  "errorMessage": string
}
Felder
type

enum (RepositoryError.Type)

Die Art des Fehlers.

httpStatusCode

integer

Fehlercodes. Stimmt mit der Definition der HTTP-Statuscodes überein.

errorMessage

string

Meldung, die den Fehler beschreibt. Die Nachricht darf maximal 8.192 Zeichen lang sein.

RepositoryError.Type

Liste der Fehlercodes für Kommunikationsprobleme mit dem Repository.

Enums
UNKNOWN Unbekannter Fehler.
NETWORK_ERROR Unbekannter oder nicht erreichbarer Host.
DNS_ERROR Ein DNS-Problem, z. B. dass der DNS-Server nicht reagiert.
CONNECTION_ERROR Verbindung zum Repository-Server kann nicht hergestellt werden.
AUTHENTICATION_ERROR Die Authentifizierung ist aufgrund falscher Anmeldedaten fehlgeschlagen.
AUTHORIZATION_ERROR Das Dienstkonto ist nicht für das Repository autorisiert.
SERVER_ERROR Repository-Serverfehler.
QUOTA_EXCEEDED Kontingent überschritten.
SERVICE_UNAVAILABLE Der Server ist vorübergehend nicht verfügbar.
CLIENT_ERROR Clientbezogener Fehler, z. B. eine ungültige Anfrage vom Connector an den Repository-Server.

Item.ItemType

Enums
UNSPECIFIED
CONTENT_ITEM Ein Artikel, der ausschließlich zur Bereitstellung von Informationen indexiert wurde. Auf diese Elemente kann nicht in den Feldern containerName oder inheritAclFrom verwiesen werden.
CONTAINER_ITEM Ein Element, das indexiert wird und dessen Zweck darin besteht, andere Elemente mit ACLs zu versorgen und/oder weitere Elemente zu enthalten.
VIRTUAL_CONTAINER_ITEM Ein Element, das nicht indexiert wird, aber ansonsten denselben Zweck wie CONTAINER_ITEM hat.

Methoden

delete

Löscht Item resource für den angegebenen Ressourcennamen.

deleteQueueItems

Löscht alle Elemente in einer Warteschlange.

get

Ruft Item resource nach Elementname ab.

index

Aktualisiert die ACL, Metadaten und Inhalte von Item.

list

Listet alle oder einen Teil von Item resources auf.

poll

Führt eine Abfrage auf nicht reservierte Elemente aus der Indexierungswarteschlange durch und markiert eine Gruppe als reserviert, wobei die Elemente mit dem ältesten Zeitstempel der höchsten Priorität (ItemStatus) beginnen.

push

Setzt ein Element zur späteren Abfrage und Aktualisierung in eine Warteschlange.

unreserve

Hebt die Reservierung aller Elemente in einer Warteschlange auf, sodass sie alle abgefragt werden können.

upload

Erstellt eine Upload-Sitzung für das Hochladen von Artikelinhalten