API zur Erfassung externer Inhalte

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 16 Minuten Lesedauer

    • Die API zur Erfassung externer Inhalte bietet Endpunkte, die die Erfassung von Inhalten aus Quellen außerhalb Ihrer Instanz ServiceNow® im Index der Anwendung ServiceNow® KI-Suche ermöglichen.

    API zur Erfassung externer Inhalte – DELETE /ais/external_content/deleteByQuery/{schema_table_name}

    Löscht alle externen Dokumente, die der angegebenen Abfrage entsprechen, aus dem Index KI-Suche.

    URL-Format

    URL mit Versionsangabe: /api/now/{api_version}/ais/external_content/deleteByQuery/{schema_table_name}?query={query}

    Hinweis:
    Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    schema_table_name

    Der Name der Schematabelle für externe Inhalte, die das Schema für die zu löschenden indizierten Dokumente definiert. Beispiel: u_ext_content.

    Datentyp: Zeichenfolge
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    query

    Eine gültige Abfrage mit URL-Escape-Zeichen für die durch schema_table_nameangegebene Schematabelle. Beispiel: title=Introduction für die Abfrage von Dokumenten mit dem Titel „ Einführung“.

    Datentyp: Zeichenfolge
    Tabelle : 3. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.

    Tabelle : 4. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 5. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodes der REST-API.

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    Fehler

    Objekt, das den Fehler beschreibt, der bei der Verarbeitung der Anforderung aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    Fehler.detail

    Details des Fehlers, der bei der Verarbeitung der Anforderung aufgetreten ist.

    Datentyp: Zeichenfolge
    Fehlernachricht

    Meldung für den Fehler, der bei der Verarbeitung der Anforderung aufgetreten ist.

    Datentyp: Zeichenfolge
    Ergebnis

    Ergebnis aus einer erfolgreich verarbeiteten Anforderung.

    Datentyp: Zeichenfolge
    status

    Status einer nicht erfolgreichen Anforderung.

    Gültige Werte:
    • failure

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Löschen Sie Dokumente mit Titelfeldwerten „Einführung“ und „Bericht“ für den 31. Oktober 2020 aus der Schematabelle „u_ext_content“.

    curl "https://instance.service-now.com/api/now/v2/ais/external_content/deleteByQuery/u_ext_content?query=title%3DIntroduction%20OR%20title%3DReport%20for%2031%20October%202020" \
--request DELETE \
--user "username":"password" \
--header "Accept: application/json"
    {
  "result": "Delete By Query Successfully Executed"
}

    API zur Erfassung externer Inhalte – DELETE /ais/external_content/deleteDocument/{schema_table_name}/{document_id}

    Löscht das externe Dokument mit einem angegebenen eindeutigen Bezeichner aus dem Index KI-Suche.

    URL-Format

    URL mit Versionsnummer: /api/now/{api_version}/ais/external_content/deleteDocument/{schema_table_name}/{document_id}

    Hinweis:
    Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

    Unterstützte Anforderungsparameter

    Tabelle : 7. Pfad-Parameter
    Parameter Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    document_id

    Der eindeutige Bezeichner für das zu löschende externe Dokument. Beispiel: ADMIN-2027858531-16.

    Datentyp: Zeichenfolge
    schema_table_name

    Der Name der Schematabelle für externe Inhalte, die das Schema für das zu löschende indizierte Dokument definiert. Beispiel: u_ext_content.

    Datentyp: Zeichenfolge
    Tabelle : 8. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 9. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.

    Tabelle : 10. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 11. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodes der REST-API.

    Tabelle : 12. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antworttexts (JSON oder XML)

    Element Beschreibung
    Fehler

    Objekt, das den Fehler beschreibt, der bei der Verarbeitung der Anforderung aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    Fehler.detail

    Details des Fehlers, der bei der Verarbeitung der Anforderung aufgetreten ist.

    Datentyp: Zeichenfolge
    Fehlernachricht

    Meldung für den Fehler, der bei der Verarbeitung der Anforderung aufgetreten ist.

    Datentyp: Zeichenfolge
    Ergebnis

    Ergebnis aus einer erfolgreich verarbeiteten Anforderung.

    Datentyp: Zeichenfolge
    status

    Status einer nicht erfolgreichen Anforderung.

    Gültige Werte:
    • failure

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Löschen Sie das Dokument mit dem Bezeichner ADMIN-2587918521-27 aus der Schematabelle „u_ext_content“.

    curl 'https://instance.service-now.com/api/now/v2/ais/external_content/deleteDocument/u_ext_content/ADMIN-2587918521-27' \
