Wissensmanagement-REST-API

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 21 Minuten Lesedauer

    • Die Wissensmanagement- REST-API ermöglicht das Suchen, Anzeigen und Abrufen von Listen der am häufigsten angezeigten und empfohlenen Wissensartikel.

    Diese API kann nur verwendet werden, wenn das Plugin „Knowledge API“ (sn_km_api) aktiviert ist. Die Knowledge Management-REST-API wurde ursprünglich in Orlando mithilfe der Knowledge API-App veröffentlicht, die im [ ServiceNow Storeverfügbar ist.

    Hinweis:
    Die Wissensmanagement-REST-API ist öffentlich zugänglich und macht jede Knowledge Base, die öffentlich zugänglich ist, für alle Benutzer verfügbar, einschließlich nicht authentifizierter Benutzer. 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 der Kennzeichnung Erfordert Authentifizierung auf der der API zugeordneten Registerkarte „Geskriptete REST-Servicesicherheit“ konfiguriert wird.

    Um anderen Domänen die Verwendung von Knowledge Management-REST-API -Endpunkten zu ermöglichen, definieren Sie eine CORS-Regel (Cross-Origin Resource Sharing). Weitere Informationen finden Sie unter CORS-Regeln definieren.

    Um einen Artikel aus der bereichsbezogenen Knowledge Base mit dieser REST-API anzuzeigen, erlauben Sie dem Bereich sn_km_api Lesezugriff aus dem anfordernden Bereich in der Tabelle „Eingeschränkte Aufruferzugriffsberechtigungen“ [sys_restricted_caller_access]. Weitere Informationen finden Sie unter Bereichsübergreifenden Zugriff auf eine Anwendungsressource definieren.

    Standardmäßig hat diese API eine Quotenbegrenzung von 500 pro Stunde für nicht authentifizierte und snc_external-Benutzer. Weitere Informationen zur Quotenbegrenzung finden Sie unter Quotenbegrenzung für eingehende REST-APIs.

    Wissensmanagement – GET /Wissen/Artikel

    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

    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
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    filter Codierte Abfrage, die zum Filtern der Ergebnismenge verwendet werden soll.

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

    • <attr>: Name der Tabellenspalte.
    • <operator>:
      Gültige Werte:
      • =: Stimmt genau überein mit <value>.
      • !=: Stimmt nicht überein mit <value>.
      • ^: Ermöglicht die Angabe von mehr als einer Bedingung und eine logische UND-Verknüpfung.
      • ^ODER: Ermöglicht die Angabe von mehr als einer Bedingung und deren logische ODER-Verknüpfung.
      • WIE:<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> [ ] .

    Datentyp: Zeichenfolge

    Standard: leer
    Felder Kommagetrennte Liste von Feldern aus der Wissenstabelle [kb_knowledge], um Details in den Ergebnissen anzuzeigen.

    Datentyp: Zeichenfolge

    Standard: Keine
    KB Kommagetrennte Liste der sys_ids der Knowledge Base aus der Tabelle „Knowledge Bases“ [kb_knowledge_base], auf die die Ergebnisse beschränkt werden sollen.

    Datentyp: Zeichenfolge
    language Liste der durch Kommas getrennten Sprachen im aus zwei Buchstaben bestehenden ISO 639-1-Sprachcodeformat, auf die die Ergebnisse beschränkt werden sollen. Alternativ können Sie „all“ eingeben, um in allen gültigen installierten Sprachen einer Instanz zu suchen.

    Datentyp: Zeichenfolge

    Standard: Sitzungssprache des Anwenders oder en
    limit Maximale Anzahl der zurückzugebenden Datensätze. Ungewöhnlich große Werte für limit können die Systemleistung beeinträchtigen. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter offset, um den Datensatzabruf zu paginieren.

    Datentyp: Zahl

    Standard: 30
    Offset Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze.

    Beispiel: Wenn dieser Endpunkt zum ersten Mal aufgerufen wird, wird offset auf „0“ festgelegt. Um alle verfügbaren Datensätze zu durchblättern, verwenden Sie 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. 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ützte Typen: application/json oder application/xml.

    Standard: 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-Antwortcodesder REST-API.

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

    Antworttextparameter (JSON oder XML)

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

    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 mit dem Parameter „fields“ angefordert wurde, falls vorhanden.

    Datentyp: Objekt

    "<field_name>": {
  "display_value": "String",
  "label": "String",
  "name": "String",
  "type": "String",
  "value": "String"
}
    artikel.felder.<field_name> .display_value 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. Entspricht <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
    artikel.id sys_id des Wissensartikels aus der Wissenstabelle [kb_knowledge].

    Datentyp: Zeichenfolge
    artikel.link Link zum Artikel.

    Datentyp: Zeichenfolge
    artikel.nummer Nummer des Wissensartikels.

    Datentyp: Zeichenfolge
    artikel.rang Suchrang des für diese Suche spezifischen Artikels.

    Datentyp: Zahl (Float)
    artikel.snippet Text, der einen kleinen Teil des Wissensartikels zeigt.

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

    Datentyp: Zeichenfolge
    Artikel.Titel Kurzbeschreibung oder Titel des Wissensartikels.

    Datentyp: Zeichenfolge
    meta Metainformationen 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.end Endindex des Ergebnissatzes.

    Datentyp: Zahl
    meta.fields Felder im Artikel.

    Datentyp: Zeichenfolge
    meta.filter Filter, der zum Erfassen der Daten verwendet wird.

    Datentyp: Zeichenfolge
    meta.kb Liste der sys_ids der Knowledge Base-Artikel.

    Datentyp: Zeichenfolge
    meta.language Liste der kommagetrennten Sprachen der KB-Artikel, die angefordert wurden.

    Datentyp: Zeichenfolge
    meta.query 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"
          }
        }
      }
    ]
  }
}

    Knowledge Management – GET /knowledge/articles/{article_sys_id}/attachments/{attachment_sys_id}

    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}

    Unterstützte Anforderungsparameter

    Tabelle : 7. 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
    article_sys_id Sys_id des Wissensartikels mit dem Anhang, den Sie abrufen möchten. Befindet sich in der Knowledge Base-Tabelle [kb_knowledge].

    Datentyp: Zeichenfolge
    attachment_sys_id Sys_id des Datensatzes, zu dem der Anhang gehört.

    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ützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 11. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Content-Type Inhaltstyp der Antwort, z. B. image/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 HTTP-Antwortcodesder REST-API.

    Tabelle : 12. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert. Die Anmeldeinformationen 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. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts

    Name Beschreibung
    Datei wird als Antwort zurückgegeben.

    Beispiel für eine 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).

    Knowledge Management – GET /knowledge/articles/{id}

    Gibt spezifischen 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}

    Unterstützte Anforderungsparameter

    Tabelle : 19. 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
    id Sys_id oder Knowledge Base-Nummer (KB) eines Wissensartikels in der Wissenstabelle [kb_knowledge].

    Datentyp: Zeichenfolge
    Tabelle : 20. Abfrageparameter
    Name Beschreibung
    Felder Kommagetrennte Liste von Feldern aus der Wissenstabelle [kb_knowledge], um Details in den Ergebnissen anzuzeigen.

    Datentyp: Zeichenfolge

    Standard: Keine
    language Zweistelliger ISO 639-1-Sprachcode; Beispiel: „fr“ für Französisch. Die Ergebnisse werden nur angezeigt, wenn bei Suchen die KB-Nummer des Wissensartikels als id verwendet wird und eine übersetzte Version des Artikels in der angegebenen Sprache verfügbar ist.
    Hinweis:
    Nur gültig, wenn der Parameter id als KB-Nummer (nicht sys_id) festgelegt wird.

    Datentyp: Zeichenfolge
    search_id Optional, sofern nicht search_rankverwendet wird. Eindeutiger Bezeichner der Suche, die diesen Artikel zurückgegeben hat.
    Sie können search_id mit einer der folgenden APIs abrufen, die das Element articles.id zurückgibt:

    Durch die Übergabe der Parameter search_id und search_rank wird die Anzahl der Artikelansichten erhöht und ein Eintrag für den Artikel in der Wissensnutzungstabelle [kb_use] aufgezeichnet. Sie können die erhöhte Anzahl der Aufrufe auch auf der Knowledge Base-Seite [kb_view2] überprüfen.

    Datentyp: Zeichenfolge
    search_rank Optional, sofern nicht search_idverwendet wird. Artikelsuchrang nach Klickrate, den Sie mit einer der folgenden APIs abrufen können, die das Element articles.rank zurückgibt:

    Datentyp: Zahl
    update_view Aktualisieren Sie die Ansichtsanzahl, und zeichnen Sie einen Eintrag für den Artikel in der Wissensnutzungstabelle [kb_use] auf. „True“, ob als eigenständiger Parameter vorhanden oder auf „true“ festgelegt.
    Hinweis:
    Wenn Sie update_view mit search_id und search_rankübergeben, wird update_view ignoriert, da die Anzahl der Aufrufe bereits erhöht wird.

    Datentyp: Boolescher Wert, der bei der Übergabe immer als „wahr“ behandelt wird, unabhängig davon, ob er auf „wahr“, „falsch“oder gar nicht festgelegt ist.
    Tabelle : 21. 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 : 22. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    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-Antwortcodesder REST-API.

    Tabelle : 24. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

    Antworttextparameter (JSON oder XML)

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

    Wird nur angezeigt, wenn display_attachments = true ist.

    Datentyp: Array

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

    Datentyp: Zeichenfolge
    anhänge.size_bytes Dateigröße.

    Datentyp: Zeichenfolge

    Einheit: Byte
    attachments.state Status
    Mögliche Werte:
    • Verfügbar
    • available_conditional
    • 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 die Kennzeichnung display_attachments für diesen Artikel aktiv ist. Anhänge werden nur zurückgegeben, wenn display_attachments im Wissensartikeldatensatz „true“ (aktiv) ist.
    • true: display_attachments ist aktiv.
    • false: display_attachments ist inaktiv.

    Datentyp: Boolesch
    eingebetteter Inhalt Listet jeden Anhang mit eingebettetem Inhalt nach sys_id auf und enthält relevante Anhangsinformationen.

    Wird nur angezeigt, wenn display_attachments = true ist.

    Datentyp: Array

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

    Datentyp: Zeichenfolge
    eingebettet_inhalt.größe_byte Größe des Anhangs.

    Datentyp: Zeichenfolge

    Einheit: Byte
    eingebettet_inhalt.status Status des Anhangs.
    Mögliche Werte:
    • Verfügbar
    • available_conditional
    • not_available
    • Ausstehend

    Datentyp: Zeichenfolge
    eingebettet_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 mit dem Parameter „fields“ angefordert wurde, falls vorhanden.

    Datentyp: Objekt

    "<field_name>": {
  "display_value": "String",
  "label": "String",
  "name": "String",
  "type": "String",
  "value": "String"
}
    Felder.<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. Entspricht <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 eine Ü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
    language.label Zeichenfolgendarstellung für Sprache.

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

    Datentyp: Zeichenfolge
    language.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 Wissenstabelle [kb_knowledge].

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

    Datentyp: Boolesch
    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 eine 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 – GET Wissen/Artikel/Most_viewed

    Gibt eine Liste der Wissensartikel zurück, die nach der Priorität sortiert sind.

    URL-Format

    Versionierte URL: /api/sn_km_api/{api_version}/knowledge/articles/ most_viewed

    Standard-URL: /api/sn_km_api/knowledge/articles/Most_viewed

    Unterstützte Anforderungsparameter

    Tabelle : 25. 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
    Tabelle : 26. Abfrageparameter
    Name Beschreibung
    Felder Kommagetrennte Liste von Feldern aus der Wissenstabelle [kb_knowledge], um Details in den Ergebnissen anzuzeigen.

    Datentyp: Zeichenfolge

    Standard: Keine
    KB Kommagetrennte Liste der sys_ids der Knowledge Base aus der Tabelle „Knowledge Bases“ [kb_knowledge_base], auf die die Ergebnisse beschränkt werden sollen.

    Datentyp: Zeichenfolge
    language Liste der durch Kommas getrennten Sprachen im aus zwei Buchstaben bestehenden ISO 639-1-Sprachcodeformat, auf die die Ergebnisse beschränkt werden sollen. Alternativ können Sie „all“ eingeben, um in allen gültigen installierten Sprachen einer Instanz zu suchen.

    Datentyp: Zeichenfolge

    Standard: Sitzungssprache des Anwenders oder en
    limit Maximale Anzahl der zurückzugebenden Datensätze. Ungewöhnlich große Werte für limit können die Systemleistung beeinträchtigen. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter offset, um den Datensatzabruf zu paginieren.

    Datentyp: Zahl

    Standard: 30
    Offset Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze.

    Beispiel: Wenn dieser Endpunkt zum ersten Mal aufgerufen wird, wird offset auf „0“ festgelegt. Um alle verfügbaren Datensätze zu durchblättern, verwenden Sie offset=offset+limit, bis das Ende aller Datensätze erreicht ist.

    Datentyp: Zahl

    Standard: 0
    Tabelle : 27. 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 : 28. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 29. 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-Antwortcodesder REST-API.

    Tabelle : 30. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

    Antworttextparameter (JSON oder XML)

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

    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 mit dem Parameter „fields“ angefordert wurde, falls vorhanden.

    Datentyp: Objekt

    "<field_name>": {
  "display_value": "String",
  "label": "String",
  "name": "String",
  "type": "String",
  "value": "String"
}
    artikel.felder.<field_name> .display_value 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. Übereinstimmungen<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
    artikel.id sys_id des Wissensartikels aus der Wissenstabelle [kb_knowledge].

    Datentyp: Zeichenfolge
    artikel.link Link zum Artikel.

    Datentyp: Zeichenfolge
    artikel.nummer Nummer des Wissensartikels.

    Datentyp: Zeichenfolge
    artikel.rang Suchrang des für diese Suche spezifischen Artikels.

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

    Datentyp: Zeichenfolge
    artikel.snippet Text, der einen kleinen Teil des Wissensartikels zeigt.

    Datentyp: Zeichenfolge
    Artikel.Titel Kurzbeschreibung oder Titel des Wissensartikels.

    Datentyp: Zeichenfolge
    meta Metainformationen 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.end Endindex des Ergebnissatzes.

    Datentyp: Zahl
    meta.fields Felder im Artikel.

    Datentyp: Zeichenfolge
    meta.filter Filter, der zum Erfassen der Daten verwendet wird.

    Datentyp: Zeichenfolge
    meta.kb Liste der sys_ids der Knowledge Base-Artikel.

    Datentyp: Zeichenfolge
    meta.language Liste der kommagetrennten Sprachen der KB-Artikel, die angefordert wurden.

    Datentyp: Zeichenfolge
    meta.query 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"
      }
    ]
  }
}