Wissensmanagement-REST-API

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

    • Die Wissensmanagement Die API stellt Endpunkte zum Suchen, Anzeigen und Abrufen von Listen der am häufigsten angezeigten und empfohlenen Wissensartikel bereit.

    Sie können diese API nur verwenden, wenn das Plugin „Knowledge API“ (sn_km_api) aktiviert ist. Die Wissensmanagement-REST API wurde ursprünglich in veröffentlicht OrlandoVerwenden der Knowledge API-App, die in verfügbar ist ServiceNow Store.

    Hinweis:
    Die Wissensmanagement-REST-API Ist öffentlich zugänglich und macht jede Knowledge Base, die öffentlich zugänglich ist, für alle Anwender verfügbar, einschließlich nicht authentifizierter Anwender. Für Version 1.0.1 und höher wurde die API bearbeitbar gemacht, sodass Administratoren jeden Endpunkt so konfigurieren können, dass nicht authentifizierter Zugriff durch Auswahl von verhindert wird Erfordert Authentifizierung Kennzeichnung auf der Registerkarte „Skriptbasierte REST-Servicesicherheit“, die der API zugeordnet ist.

    Damit andere Domänen verwendet werden können Wissensmanagement-REST-API Endpunkte: Definieren Sie eine CORS-Regel (Cross-Origin Resource Sharing). Weitere Informationen finden Sie unter Definieren Sie eine CORS-Regel .

    Um einen artikel aus der bereichsbezogenen Knowledge Base mithilfe dieser REST-API anzuzeigen, erlauben Sie dem Umfang „sn_km_api“ in der Tabelle „eingeschränkte Anruferzugriffsberechtigungen“ [sys_restricted_caller_access] den Lesezugriff aus dem anfordernden Bereich. Weitere Informationen finden Sie unter Definieren Sie den bereichsübergreifenden Zugriff auf eine Anwendungsressource .

    Standardmäßig hat diese API ein Quotenlimit von 500 pro Stunde für nicht authentifizierte und snc_external Anwender. Weitere Informationen zur Quotenbegrenzung finden Sie unter Begrenzung der eingehenden REST-API-Rate .

    Wissensmanagement – GET /Knowledge/articles

    Gibt eine Liste von Knowledge Base-Artikeln (KB) zurück, die mit verschiedenen Parametern durchsucht und gefiltert werden können.

    URL-Format

    Versionierte URL: /api/sn_km_api/{api_Version}/Knowledge/articles

    Standard-URL: /api/sn_km_api/Knowledge/articles

    Hinweis:
    Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfad-Parameter
    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
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Filter Codierte Abfrage zum Filtern des Ergebnissatzes.

    Syntax: Filter=<attr> <operator> <value> .

    • <attr> : Name der Tabellenspalte.
    • <operator> :
      Gültige Werte:
      • =: Stimmt genau mit <value> überein.
      • !=: Stimmt nicht mit <value> überein.
      • ^: Ermöglicht es Ihnen, mehrere Bedingungen und logisch anzugeben.
      • ^ODER: Ermöglicht es Ihnen, mehrere Bedingungen logisch ODER logisch anzugeben.
      • LIKE: <attr> enthält die angegebene Zeichenfolge. Funktioniert nur für <attr>-Felder, deren Datentyp „Zeichenfolge“ ist.
      • STARTSMIT: <attr> beginnt mit der angegebenen Zeichenfolge. Funktioniert nur für <attr>-Felder, deren Datentyp „Zeichenfolge“ ist.
      • ENDSWITH: <attr> endet mit der angegebenen Zeichenfolge. Funktioniert nur für <attr>-Felder, deren Datentyp „Zeichenfolge“ ist.
    • <value> : Wert, mit dem abgeglichen werden soll.

    Bei allen Parametern wird zwischen Groß- und Kleinschreibung unterschieden. Abfrage kann mehr als einen Eintrag enthalten, z. B. Filter=<attr> <operator> <value>[<operator> <attr> <operator> <value>] .

    Datentyp: Zeichenfolge

    Standard: Leer
    Felder Kommagetrennte Liste von Feldern aus der Tabelle „Wissen“ [kb_Knowledge], um Details in Ergebnissen anzuzeigen.

    Datentyp: Zeichenfolge

    Standard: Keine
    KB Kommagetrennte Liste von Knowledge Base-sys_IDs aus der Knowledge Bases-Tabelle [kb_Knowledge_Base], auf die Ergebnisse beschränkt werden sollen.

    Datentyp: Zeichenfolge
    language Liste der kommagetrennten Sprachen im zweistelligen ISO 639-1-Sprachcodeformat, auf die Ergebnisse beschränkt werden sollen. Geben Sie alternativ „alle“ ein, um in allen gültigen installierten Sprachen in einer Instanz zu suchen.

    Datentyp: Zeichenfolge

    Standard: Sitzungssprache oder en des Anwenders
    limit Maximale Anzahl zurückzugebender Datensätze. Ungewöhnlich groß limitWerte können sich auf die Systemleistung auswirken. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie offsetParameter zum Paginieren des Datensatzabrufs.

    Datentyp: Zahl

    Standard: 30
    Offset Startdatensatzindex, für den mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktionalität ermöglicht den Abruf aller Datensätze, unabhängig von der Anzahl der Datensätze, in kleinen verwaltbaren Blöcken.

    Beispiel: Wenn dieser Endpunkt zum ersten Mal aufgerufen wird, offsetIst auf „0“ festgelegt. Verwenden Sie, um durch alle verfügbaren Datensätze zu blättern Offset=Offset+Limit Bis das Ende aller Datensätze erreicht ist.

    Datentyp: Zahl

    Standard: 0
    query Text, nach dem gesucht werden soll, kann leer sein.

    Datentyp: Zeichenfolge
    Tabelle : 3. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Keine

    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 .

    Tabelle : 4. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Tabelle : 5. Antwort-Header
    Header 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
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Artikel Liste der Artikel, die als Antwort zurückgegeben wurden.

    Datentyp: Array

    "articles": [
  {
    "fields": {Object},
    "link": "String",
    "id": "String",
    "number": "String",
    "rank": Number,
    "score": Number,
    "snippet": "String",
    "title": "String"
  }
]
    artikel.Felder Werte der angeforderten Felder, falls vorhanden.

    Datentyp: Objekt

    "fields": {
  "<field_name>": {Object}
}
    artikel.Felder.<field_name> Listet jedes Feld auf, das mithilfe des Feldparameters angefordert wurde, falls vorhanden.

    Datentyp: Objekt

    "<field_name>": {
  "display_value": "String",
  "label": "String",
  "name": "String",
  "type": "String",
  "value": "String"
}
    artikel.Felder.<field_name>.Anzeigewert Anzeigewert des angeforderten Felds.

    Datentyp: Zeichenfolge
    artikel.Felder.<field_name>.Bezeichnung Bezeichnung, die das angeforderte Feld darstellt. Beispiel: Wissen .

    Datentyp: Zeichenfolge
    artikel.Felder.<field_name>.Name Name des angeforderten Felds. Stimmt Überein <field_name>.

    Datentyp: Zeichenfolge
    artikel.Felder.<field_name>.Typ Datentyp des angeforderten Felds.

    Datentyp: Zeichenfolge
    artikel.Felder.<field_name>.Wert Wert des angeforderten Felds.

    Datentyp: Zeichenfolge
    articles.id Sys_ID des wissensartikels aus der Tabelle „Wissen“ [kb_Knowledge].

    Datentyp: Zeichenfolge
    artikel.Link Link zum artikel.

    Datentyp: Zeichenfolge
    artikel.Nummer wissensartikelnummer.

    Datentyp: Zeichenfolge
    artikel.Rang Suchrang des artikels, der für diese Suche spezifisch ist.

    Datentyp: Zahl (Gleitkommazahl)
    artikel.Fragment Text, der einen kleinen Teil des wissensartikels anzeigt.

    Datentyp: Zeichenfolge
    artikel.Punktzahl Relevanzpunktzahl, Ergebnisse in absteigender Reihenfolge nach Punktzahl sortiert.

    Datentyp: Zeichenfolge
    artikel.Titel Kurzbeschreibung oder Titel des wissensartikels.

    Datentyp: Zeichenfolge
    Meta Meta-Informationen der Ergebnisse und Anforderungsparameter.

    Datentyp: Objekt

    "meta": {
  "count": Number,
  "end": Number,
  "fields": "String",
  "filter": "String",
  "kb": "String",
  "language": "String",
  "query": "String",
  "start": Number,
  "status": {Object},
  "ts_query_id": "String"
}
    Meta.count Anzahl der verfügbaren KB-Artikel.

    Datentyp: Zahl
    Meta.Ende Endindex des Ergebnissatzes.

    Datentyp: Zahl
    Meta.Felder Felder im artikel.

    Datentyp: Zeichenfolge
    Meta.Filter Filter, der zum Abrufen der Daten verwendet wird.

    Datentyp: Zeichenfolge
    Meta.kb Liste der sys_IDs des Knowledge Base-artikels.

    Datentyp: Zeichenfolge
    Meta.Sprache Liste der kommagetrennten Sprachen der angeforderten KB-Artikel.

    Datentyp: Zeichenfolge
    Meta.Abfrage Angegebene Anforderungsabfrage.

    Datentyp: Zeichenfolge
    Meta.Start Startindex des Ergebnissatzes.

    Datentyp: Zahl
    Meta.Status Status des Anrufs.

    Datentyp: Zeichenfolge
    Meta.ts_query_ID SYS_ID der Abfrage.

    Datentyp: Zeichenfolge

    Curl-Anforderung

    curl "https://instance.servicenow.com/api/sn_km_api/knowledge/articles?query=Windows&limit=2&fields=short_description&fields=sys_class_name" \
