---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# KI-Suche API für externe Anwenderzuordnung

# KI-Suche API für externe Anwenderzuordnung {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 4 Minuten Lesedauer

Die KI-Suche -- Zuordnung externer Anwender Die API stellt Endpunkte bereit, die die Erfassung von Anwenderzuordnungsinformationen aus externen Quellen in ermöglichen ServiceNow® KI-SucheIndex der Anwendung.

## KI-Suche Externe Anwenderzuordnung -- POSTEN SIE /ais/external_content/user_Mapping/Import_multiple/{target_table} {#ariaid-title2}

Importiert eine Liste externer Anwenderzuordnungen in KI-SucheAnwenderzuordnungstabelle. Jede Zuordnung gibt extern definierte Anwender- und Gruppenaliasse für an Now PlatformAnwender. KI-SucheVerwendet diese Aliasse, um zu bestimmen, welche Ergebnisse der externen Dokumentsuche der Anwender anzeigen kann.
Um zu erfahren, wie KI-SucheDie Sicherheit externer Inhalte verwendet externe Anwenderzuordnungen, siehe [Sicherheit externer Inhalte für die KI-Suche](https://www.servicenow.com/docs/access?context=external-content-security-ais&version=yokohama&pubname=yokohama-platform-administration&ft:locale=en-US).

Anwender- und Gruppennamen in externen Anwenderzuordnungen müssen mit denen übereinstimmen, die in den Sicherheitszugriffsberechtigungen für externe Dokumente angegeben sind, die über erfasst werden Erfassung Externer Inhalte APIs VERÖFFENTLICHEN SIE /ais/external_content/ingestDocument/{Schema_table_Name} Endpunkt. Weitere Informationen zum Erfassen externer Dokumente mit Sicherheitszugriffsberechtigungen für extern definierte Anwender und Gruppen finden Sie unter [API zur Erfassung externer Inhalte](https://servicenow-prod.fluidtopics.net/mbL9igQdByVY6DWzJIJD2Q#external-content-ingestion-api "Die Erfassung Externer Inhalte Die API stellt Endpunkte bereit, die die Erfassung von Inhalten aus Quellen außerhalb von ermöglichen ServiceNowInstanz in ServiceNow KI-SucheIndex der Anwendung.").

Um Importverläufe für externe Anwenderzuordnungsdatensätze anzuzeigen, die über diesen Endpunkt importiert wurden, navigieren Sie zu KI-SucheExterner InhaltImportverlauf von Anwenderzuordnungenan. In einem Verlaufsdatensatz können Sie die Datensätze Importsatz \[sys_Import_Set\] und Mehrfachimportsatz \[sys_multi_import_set\] für eine Importaufgabe anzeigen. Verwenden Sie Informationen aus diesen Datensätzen, um sicherzustellen, dass Ihre externen Anwenderzuordnungen korrekt importiert wurden.

### URL-Format

Versionierte URL: /api/now/{api_Version}/ais/external_content/user_Mapping/Import_multiple/{target_table}  
Hinweis:  
Verfügbare Versionen werden in angegeben [REST-API-Explorer](https://servicenow-prod.fluidtopics.net/QZyr9s_~V0xB9fqGOlvJ4A "In diesem Tutorial verwenden Sie den REST API Explorer, um zu testen ServiceNowREST-APIs."). Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf [Geskriptetes REST-Service-Formular](https://servicenow-prod.fluidtopics.net/0V9QfkPsOI5r~YAD7CJWCA "Mit der geskripteten REST-API-Funktion können Anwendungsentwickler anwenderdefinierte Webservice-APIs erstellen.").

### Unterstützte Anforderungsparameter

{#ext_user_map-POST-import_multiple__entry__2}{#ext_user_map-POST-import_multiple__version-not_optional-RESTAPI}

| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: <kbd class="ph userinput">v1 </kbd>Oder <kbd class="ph userinput">v2 </kbd>. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| target_table | Der Name von KI-SucheAnwenderzuordnungstabelle, in der die importierten Zuordnungen angezeigt werden sollen. Beispiel: <kbd class="ph userinput">X_snc_sharepoint_user_table </kbd>. Hinweis: Sie müssen das Ziel erstellen KI-SucheAnwenderzuordnungstabelle über KI-SucheExterner InhaltAnwenderzuordnung erstellen Modul, bevor dieser Endpunkt verwendet wird. Wenn Sie eine Anwenderzuordnungstabelle angeben, die nicht vorhanden ist, schlägt die Anforderung fehl. Datentyp: Zeichenfolge |
[Tabelle : 1. Pfad-Parameter]

{#ext_user_map-POST-import_multiple__entry__8}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 2. Abfrageparameter]

{#ext_user_map-POST-import_multiple__entry__12}

| Name | Beschreibung |
|-|-|
| {Object} | Erforderlich. Unbenanntes Objekt. Datentyp: Objekt { "records": [Array] } |
| {Object}.Records | Erforderlich. Array von Objekten, in denen jedes Objekt eine Anwenderzuordnung darstellt, die in die angegebene Zieltabelle importiert werden soll. Datentyp: Array "records": [ { "external_group": [Array], "external_user": [Array], "mapping_value": "String" } ] |
| {Object}.Records.external_Group | Array von Zeichenfolgen, wobei jede Zeichenfolge der Name einer extern definierten Gruppe ist, die als Alias für festgelegt werden soll Now PlatformAnwender angegeben von {Object}.Records.Mapping_value Parameter. Datentyp: Array Werte können in einem beliebigen Format vorliegen, abhängig von den Namen der extern definierten Gruppen, die für die Anwenderzuordnung ausgewählt sind. Beispiele: "external_group": [ "itil", "hr-admin", "report-dev" ] |
| {Object}.Records.external_user | Array von Zeichenfolgen, wobei jede Zeichenfolge der Name eines extern definierten Anwenders ist, der als Alias für festgelegt werden soll Now PlatformAnwender angegeben von {Object}.Records.Mapping_value Parameter. Datentyp: Array Werte können in einem beliebigen Format vorliegen, abhängig von den Namen der extern definierten Anwenderaccounts, die für die Anwenderzuordnung ausgewählt wurden. Beispiele: "external_user": [ "beth-anglin", "ad\beth.anglin", "beth-anglin@sharepoint" ] |
| {Object}.Records.Mapping_value | E-Mail Feldwert, der einen vorhandenen Datensatz eindeutig identifiziert. Alle extern definierten Anwender- und Gruppenaliasse in der Anforderung werden zugeordnet Now PlatformAnwender mit dieser E-Mail-Adresse. Hinweis: Die API behandelt diesen Parameter als eindeutigen Bezeichner für den Anwenderzuordnungsdatensatz. Wenn Sie eine andere Anwenderzuordnung mit derselben importieren Mapping_value Als vorhandener Anwenderzuordnungsdatensatz überschreibt der neue Datensatz den vorhandenen Datensatz. Datentyp: Zeichenfolge Tabelle: Anwender \[sys_user\] |
[Tabelle : 3. Anforderungstext-Parameter (XML oder JSON)]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#ext_user_map-POST-import_multiple__entry__24}{#ext_user_map-POST-import_multiple__accept-JSON-only-entry-RESTAPI}{#ext_user_map-POST-import_multiple__content_type-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
| Inhaltstyp | Datenformat des Anforderungstexts. Nur unterstützt application/json. |
[Tabelle : 4. Anforderungskopfzeilen.]

{#ext_user_map-POST-import_multiple__entry__30}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 5. Antwort-Header]

### 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 [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#ext_user_map-POST-import_multiple__entry__34}{#ext_user_map-POST-import_multiple__entry-400-status-code}{#ext_user_map-POST-import_multiple__entry-500-status-code}

| Statuscode | Beschreibung |
|-|-|
| 201 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
[Tabelle : 6. Statuscodes]

### Antworttext-Parameter (JSON oder XML)

{#ext_user_map-POST-import_multiple__entry__42}

| Name | Beschreibung |
|-|-|
| Fehler | Objekt, das den Fehler während der Verarbeitung der Anforderung beschreibt. Datentyp: Objekt "error": { "detail": "String", "message": "String" } |
| error.detail | Details des bei der Verarbeitung der Anforderung aufgetretenen Fehlers. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Nachricht für den Fehler, der während der Verarbeitung der Anforderung aufgetreten ist. Datentyp: Zeichenfolge |
| import_set_id | SYS_ID für den neuen Datensatz, der in der Tabelle „Importsatz" \[sys_Import_Set\] durch eine erfolgreiche Anforderung erstellt wurde. Datentyp: Zeichenfolge |
| multi_import_set_id | SYS_ID für den neuen Datensatz, der durch eine erfolgreiche Anforderung in der Tabelle „Mehrfachimportsatz" \[sys_multi_import_set\] erstellt wurde. Datentyp: Zeichenfolge |
| Ergebnis | Ergebnis für eine nicht erfolgreiche Anforderung. Enthält eine Nachricht, die den Grund für den Anforderungsfehler beschreibt. Datentyp: Zeichenfolge |
| Status | Status einer nicht erfolgreichen Anforderung. Gültige Werte: * failure {#ext_user_map-POST-import_multiple__ul_h5r_z54_pnb} Datentyp: Zeichenfolge |
[ ]

### Curl-Anforderung

Importieren Sie extern definierte Anwender- und Gruppenaliasse für Now PlatformAnwender beten Anglin und Abel Tuter in einen KI-SucheAnwenderzuordnungstabelle mit dem Namen x_snc_sharepoint_user_table.

    curl -X POST 'https://instance.servicenow.com/api/now/v1/ais/external_content/user_mapping/import_multiple/x_snc_sharepoint_user_table' \
      -H 'Accept: application/json' \
      -H 'Content-Type: application/json' \
      -u 'username':'password' \
      -d '{
        "records": [
          {
            "mapping_value": "beth.anglin@example.com",
            "external_user": [
              "ad\beth-anglin",
              "beth.anglin@sharepoint"
            ],
            "external_group": [
              "itil",
              "itil-admin",
              "itil-dev"
            ]
          },
          {
            "mapping_value": "abel.tuter@example.com",
            "external_user": [
              "ad\abel-tuter",
              "abel.tuter@sharepoint"
            ],
            "external_group": [
              "hr",
              "hr-admin",
              "hr-dev"
            ]
          }
        ]
      }'

Die Antwort zeigt die sys_IDs für die generierten Importsatz- und Multi-Importsatz-Datensätze an.

    {
      "import_set_id": "6e9ddb629d987010f877878bd9f0e9dd",
      "multi_import_set_id": "269ddb629d987010f877878bd9f0e9de"
    }

### Curl-Anforderung {#ext_user_map-POST-import_multiple__example_qz3_1pz_spb}

Ungültige Anforderung importieren, die einen leeren Zuordnungsdatensatz enthält.

    curl 'https://instance.servicenow.com/api/now/v1/ais/external_content/user_mapping/import_multiple/u_ext_content_user_mapping' \
      --request POST \
      --user 'username':'password' \
      --header 'Accept: application/json' \
      --header 'Content-Type: application/json' \
      --data '{
        "records": [
          {
            "mapping_value": "beth.anglin@example.com",
            "external_user": [
              "ad\beth-anglin",
              "beth.anglin@sharepoint"
            ],
            "external_group": [
              "reports",
              "reports-admin",
              "reports-dev"
            ]
          },
          {}
        ]
      }'

Die Anforderung schlägt mit dem Status 400 fehl, und die Antwort gibt die Art des Fehlers an.

    {
      "result": "Error in processing the message"
    }