--request DELETE \
--user 'username':'password' \
--header 'Accept: application/json'
    {
  "result":"Document removed"
}

    API zur Erfassung externer Inhalte – POST /ais/external_content/ingestDocument/{schema_table_name}

    Sendet eine Liste externer Dokumente zur Indizierung an den Erfassungsbatcher KI-Suche. Nach Abschluss der Indizierung werden Inhalte aus den erfassten Dokumenten durchsuchbar.

    Sie können diesen Endpunkt verwenden, um externe Dokumente mit Textinhalten und Metadaten zu ernähren.

    Wenn Sie durchsuchbaren binären Inhalt und Metadaten einem externen Dokument zuordnen müssen, führen Sie diese Schritte aus:
    1. Speichern Sie den binären Inhalt in KI-Suche mit dem POST-Endpunkt /ais/external_content/storeContent. Notieren Sie den Wert des Parameters „Antworttextkörper result “ .
    2. Senden Sie das externe Dokument mit diesem Endpunkt an KI-Suche. Legen Sie den Anforderungstextparameter des Dokuments content_pointer so fest, dass er dem aufgezeichneten Wert des Antworttextkörperparameters result entspricht.
    Während der Erfassung analysiert KI-Suche den binären Inhalt und fügt den durchsuchbaren Inhalt dem indizierten Datensatz hinzu, der das externe Dokument darstellt. Bei der Analyse wird das gespeicherte Inhaltsobjekt entfernt.

    URL-Format

    URL mit Versionsangabe: /api/now/{api_version}/ais/external_content/ingestDocument/{schema_table_name}

    Hinweis:
    Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

    Unterstützte Anforderungsparameter

    Tabelle : 13. Pfad-Parameter
    Parameter Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    schema_table_name

    Der Name der Schematabelle für externe Inhalte, die das Schema für externe Dokumente in der Anforderung definiert. Beispiel: u_ext_content.

    Datentyp: Zeichenfolge
    Tabelle : 14. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 15. Anforderungstextparameter (XML oder JSON)
    Element Beschreibung
    [Array]

    Erforderlich. Unbenanntes Array von Objekten, in dem jedes Objekt ein externes Dokument darstellt, das für die Indizierung erfasst werden soll.

    Datentyp: Array

    [
  {
    "content_pointer": "String",
    "document_id": "String",
    "principals": {Object},
    "properties": {Object}
  }
]
    [Array].content_pointer
    Bezeichner für eine Instanz von binärem Inhalt, der mit dem POST /ais/external_content/storeContent -Endpunkt gespeichert wird. Während der Erfassung analysiert KI-Suche den binären Inhalt und fügt den durchsuchbaren Inhalt dem indizierten Datensatz hinzu, der das externe Dokument darstellt. Bei der Analyse wird das gespeicherte Inhaltsobjekt entfernt.
    Hinweis:
    Dieser Bezeichner muss mit dem vom Endpunkt „storeContent“ zurückgegebenen Element des Antworttexts result übereinstimmen.

    Datentyp: Zeichenfolge
    [array].document_id

    Erforderlich. Eindeutiger Bezeichner für das externe Dokument in der Schematabelle für externe Inhalte, die durch den Pfadparameter schema_table_name angegeben wird.

    Hinweis:
    Wenn Sie ein Dokument erfassen, überschreibt es alle vorhandenen Dokumente in derselben Tabelle mit externen Inhaltsschemas, die den gleichen document_idaufweisen. Wenn zwei oder mehr Dokumente in derselben Erfassungsanforderung den gleichen document_idhaben, schlägt die Anforderung fehl.

    Datentyp: Zeichenfolge
    [array].principals
    Objekt mit Schlüssel-Wert-Paaren, die die Zugriffsberechtigungen des externen Dokuments für extern definierte Sicherheitsprinzipale (Anwender und Gruppen) beschreiben.
    Hinweis:

    Wenn Sie diesen Parameter für ein Dokument auslassen, ist die Anforderung erfolgreich, KI-Suche lehnt das Dokument jedoch mit der Erfassungsfeedback-Nachricht ab Der Prinzipal des Dokuments fehlt.

    Wenn dieses Parameterobjekt keine Schlüssel-Wert-Paare enthält, die den Zugriff auf ein Dokument gewähren, ist die Anforderung erfolgreich, KI-Suche lehnt das Dokument jedoch mit der Meldung „Das Prinzipal des Dokuments ist ungültig“ab.

    Datentyp: Objekt

    "principals": {
  "everyone": Boolean,
  "groups.deny": [Array],
  "groups.read": [Array],
  "none": Boolean,
  "users.deny": [Array],
  "users.read": [Array]
}

    Unterstützte Versionen: Verfügbar ab Version 2 der API.
    [array].principals.eacher
    Kennzeichnung, die angibt, ob der Zugriff auf das externe Dokument für alle Anwender zulässig ist. Wenn dieser Parameter auf truefestgelegt ist, können alle Anwender Now Platform den indizierten Datensatz anzeigen, der aus dem Dokument erstellt wurde.
    Hinweis:
    Wenn Sie sowohl diesen Parameter als auch [array].principals.none für ein Dokument auf true festlegen, ist die Anforderung erfolgreich, KI-Suche lehnt das Dokument jedoch mit einer Erfassungsfeedback-Nachricht ab . Der Prinzipal des Dokuments ist ungültig. Sie können nur einen dieser beiden Parameter in einer Anforderung auf true festlegen.
    Gültige Werte:
    • true: Zugriff auf das Dokument für alle Anwender zulassen. KI-Suche ignoriert alle [array].principals.groups.* - und [array].principals.users.* -Parametereinstellungen für das Dokument.
    • false: Nicht allen Anwendern Zugriff auf das externe Dokument erlauben. Anwender können nur auf das Dokument zugreifen, wenn [array].principals.none auf „false“ festgelegt ist und die Interaktion ihrer Anwenderzuordnungen mit den Parametern [array].principals.groups.* und [array].principals.users.* dies zulässt.

    Datentyp: Boolesch

    Standard: true

    Unterstützte Versionen: Verfügbar ab Version 2 der API.
    [array].principals.groups.deny

    Array von Zeichenfolgen, wobei jede Zeichenfolge der Name einer extern definierten Gruppe ist, die keinen Zugriff auf das externe Dokument hat. Now Platform Anwender, die einer dieser externen Gruppen zugeordnet sind, können den indizierten Suchergebnisdatensatz, der aus dem Dokument erstellt wurde, nicht anzeigen.

    Wenn entweder [array].principals.everyone oder [array].principals.none auf truefestgelegt ist, hat dieser Parameter keine Auswirkung.

    Dieser Parameter hat Vorrang vor [array].principals.groups.read. Wenn derselbe Benutzer externen Gruppen mit Zugriffsberechtigungen zum Lesen und Verweigern des Zugriffs auf ein Dokument zugeordnet ist, verweigert KI-Suche diesem Benutzer den Zugriff auf den indizierten Datensatz.

    Standardmäßig hat [array].principals.users.read Vorrang vor diesem Parameter. Um diese Rangfolge für eine indizierte Quelle umzukehren, lesen Sie bitte Rangfolge der Lese- und Gruppenablehnungsberechtigungen von Anwendern für eine indizierte Quelle für externen Inhalt ändern..

    Datentyp: Array

    Die Werte können ein beliebiges Format haben, abhängig von den Namen der angegebenen extern definierten Gruppen. Beispiele:

    "groups.deny": [
  "hr-admin",
  "legal"
]

    Unterstützte Versionen: Verfügbar ab Version 2 der API.
    [array].principals.groups.read

    Array von Zeichenfolgen, wobei jede Zeichenfolge der Name einer extern definierten Gruppe ist, die auf das externe Dokument zugreifen darf. Now Platform Benutzer, die einer dieser externen Gruppen zugeordnet sind, können den indizierten Suchergebnisdatensatz anzeigen, der aus dem Dokument erstellt wurde.

    Wenn entweder [array].principals.everyone oder [array].principals.none auf truefestgelegt ist, hat dieser Parameter keine Auswirkung.

    [array].principals.groups.deny hat Vorrang vor diesem Parameter. Wenn derselbe Benutzer externen Gruppen mit Zugriffsberechtigungen zum Lesen und Verweigern des Zugriffs auf ein Dokument zugeordnet ist, verweigert KI-Suche diesem Benutzer den Zugriff auf den indizierten Datensatz.

    Datentyp: Array

    Die Werte können ein beliebiges Format haben, abhängig von den Namen der angegebenen extern definierten Gruppen. Beispiele:

    "groups.read": [
  "devops",
  "it",
  "report-admins"
]

    Unterstützte Versionen: Verfügbar ab Version 2 der API.
    [array].principals.none
    Boolesche Option, die angibt, ob der Zugriff auf das externe Dokument für alle Anwender verweigert wird. Wenn dieser Parameter auf truefestgelegt ist, können nur Benutzer vom Typ Now Platform mit der Rolle ais_high_security_admin mit erweiterten Berechtigungen den aus dem Dokument erstellten indizierten Datensatz anzeigen.
    Hinweis:
    Wenn Sie sowohl diesen Parameter als auch [array].principals.everyone für ein Dokument auf true festlegen, lehnt KI-Suche das Dokument während der Erfassung mit der Fehlermeldung Das Prinzipal des Dokuments ist ungültig ab. Sie können nur einen dieser beiden Parameter in einer Anforderung auf true festlegen.
    Gültige Werte:
    • true: Verweigert den Zugriff auf das Dokument für alle Anwender, mit Ausnahme der Anwender mit der Rolle ais_high_security_admin mit erweiterten Berechtigungen. KI-Suche ignoriert alle [array].principals.groups.* - und [array].principals.users.* -Parametereinstellungen für das Dokument.
    • false: Zugriff auf das Dokument nicht für alle Anwender verweigern. Benutzer können auf das Dokument zugreifen, wenn [array].principals.everyone auf truefestgelegt ist oder wenn die Interaktion ihrer Benutzerzuordnungen und die Parameter [array].principals.groups.read und [array].principals.users.read dies zulassen.

    Datentyp: Boolesch

    Standard: false

    Unterstützte Versionen: Verfügbar ab Version 2 der API.
    [array].principals.users.deny

    Array von Zeichenfolgen, wobei jede Zeichenfolge der Name eines extern definierten Anwenders ist, dem der Zugriff auf das externe Dokument verweigert wird. Now Platform Anwender, die einem dieser externen Anwender zugeordnet sind, können den indizierten Suchergebnisdatensatz, der aus dem Dokument erstellt wurde, nicht anzeigen.

    Wenn entweder [array].principals.everyone oder [array].principals.none auf truefestgelegt ist, hat dieser Parameter keine Auswirkung.

    Dieser Parameter hat Vorrang vor [array].principals.users.read. Wenn derselbe Benutzer externen Benutzern zugeordnet ist, die über Zugriffsberechtigungen zum Lesen und Verweigern des Zugriffs für ein Dokument verfügen, verweigert KI-Suche diesem Benutzer den Zugriff auf den indizierten Datensatz.

    Datentyp: Array

    Die Werte können in einem beliebigen Format vorliegen, abhängig von den Namen der angegebenen extern definierten Anwender. Beispiele:

    "users.deny": [
  "ad\bow-ruggeri",
  "abel-tuter@sharepoint"
]

    Unterstützte Versionen: Verfügbar ab Version 2 der API.
    [array].principals.users.read

    Array von Zeichenfolgen, wobei jede Zeichenfolge der Name eines extern definierten Anwenders ist, der auf das externe Dokument zugreifen darf. Now Platform -Benutzer, die einem dieser externen Benutzer zugeordnet sind, können den indizierten Suchergebnis-Datensatz anzeigen, der aus dem Dokument erstellt wurde.

    Wenn entweder [array].principals.everyone oder [array].principals.none auf truefestgelegt ist, hat dieser Parameter keine Auswirkung.

    [array].principals.users.deny hat Vorrang vor diesem Parameter. Wenn derselbe Benutzer externen Benutzern zugeordnet ist, die über Zugriffsberechtigungen zum Lesen und Verweigern des Zugriffs für ein Dokument verfügen, verweigert KI-Suche diesem Benutzer den Zugriff auf den indizierten Datensatz.

    Standardmäßig hat dieser Parameter Vorrang vor [array].principals.groups.deny. Um diese Rangfolge für eine indizierte Quelle umzukehren, lesen Sie bitte Rangfolge der Lese- und Gruppenablehnungsberechtigungen von Anwendern für eine indizierte Quelle für externen Inhalt ändern..

    Datentyp: Array

    Die Werte können in einem beliebigen Format vorliegen, abhängig von den Namen der angegebenen extern definierten Anwender. Beispiele:

    "users.read": [
  "ad\abel-tuter",
  "beth-anglin@sharepoint"
]

    Unterstützte Versionen: Verfügbar ab Version 2 der API.
    [array].properties

    Objekt, das Name/Wert-Paare enthält, wobei jedes Paar einen Feldnamen und einen Wert darstellt, die für das Dokument erfasst werden sollen. Alle Feldnamen und -werte müssen als Zeichenfolgen angegeben werden.

    Nach der Erfassung sind diese Dokumentfeldwerte über die indizierte Quelle zugänglich, die für die durch den Pfadparameter schema_table_name angegebene externe Inhaltsschematabelle definiert ist. Anwender können nach diesen Feldwerten in Suchquellen suchen, die von dieser indizierten Quelle abgeleitet sind.

    Datentyp: Objekt

    Feldnamen dürfen nur Kleinbuchstaben und Unterstriche enthalten. Werte können beliebige Zeichen enthalten. Die Wertlänge wird durch das Attribut max_length begrenzt, das für das Feld in der Schematabelle für externe Inhalte definiert ist. Beispiele für Feldname-Wert-Paare sind unter anderem:

    "properties": {
  "creation_date": "2020-11-03 12:27:43",
  "file_size": "10285",
  "title": "Introduction",
  "url": "file:///myhost/reports/Introduction.pdf"
}

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.

    Tabelle : 16. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 17. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodes der REST-API.

    Tabelle : 18. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    202 Teilweiser Erfolg. Die Anforderung wurde verarbeitet. Einige Dokumente enthalten Warn- oder Fehlermeldungen zur Erfassung des Feedbacks.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    Fehler

    Objekt, das den Fehler beschreibt, der bei der Verarbeitung der Anforderung aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    Fehler.detail

    Details des Fehlers, der bei der Verarbeitung der Anforderung aufgetreten ist.

    Datentyp: Zeichenfolge
    Fehlernachricht

    Meldung für den Fehler, der bei der Verarbeitung der Anforderung aufgetreten ist.

    Datentyp: Zeichenfolge
    Ergebnis

    JSON-formatierte Zeichenfolge, die das Ergebnisobjekt für die Erfassungsanforderung darstellt.

    Datentyp: Zeichenfolge

    "result": "{\"duration_in_ms\": Number, \"feedback\": [Array] }"
    result.duration_in_ms

    Zeit, die für die Erfassung der externen Dokumente aufgewendet wurde.

    Datentyp: Zahl

    Einheit: Millisekunden
    result.feedback

    Array von Objekten, in dem jedes Objekt Feedback für ein vom Anforderungstext erfasstes Dokument darstellt.

    Datentyp: Array

    "feedback": [
  {
    "document_id": "String",
    "messages": [Array]
  }
]
    result.feedback.document_id

    Eindeutiger Bezeichner für das externe Dokument, wie im Anforderungstext angegeben.

    Datentyp: Zeichenfolge
    Ergebnis.Feedback.Nachrichten

    Array von unbenannten Objekten, in dem jedes Objekt eine Erfassungsfeedbacknachricht darstellt, die während der Indizierung des externen Dokuments protokolliert wurde.

    Datentyp: Array

    "messages": [
  {
    "code": "String",
    "component": "String",
    "level": "String",
    "message": "String"
  }
]
    Ergebnis.Feedback.Nachrichten.Code

    Code für eine Ausnahme, die von der Indexierungs-Workflow-Komponente ausgelöst wird, die die Feedback-Nachricht zur Erfassung protokolliert hat.

    Datentyp: Zeichenfolge
    result.feedback.messages.component

    Bezeichner für die Indexierungs-Workflow-Komponente, die die Nachricht zum Erfassungsfeedback protokolliert hat.

    Datentyp: Zeichenfolge
    Ergebnis.Feedback.Nachrichten.Ebene

    Protokollierungsebene für die Feedback-Nachricht zur Erfassung.

    Gültige Werte:
    • ERROR
    • INFO
    • MINOR_ERROR
    • WARN

    Datentyp: Zeichenfolge
    Ergebnis.Feedback.Nachrichten.Nachricht

    Text, der für die Nachricht zum Erfassungsfeedback protokolliert wird.

    Datentyp: Zeichenfolge
    status

    Status einer nicht erfolgreichen Anforderung.

    Gültige Werte:
    • failure

    Datentyp: Zeichenfolge

    Rangfolge für Prinzipalberechtigungen

    Die Rangfolge für die Berechtigungen [array].principals hängt vom Wert des Attributs user_read_takes_precedence_over_group_deny für die indizierte Quelle ab, die zum Erfassen eines externen Dokuments verwendet wird.
    Attributwert Rangfolge für Prinzipalberechtigungen
    wahr
    Von der höchsten zur niedrigsten Priorität:
    1. [array].principals.everyone, [array].principals.none
    2. [array].principals.users.deny
    3. [array].principals.users.read
    4. [array].principals.groups.deny
    5. [array].principals.groups.read
    Hinweis:
    Dies ist der Standardattributwert für indizierte Quellen für externen Inhalt.
    falsch
    Von der höchsten zur niedrigsten Priorität:
    1. [array].principals.everyone, [array].principals.none
    2. [array].principals.users.deny, [array].principals.groups.deny
    3. [array].principals.users.read, [array].principals.groups.read
    Hinweis:
    Anweisungen zum Festlegen dieses Attributwerts finden Sie unter Rangfolge der Lese- und Gruppenablehnungsberechtigungen von Anwendern für eine indizierte externe Inhaltsquelle ändern.

    cURL-Anforderung

    Feed zwei externe Dokumente (mit Inhaltszeigern auf binäre Inhaltsobjekte, die zuvor mit dem POST /ais/external_content/storeContent -Endpunkt gespeichert wurden) zur Indizierung in die Schematabelle „u_ext_content“.

    curl 'https://instance.servicenow.com/api/now/v2/ais/external_content/ingestDocument/u_ext_content' \
  --request POST \
  --user 'username':'password' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "document_id": "ADMIN-2027858531-16",
    "content_pointer": "749b52a1-baa8-4556-a4f3-00404c95e6a8",
    "properties": {
      "title": "Introduction",
      "url": "file:///myhost/reports/Introduction.pdf",
      "file_name": "Introduction.pdf",
      "file_size": "10285",
      "creation_date": "2020-11-01 12:27:43"
    },
    "principals": {
      "everyone": false,
      "groups.read": [
        "report-users",
        "report-admins"
      ],
      "users.deny": [
        "ad\abel-tuter"
      ]
    }
  },
  {
    "document_id": "ADMIN-2587918521-27",
    "content_pointer": "bd605435-268b-464f-a7c3-0c5ea894a5c2",
    "properties": {
      "title": "Report for 31 August 2020",
      "url": "file:///myhost/reports/Report-2020-08-31.pdf",
      "file_size": "27597",
      "creation_date": "2020-09-01 12:48:13"
    },
    "principals": {
      "everyone": false,
      "groups.read": [
        "report-users",
        "report-admins"
      ],
      "users.read": [
        "ad\beth-anglin"
      ]
    }
  }
]'
    {
  "result":"{\"duration_in_ms\":3822,\"feedback\":[{\"messages\":[{\"level\":\"INFO\",\"message\":\"CREATED\",\"component\":\"init\"},{\"level\":\"INFO\",\"message\":\"OK\",\"component\":\"index-886de18e750030108b23bcd69cdc2dd3-indexer.index-886de18e750030108b23bcd69cdc2dd3-content-dispatcher\"},{\"level\":\"INFO\",\"message\":\"COMPLETED\",\"component\":\"sink.sink\"}],\"document_id\":\"ADMIN-2027858531-16\"},{\"messages\":[{\"level\":\"INFO\",\"message\":\"CREATED\",\"component\":\"init\"},{\"level\":\"WARN\",\"message\":\"field \\u0027text\\u0027 tokens exceed index.maxTokens\",\"code\":\"INDEX_ENGINE-32\",\"component\":\"ingestGlideDocument.standardAnalyzer\"},{\"level\":\"INFO\",\"message\":\"OK\",\"component\":\"index-886de18e750030108b23bcd69cdc2dd3-indexer.index-886de18e750030108b23bcd69cdc2dd3-content-dispatcher\"},{\"level\":\"INFO\",\"message\":\"COMPLETED\",\"component\":\"sink.sink\"}],\"document_id\":\"ADMIN-2587918521-27\"}]}"
}

    API zur Erfassung externer Inhalte: POST ais/external_content/storeContent

    Speichert binären Inhalt als Inhaltsobjekt in KI-Suche.

    Sie können gespeicherte binäre Inhalte einem externen Dokument zuordnen, indem Sie die folgenden Schritte ausführen:
    1. Speichern Sie den binären Inhalt mit diesem Endpunkt. Notieren Sie den Wert des Parameters „Antworttextkörper result “ .
    2. Senden Sie das externe Dokument mit dem Endpunkt POST /ais/external_content/ingestDocument/{schema_table_name} an KI-Suche. Legen Sie den Anforderungstextparameter des Dokuments content_pointer so fest, dass er dem aufgezeichneten Wert des Antworttextkörperparameters result entspricht.
    Während der Erfassung analysiert KI-Suche den binären Inhalt und fügt den durchsuchbaren Inhalt dem indizierten Datensatz hinzu, der das externe Dokument darstellt. Bei der Analyse wird das gespeicherte Inhaltsobjekt entfernt.

    URL-Format

    URL mit Versionsnummer: /api/now/{api_version}/ais/external_content/storeContent

    Hinweis:
    Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

    Unterstützte Anforderungsparameter

    Tabelle : 19. Pfad-Parameter
    Parameter Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 20. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 21. Anforderungstextparameter
    Element Beschreibung
    [Binärdaten] Erforderlich. Binärinhalt, der als Inhaltsobjekt in KI-Suchegespeichert werden soll.

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.

    Tabelle : 22. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Inhaltstyp

    Datenformat des Anforderungstexts.

    Gültige Werte:
    • application/msword
    • application/octet-stream
    • application/pdf
    • application/vnd.ms-excel
    • application/vnd.ms-powerpoint
    • application/vnd.ms-powerpoint.presentation.macroenabled.12
    • application/vnd.openxmlformats-officedocument.presentationml.presentation
    • application/vnd.openxmlformats-officedocument.presentationml.template
    • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
    • application/vnd.openxmlformats-officedocument.wordprocessingml.document
    • application/vnd.openxmlformats-officedocument.wordprocessingml.template
    • text/html
    • text/plain
    Tabelle : 23. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodes der REST-API.

    Tabelle : 24. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antworttexts (JSON oder XML)

    Element Beschreibung
    Fehler

    Objekt, das den Fehler beschreibt, der bei der Verarbeitung der Anforderung aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    Fehler.detail

    Details des Fehlers, der bei der Verarbeitung der Anforderung aufgetreten ist.

    Datentyp: Zeichenfolge
    Fehlernachricht

    Meldung für den Fehler, der bei der Verarbeitung der Anforderung aufgetreten ist.

    Datentyp: Zeichenfolge
    Ergebnis

    Bezeichner für das Objekt mit binärem Inhalt, das durch eine erfolgreiche Anforderung gespeichert wurde.

    Datentyp: Zeichenfolge

    "result" : "91841766-2a5f-4c64-a20a-27ca485eca21"
    Hinweis:
    Um den gespeicherten Inhalt an ein erfasstes externes Dokument anzuhängen, geben Sie diesen Bezeichner als Anforderungstextelement content_pointer für eine Anforderung an den Endpunkt „ingestDocument“ an.
    status

    Status einer nicht erfolgreichen Anforderung.

    Gültige Werte:
    • failure

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Speichern Sie binären Inhalt für eine PDF-Datei als Inhaltsobjekt.

    curl 'https://instance.servicenow.com/api/now/v2/ais/external_content/storeContent' \
--request POST \
--user 'username':'password' \
--header 'Content-Type: application/pdf' \
--data-binary '@Report-2020-08-31.pdf'

    Der Antworttext enthält den eindeutigen Bezeichner für das neue Inhaltsobjekt.

    {
  "result" : "fb439a4f-62ad-4dab-9654-5088d99a6ff9"
}