KI-Suche API für externe Anwenderzuordnung

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 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-Suche Index der Anwendung.

    KI-Suche Externe Anwenderzuordnung: VERÖFFENTLICHEN SIE /ais/external_content/user_Mapping/Import_multiple/{target_table}

    Importiert eine Liste externer Anwenderzuordnungen in einen KI-Suche Anwenderzuordnungstabelle. Jede Zuordnung gibt extern definierte Anwender- und Gruppenaliasse für ein an ServiceNow AI Platform Anwender. KI-Suche Verwendet diese Aliasse, um zu bestimmen, welche Ergebnisse der externen Dokumentsuche der Anwender anzeigen kann.

    Um zu erfahren, wie es geht KI-Suche Die Sicherheit externer Inhalte verwendet Zuordnungen externer Anwender, siehe Sicherheit externer Inhalte für die KI-Suche .

    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 .

    Um Importverläufe für externe Anwenderzuordnungsdatensätze anzuzeigen, die über diesen Endpunkt importiert wurden, navigieren Sie zu KI-Suche > Externer Inhalt > Importverlauf von Anwenderzuordnungenan. In einem Verlaufsdatensatz können Sie die Datensätze Importsatz [sys_Import_Set] und Multi-Importsatz [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 . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    target_table
    Der Name des KI-Suche Anwenderzuordnungstabelle, in der die importierten Zuordnungen angezeigt werden sollen. Beispiel: X_snc_sharepoint_user_table .
    Hinweis:
    Sie müssen das Ziel erstellen KI-Suche Anwenderzuordnungstabelle über KI-Suche > Externer Inhalt > Anwenderzuordnung erstellen Modul, bevor dieser Endpunkt verwendet wird. Wenn Sie eine Anwenderzuordnungstabelle angeben, die nicht vorhanden ist, schlägt die Anforderung fehl.

    Datentyp: Zeichenfolge
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 3. Anforderungstextparameter (XML oder JSON)
    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 ServiceNow AI Platform Anwender, der von angegeben wird {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 ServiceNow AI Platform Anwender, der von angegeben wird {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 sind. 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 dem zugeordnet ServiceNow AI Platform Anwender 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: Benutzer [sys_user]

    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 : 4. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. 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 REST API-HTTP-Antwortcodes .

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    201 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.

    Antworttext-Parameter (JSON oder XML)

    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

    Meldung 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 durch eine erfolgreiche Anforderung in der Tabelle „Importsatz“ [sys_Import_Set] erstellt wurde.

    Datentyp: Zeichenfolge
    multi_import_set_id

    SYS_ID für den neuen Datensatz, der in der Tabelle „Mehrfachimportsatz“ [sys_Multi_Import_Set] durch eine erfolgreiche Anforderung 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

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Importieren Sie extern definierte Anwender- und Gruppenaliasse für ServiceNow AI Platform Anwender Beth Anglin und Abel Tuter in einen KI-Suche Anwenderzuordnungstabelle 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

    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"
}