--request GET \
--header "Accept:application/xml" \
--user "username":"password"
    {
  "result": {
    "meta": {
      "start": 0,
      "end": 2,
      "fields": "short_description,sys_class_name",
      "query": "Windows",
      "filter": "",
      "kb": "",
      "language": "en",
      "count": 19,
      "ts_query_id": "7976f36129c30410f877796e70786991",
      "status": {
        "code": 200
      }
    },
    "articles": [
      {
        "link": "?sys_kb_id=9e528db1474321009db4b5b08b9a71a6&id=kb_article_view&sysparm_rank=1&sysparm_tsqueryId=7976f36129c30410f877796e70786991",
        "rank": 1,
        "id": "kb_knowledge:9e528db1474321009db4b5b08b9a71a6",
        "title": "Windows: Should I upgrade to Windows 8.x?",
        "snippet": "    Should I upgrade to <B>Windows</B> 8.x? <B>Windows</B> 8.x is designed for using touch, mouse, and keyboard the <B>Windows</B> Store and access apps such as Calendar, Mail, and Messaging. By most accounts, <B>Windows</B> boot times, smaller memory footprint, and more free memory for the programs you run. <B>Windows</B>",
        "score": 14.869,
        "number": "KB0000020",
        "fields": {
          "short_description": {
            "display_value": "Windows: Should I upgrade to Windows 8.x?\n\t\t",
            "name": "short_description",
            "label": "Short description",
            "type": "string",
            "value": "Windows: Should I upgrade to Windows 8.x?\n\t\t"
          },
          "sys_class_name": {
            "display_value": "Knowledge",
            "name": "sys_class_name",
            "label": "Class",
            "type": "sys_class_name",
            "value": "kb_knowledge"
          }
        }
      },
      {
        "link": "?sys_kb_id=3b07857187032100deddb882a2e3ec20&id=kb_article_view&sysparm_rank=2&sysparm_tsqueryId=7976f36129c30410f877796e70786991",
        "rank": 2,
        "id": "kb_knowledge:3b07857187032100deddb882a2e3ec20",
        "title": "What is the Windows key?",
        "snippet": "What is the <B>Windows</B> key? The <B>Windows</B> key is a standard key on most keyboards on computers built to use a <B>Windows</B> operating system. It is labeled with a <B>Windows</B> logo, and is usually placed between on the right side as well. Pressing Win (the <B>Windows</B> key) on its own will do the following: <B>Windows</B> 8.x: Toggle",
        "score": 13.4826,
        "number": "KB0000017",
        "fields": {
          "short_description": {
            "display_value": "What is the Windows key?\t\t",
            "name": "short_description",
            "label": "Short description",
            "type": "string",
            "value": "What is the Windows key?\t\t"
          },
          "sys_class_name": {
            "display_value": "Knowledge",
            "name": "sys_class_name",
            "label": "Class",
            "type": "sys_class_name",
            "value": "kb_knowledge"
          }
        }
      }
    ]
  }
}

    Wissensmanagement – GET /Knowledge/articles/{article_sys_ID}/attachments/{attachment_sys_ID} AB

    Gibt einen wissensartikelanhang als Datei zurück.

    URL-Format

    Versionierte URL: /api/sn_km_api/{api_Version}/Knowledge/articles/{article_sys_ID}/attachments/{attachment_sys_ID}

    Standard-URL: /api/sn_km_api/Knowledge/articles/{article_sys_ID}/attachments/{attachment_sys_ID}

    Hinweis:
    Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

    Unterstützte Anforderungsparameter

    Tabelle : 7. Pfad-Parameter
    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
    article_sys_ID SYS_ID des wissensartikels mit dem Anhang, den Sie abrufen möchten.

    Datentyp: Zeichenfolge

    Tabelle: Knowledge Bases [kb_Knowledge]
    attachment_sys_id SYS_ID des Datensatzes, zu dem der Anhang gehört.

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

    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 .

    Tabelle : 10. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Tabelle : 11. Antwort-Header
    Header Beschreibung
    Inhaltstyp Der Inhaltstyp der Antwort, z. B. Bild/GIF Oder */* .

    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 : 12. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter

    Name Beschreibung
    Datei wird als Antwort zurückgegeben.

    Beispiel für Curl-Anforderung

    curl "https://instance.service-now.com/api/sn_km_api/knowledge/articles/0b48fd75474321009db4b5b08b9a71c2/attachments/fedf5614294f4010f877796e70786956" \
--request GET \
--header "Accept:*/*" \
--user "username":"password"
    Binary response not shown (file is returned as a response).

    Wissensmanagement – GET /Knowledge/articles/{ID}

    Gibt bestimmten wissensartikelinhalt und seine Feldwerte zurück.

    URL-Format

    Versionierte URL: /api/sn_km_api/{api_Version}/Knowledge/articles/{ID}

    Standard-URL: /api/sn_km_api/Knowledge/articles/{ID}

    Hinweis:
    Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

    Unterstützte Anforderungsparameter

    Tabelle : 19. Pfad-Parameter
    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
    ID SYS_ID oder Knowledge Base (KB)-Nummer eines wissensartikels.

    Datentyp: Zeichenfolge

    Tabelle: Wissen [kb_Knowledge]
    Tabelle : 20. Abfrageparameter
    Name Beschreibung
    Felder Kommagetrennte Liste von Feldern aus der Tabelle „Wissen“ [kb_Knowledge], um Details in Ergebnissen anzuzeigen.

    Datentyp: Zeichenfolge

    Standard: Keine
    language Zweistelliger ISO 639-1-Sprachcode, z. B. „fr“ für Französisch. Ergebnisse werden nur angezeigt, wenn bei Suchen die KB-Nummer des wissensartikels als verwendet wird idUnd eine übersetzte Version des artikels ist in der angegebenen Sprache verfügbar.
    Hinweis:
    Nur gültig, wenn festgelegt wird idParameter als KB-Zahl (nicht sys_ID).

    Datentyp: Zeichenfolge
    Search_ID Optional, sofern nicht verwendet search_rank. Eindeutiger Bezeichner der Suche, die diesen artikel zurückgegeben hat.
    Sie können abrufen search_idMit einer der folgenden APIs, die zurückgibt articles.idElement:

    Übergeben search_idUnd search_rankDer Parameter erhöht die Anzahl der artikelansichten und zeichnet einen Eintrag für den artikel in der Tabelle „Wissensnutzung“ [kb_use] auf. Sie können auch die Anzahl erhöhter Ansichten auf der Knowledge Base-Seite [kb_view2] überprüfen.

    Datentyp: Zeichenfolge
    Search_rank Optional, sofern nicht verwendet search_id. Artikel Suchrang Durch Klickrate, die Sie mit einer der folgenden APIs abrufen können, die zurückgibt articles.rankElement:

    Datentyp: Zahl
    Update_View Aktualisieren Sie die Ansichtsanzahl, und zeichnen Sie einen Eintrag für den artikel in der Tabelle „Wissensnutzung“ [kb_use] auf. „Wahr“, ob als eigenständiger Parameter vorhanden oder auf „wahr“ festgelegt ist.
    Hinweis:
    Wenn Sie bestehen update_viewMit search_idUnd search_rank, update_viewWird ignoriert, da die Ansichtsanzahl bereits erhöht wird.

    Datentyp: Boolescher Wert, der bei Übergabe immer als „wahr“ behandelt wird, wenn auf festgelegt „Wahr“ , „Falsch“ , Oder überhaupt nicht festgelegt.
    Tabelle : 21. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Keine

    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 .

    Tabelle : 22. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Tabelle : 23. Antwort-Header
    Header 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 : 24. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Anhänge Stellt Anhangsdetails für jede Instanz bereit, wenn ein Anhang vorhanden ist.

    Zeigt nur an, wenn Display_Attachments = wahr .

    Datentyp: Array von Objekten

    "attachments": [
  {
    "file_name": "String",
    "size_bytes": "String",
    "state": "String",
    "sys_id": "String"
  }
]
    Attachments.file_Name Dateiname des Anhangs.

    Datentyp: Zeichenfolge
    Attachments.size_bytes Dateigröße.

    Datentyp: Zeichenfolge

    Einheit: Byte
    Anhänge.Status Status.
    Mögliche Werte:
    • Verfügbar
    • Available_condition
    • Not_available
    • Ausstehend

    Datentyp: Zeichenfolge
    Attachments.sys_ID SYS_ID des Anhangs.

    Datentyp: Zeichenfolge
    Content Gesamter HTML-Inhalt des artikels.

    Datentyp: Zeichenfolge
    Display_Attachments Kennzeichnung, die angibt, ob display_attachmentsKennzeichnung ist für diesen artikel aktiv. Anhänge werden nur zurückgegeben, wenn display_attachmentsIst „wahr“ (aktiv) im wissensartikeldatensatz.
    • Wahr: display_attachmentsIst aktiv.
    • Falsch: display_attachmentsIst inaktiv.

    Datentyp: Boolescher Wert
    Eingebetteter_Inhalt Listet jeden Anhang mit eingebetteten Inhalten nach sys_ID auf und enthält relevante Anhangsinformationen.

    Zeigt nur an, wenn Display_Attachments = wahr .

    Datentyp: Array von Objekten

    "attachments": [
  {
    "file_name": "String",
    "size_bytes": "String",
    "state": "String",
    "sys_id": "String"
  }
]
    Embedded_content.file_Name Dateiname des Anhangs.

    Datentyp: Zeichenfolge
    Embedded_content.size_bytes Größe des Anhangs.

    Datentyp: Zeichenfolge

    Einheit: Byte
    Embedded_content.State Status des Anhangs.
    Mögliche Werte:
    • Verfügbar
    • Available_condition
    • Not_available
    • Ausstehend

    Datentyp: Zeichenfolge
    Eingebettete_content.sys_ID SYS_ID des Anhangs.

    Datentyp: Zeichenfolge
    Felder Werte der angeforderten Felder (falls vorhanden).

    Datentyp: Objekt

    "fields": {
  "<field_name>": {Object}
}
    Felder.<field_name> Listet jedes Feld auf, das mithilfe des Feldparameters angefordert wurde, falls vorhanden.

    Datentyp: Objekt

    "<field_name>": {
  "display_value": "String",
  "label": "String",
  "name": "String",
  "type": "String",
  "value": "String"
}
    Fields.<field_name>.Display_value Anzeigewert des angeforderten Felds.

    Datentyp: Zeichenfolge
    Felder.<field_name>.Bezeichnung Bezeichnung, die das angeforderte Feld darstellt. Beispiel: Wissen .

    Datentyp: Zeichenfolge
    Felder.<field_name>.Name Name des angeforderten Felds. Stimmt Überein <field_name>.

    Datentyp: Zeichenfolge
    Felder.<field_name>.Typ Datentyp des angeforderten Felds.

    Datentyp: Zeichenfolge
    Felder.<field_name>.Wert Wert des angeforderten Felds.

    Datentyp: Zeichenfolge
    language Zweistelliger ISO 639-1-Sprachcode für den aktuellen artikel (wenn Übersetzung verfügbar ist).

    Datentyp: Zeichenfolge
    Sprachen Für jede übersetzte Version eines wissensartikels (falls übersetzt):
    "languages": [
  {
    "label": "String",
    "language": "String",
    "sys_id": "String"
  }
]

    Datentyp: Array
    Sprachen.Bezeichnung Zeichenfolgendarstellung für Sprache.

    Datentyp: Zeichenfolge
    Sprachen.Sprache Zweistellige ISO 639-1-Codesprache.

    Datentyp: Zeichenfolge
    Languages.sys_ID Eindeutiger Bezeichner für die übersetzte Version des wissensartikels.

    Datentyp: Zeichenfolge
    Nummer Artikelnummer.

    Datentyp: Zeichenfolge
    short_description Kurzbeschreibung oder Titel des wissensartikels.

    Datentyp: Zeichenfolge
    sys_id Sys_ID des wissensartikels aus der Tabelle „Wissen“ [kb_Knowledge].

    Datentyp: Zeichenfolge
    Vorlage Kennzeichnung, die angibt, ob ein zurückgegebener artikel eine Vorlage ist.
    Mögliche Werte:
    • Wahr: Artikel ist eine Vorlage.
    • Falsch: Artikel ist keine Vorlage.

    Datentyp: Boolescher Wert
    Template_table Name der Vorlagentabelle, wird nur zurückgegeben, wenn der wissensartikel eine Vorlage ist.

    Datentyp: Zeichenfolge

    Curl-Anforderung

    curl "https://instance.servicenow.com/api/sn_km_api/knowledge/articles/0b48fd75474321009db4b5b08b9a71c2?search_id=spam&search_rank=26.426" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
    {
  "result": {
    "content": "<p><span style=\"font-size: 18pt;\"><strong>How to Deal with Spam</strong></span></p>\r\n<p>Spam has increasingly become a problem on the Internet. While every Internet user receives some spam, email  addresses posted to web sites or in newsgroups and chat rooms attract the most spam.</p>\r\n<p>To reduce the amount of spam you receive:</p>\r\n<p>
    "template": false,
    "number": "KB0000011",
    "sys_id": "0b48fd75474321009db4b5b08b9a71c2",
    "short_description": "How to Deal with Spam",
    "display_attachments": true,
    "attachments": [
      {
        "sys_id": "dc27ae18294f4010f877796e707869c8",
        "file_name": "image.jpg",
        "size_bytes": "66792",
        "state": "available_conditionally"
      },
      {
        "sys_id": "fedf5614294f4010f877796e70786956",
        "file_name": "attachment.txt",
        "size_bytes": "75",
        "state": "available_conditionally"
      }
    ],
    "embedded_content": []
  }
}

    Beispiel für Curl-Anforderung (Update_View)

    curl "https://instance.servicenow.com/api/sn_km_api/knowledge/KB0000020?update_view=' \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
    {
  "result": {
    "content": "<p> </p>\r\n<p> </p>\r\n<p><strong><span style=\"font-size: 18pt;\">Should I upgrade to Windows 8.x?</span></strong></p>\r\n<p>Windows 8.x is designed for using touch, mouse, and keyboard together, on hardware ranging from touch-enabled tablets and laptops to PCs and all-in-one computers...(intentionally truncated)</p>",
    "template": false,
    "number": "KB0000020",
    "sys_id": "9e528db1474321009db4b5b08b9a71a6",
    "short_description": "Windows: Should I upgrade to Windows 8.x?\t\t",
    "display_attachments": true,
    "attachments": [],
    "embedded_content": []
  }
}

    Wissensmanagement – Wissen/Artikel/most_viewed ABRUFEN

    Gibt eine Liste von Wissensartikeln zurück, die nach den am häufigsten angezeigten priorisiert wurden.

    URL-Format

    Versionierte URL: /api/sn_km_api/{api_Version}/Knowledge/articles/most_viewed

    Standard-URL: /api/sn_km_api/Knowledge/articles/most_viewed

    Hinweis:
    Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

    Unterstützte Anforderungsparameter

    Tabelle : 25. Pfad-Parameter
    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
    Tabelle : 26. Abfrageparameter
    Name Beschreibung
    Felder Kommagetrennte Liste von Feldern aus der Tabelle „Wissen“ [kb_Knowledge], um Details in Ergebnissen anzuzeigen.

    Datentyp: Zeichenfolge

    Standard: Keine
    KB Kommagetrennte Liste von Knowledge Base-sys_IDs aus der Knowledge Bases-Tabelle [kb_Knowledge_Base], auf die Ergebnisse beschränkt werden sollen.

    Datentyp: Zeichenfolge
    language Liste der kommagetrennten Sprachen im zweistelligen ISO 639-1-Sprachcodeformat, auf die Ergebnisse beschränkt werden sollen. Geben Sie alternativ „alle“ ein, um in allen gültigen installierten Sprachen in einer Instanz zu suchen.

    Datentyp: Zeichenfolge

    Standard: Sitzungssprache oder en des Anwenders
    limit Maximale Anzahl zurückzugebender Datensätze. Ungewöhnlich groß limitWerte können sich auf die Systemleistung auswirken. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie offsetParameter zum Paginieren des Datensatzabrufs.

    Datentyp: Zahl

    Standard: 30
    Offset Startdatensatzindex, für den mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktionalität ermöglicht den Abruf aller Datensätze, unabhängig von der Anzahl der Datensätze, in kleinen verwaltbaren Blöcken.

    Beispiel: Wenn dieser Endpunkt zum ersten Mal aufgerufen wird, offsetIst auf „0“ festgelegt. Verwenden Sie, um durch alle verfügbaren Datensätze zu blättern Offset=Offset+Limit Bis das Ende aller Datensätze erreicht ist.

    Datentyp: Zahl

    Standard: 0
    Tabelle : 27. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Keine

    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 .

    Tabelle : 28. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Tabelle : 29. Antwort-Header
    Header 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 : 30. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Artikel Liste der Artikel, die als Antwort zurückgegeben wurden.

    Datentyp: Array

    [
  {
    "fields": {Object},
    "id": "String",
    "link": "String",
    "number": "String",
    "rank": Number,
    "score": Float,
    "snippet": "String",
    "title": "String"
  }
]
    artikel.Felder Werte der angeforderten Felder (falls vorhanden).

    Datentyp: Objekt

    "fields": {
  "<field_name>": {Object}
}
    artikel.Felder.<field_name> Listet jedes Feld auf, das mithilfe des Feldparameters angefordert wurde, falls vorhanden.

    Datentyp: Objekt

    "<field_name>": {
  "display_value": "String",
  "label": "String",
  "name": "String",
  "type": "String",
  "value": "String"
}
    artikel.Felder.<field_name>.Anzeigewert Anzeigewert des angeforderten Felds.

    Datentyp: Zeichenfolge
    artikel.Felder.<field_name>.Bezeichnung Bezeichnung, die das angeforderte Feld darstellt. Beispiel: Wissen .

    Datentyp: Zeichenfolge
    artikel.Felder.<field_name>.Name Name des angeforderten Felds. Stimmt mit <field_name> überein.

    Datentyp: Zeichenfolge
    artikel.Felder.<field_name>.Typ Datentyp des angeforderten Felds.

    Datentyp: Zeichenfolge
    artikel.Felder.<field_name>.Wert Wert des angeforderten Felds.

    Datentyp: Zeichenfolge
    articles.id Sys_ID des wissensartikels aus der Tabelle „Wissen“ [kb_Knowledge].

    Datentyp: Zeichenfolge
    artikel.Link Link zum artikel.

    Datentyp: Zeichenfolge
    artikel.Nummer wissensartikelnummer.

    Datentyp: Zeichenfolge
    artikel.Rang Suchrang des artikels, der für diese Suche spezifisch ist.

    Datentyp: Gleitkommazahl
    artikel.Punktzahl Relevanzpunktzahl, Ergebnisse in absteigender Reihenfolge nach Punktzahl sortiert.

    Datentyp: Zeichenfolge
    artikel.Fragment Text, der einen kleinen Teil des wissensartikels anzeigt.

    Datentyp: Zeichenfolge
    artikel.Titel Kurzbeschreibung oder Titel des wissensartikels.

    Datentyp: Zeichenfolge
    Meta Meta-Informationen der Ergebnisse und Anforderungsparameter.

    Datentyp: Objekt

    "meta": {
  "count": Number,
  "end": Number,
  "fields": "String",
  "filter": "String",
  "kb": "String",
  "language": "String",
  "query": "String",
  "start": Number,
  "status": {Object},
  "ts_query_id": "String"
}
    Meta.count Anzahl der verfügbaren KB-Artikel.

    Datentyp: Zahl
    Meta.Ende Endindex des Ergebnissatzes.

    Datentyp: Zahl
    Meta.Felder Felder im artikel.

    Datentyp: Zeichenfolge
    Meta.Filter Filter, der zum Abrufen der Daten verwendet wird.

    Datentyp: Zeichenfolge
    Meta.kb Liste der sys_IDs des Knowledge Base-artikels.

    Datentyp: Zeichenfolge
    Meta.Sprache Liste der kommagetrennten Sprachen der angeforderten KB-Artikel.

    Datentyp: Zeichenfolge
    Meta.Abfrage Angegebene Anforderungsabfrage.

    Datentyp: Zeichenfolge
    Meta.Start Startindex des Ergebnissatzes.

    Datentyp: Zahl
    Meta.Status HTTP-Status des Aufrufs.

    Datentyp: Zeichenfolge
    Meta.ts_query_ID SYS_ID der Abfrage.

    Datentyp: Zeichenfolge

    Curl-Anforderung

    curl "https://instance.servicenow.com/api/sn_km_api/knowledge/articles/most_viewed?limit=5" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
    {
  "result": {
    "meta": {
      "start": 0,
      "end": 5,
      "fields": "",
      "query": "",
      "filter": "workflow_state=published^valid_to>=javascript:gs.beginningOfToday()^active=true^sys_class_name!=kb_knowledge_block^sys_view_count>0^ORDERBYDESCsys_view_count^ORDERBYshort_description",
      "kb": "",
      "count": 2,
      "status": {
        "code": 200
      },
      "language": "en"
    },
    "articles": [
      {
        "link": "?id=kb_article_view&sys_kb_id=0b48fd75474321009db4b5b08b9a71c2",
        "id": "kb_knowledge:0b48fd75474321009db4b5b08b9a71c2",
        "title": "How to Deal with Spam",
        "snippet": "How to Deal with Spam Spam has increasingly become a problem on the Internet. While every Internet user receives some spam, email addresses posted to web sites or in newsgroups and chat rooms attract the most spam. To reduce the amount of spam you receive: Don't reply to spam Be careful releasing your email address, and know how it will be used ",
        "score": 7,
        "tags": [],
        "number": "KB0000011"
      },
      {
        "link": "?id=kb_article_view&sys_kb_id=c85cd2519f77230088aebde8132e70c2",
        "id": "kb_knowledge:c85cd2519f77230088aebde8132e70c2",
        "title": "Microsoft Outlook Issues",
        "snippet": "Microsoft Outlook Issues This article explains how to use automatic replies in Outlook 2010 for Exchange accounts. Setting Up Automatic Replies Click the File tab. Click Automatic Replies. Select Send automatic replies. If desired, select the Only send during this time range check box to schedule when your out of office replies are active. If yo",
        "score": 6,
        "tags": [],
        "number": "KB99999999"
      }
    ]
  }
}