Skript-Debugger-API

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

    • Die Skript-Debugger -API bietet Endpunkte zum Debuggen von Zeilen von serverseitigem JavaScript-Code, z. B. Business Rules und Skripteinbindungen.

    Weitere Informationen zum Skript-Debugger finden Sie unter Skript-Debugger und Sitzungsprotokoll.

    Diese API ist standardmäßig verfügbar.

    Script Debugger – GET /js/debugpoints/script/{tableName}/{sysId}/{fieldName}

    Rufen Sie eine Liste von Haltepunkten oder Protokollpunkten in einem serverseitigen Skript ab, z. B. eine Business Rule oder eine Skripteinbindung.

    URL-Format

    Standard-URL: /api/now/js/debugpoints/script/{tableName}/{sysId}/{fieldName}

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfadparameter
    Name Beschreibung
    tableName Name der Tabelle, die das serverseitige Skript enthält, z. B. sys_script oder sys_script_include.

    Datentyp: Zeichenfolge
    sysId Sys_id für das serverseitige Skript.

    Datentyp: Zeichenfolge
    fieldName Name des Felds, das den serverseitigen Skriptinhalt enthält.

    Datentyp: Zeichenfolge
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Keine
    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.
    403 Anwender nicht autorisiert. Der Benutzer, der die Anforderung ausgeführt hat, ist nicht berechtigt, auf Haltepunkt- oder Protokollpunktinformationen für den angegebenen Datensatz zuzugreifen.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    canWrite Kennzeichnung, die angibt, ob der aktuell angemeldete Benutzer Haltepunkte für das Skript festlegen oder ändern kann.
    Mögliche Werte:
    • true: Sie können Haltepunkte festlegen oder ändern.
    • false: Sie können keine Haltepunkte festlegen oder ändern.

    Datentyp: Boolesch
    debugpoints Liste aller Haltepunkte und Protokollpunkte im Skript.
    "debugpoints": {
  "breakpoint": {Object}
  "logpoint": {Object}
}

    Datentyp: Objekt
    debugpoints.breakpoint Liste aller Haltepunkte im Skript, dargestellt als Schlüssel-Wert-Paare. Der Schlüssel ist die Zeilennummer für den Haltepunkt. Der Wert ist ein Objekt, das die sys_id und den Text des Haltepunkts enthält.
    "breakpoint": {
  <line_number>: {Object}
}

    Datentyp: Objekt
    debugpoints.breakpoint.<line_number> Zeilennummer für den Haltepunkt.
    <line_number>: {
  "evaluationString": "String"
  "sysId": "String"
}

    Datentyp: Objekt
    debugpoints.breakpoint.<line_number> .evaluationZeichenfolge Text des Haltepunkts. Wenn der Haltepunkt bedingt ist, enthält „evaluationString“ den Bedingungstext. Wenn der Haltepunkt nicht bedingt ist, ist „evaluationString“ eine leere Zeichenfolge.

    Datentyp: Zeichenfolge
    debugpoints.breakpoint.<line_number> .sysId Sys_id des Haltepunkts.

    Datentyp: Zeichenfolge
    debugpoints.logpoint Liste aller Protokollpunkte im Skript, dargestellt als Schlüssel-Wert-Paare. Der Schlüssel ist die Zeilennummer für den Protokollpunkt. Der Wert ist ein Objekt, das die sys_id und den Text des Protokollpunkts enthält.
    "logpoint": {
  <line_number>: {Object}
}

    Datentyp: Objekt
    debugpoints.logpoint.<line_number> Zeilennummer für den Protokollpunkt.
    <line_number>: {
  "evaluationString": "String"
  "sysId": "String"
}

    Datentyp: Objekt
    debugpoints.logpoint.<line_number> .evaluationZeichenfolge Text des Protokollpunkts. Enthält die protokollierte Nachricht.

    Datentyp: Zeichenfolge
    debugpoints.logpoint.<line_number> .sysId Sys_id des Protokollpunkts.

    Datentyp: Zeichenfolge
    key Objekt mit Details zum zu debuggenden Skript. 
    "key": {
  "scriptField": "String"
  "scriptId": "String"
  "scriptType": "String"
  "value": "String"
}

    Datentyp: Objekt
    key.scriptField Name des Felds, das das Skript enthält.

    Datentyp: Zeichenfolge
    key.scriptId Sys_id des Skripts.

    Datentyp: Zeichenfolge
    key.scriptType Name der Tabelle, die das Skript enthält.

    Datentyp: Zeichenfolge
    Schlüssel.Wert Die für die Anforderung verwendeten Pfadparameter. In der folgenden Reihenfolge aufgelistet.
    • tableName
    • sysId
    • fieldName

    Datentyp: Zeichenfolge
    Name Name des Antwortskripts.

    Datentyp: Zeichenfolge
    Skript Text, der den Code des Skripts anzeigt.

    Datentyp: Zeichenfolge

    Beispiel für eine cURL-Anforderung

    cURL-Anforderung

    Ruft eine Liste von Protokollpunkten und Haltepunkten für ein serverseitiges Skript ab. Dieses Skript hat einen Protokollpunkt in Zeile 2, einen Haltepunkt in Zeile 11 und einen bedingten Haltepunkt in Zeile 18.

    curl "https://instance.servicenow.com/api/now/js/debugpoints/script/sys_script_include/d65f78c40a0a0b6900196656f35913d3/script" \
--request GET \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--user 'username':'password'
    {
  "result": {
    "canWrite": true,
    "debugpoints": {
      "LOGPOINT": {
        "2": {
          "evaluationString": "A log message",
          "sysId": "ba28b0fa739310101c233096fbf6a75e"
        }
      },
      "BREAKPOINT": {
        "11": {
          "evaluationString": "",
          "sysId": "dc5f5bf341256010f877587fbdf5ec1d"
        },
        "18": {
          "evaluationString": "a == true",
          "sysId": "3d4f5bf341256010f877587bdf5ecf6"
        }
      }
    },
    "script": "// script code",
    "name": "AbstractAjaxProcessor",
    "key": {
      "scriptType": "sys_script_include",
      "scriptId": "d65f78c40a0a0b6900196656f35913d3",
      "scriptField": "script",
      "value": "sys_script_include.d65f78c40a0a0b6900196656f35913d3.script"
    }
  }
}

    Skript-Debugger – POST js/debugpoints/process

    Fügen Sie Haltepunkte oder Protokollpunkte in einem serverseitigen Skript hinzu, aktualisieren oder entfernen Sie sie, z. B. eine Business Rule oder eine Skripteinbindung. Verarbeiten Sie mehrere Haltepunkte oder Protokollpunkte gleichzeitig.

    URL-Format

    Standard-URL: /api/now/js/debugpoints/process

    Unterstützte Anforderungsparameter

    Tabelle : 7. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 8. Abfrageparameter
    Name Beschreibung
    abrufenAlle Bei „true“ wird eine Liste aller vom Benutzer hinzugefügten oder aktualisierten Haltepunkte oder Protokollpunkte zurückgegeben.

    Datentyp: Boolesch

    Standardwert: false
    abrufenAlleFilter

    Gibt eine gefilterte Liste aller vom Benutzer hinzugefügten oder aktualisierten Haltepunkte oder Protokollpunkte zurück.

    Gültige Werte:
    • debugpointType. Legen Sie ihn entweder auf einen Haltepunkt oder einen Protokollpunkt fest.
    • scriptId Auf die sys_id des Skripts festgelegt, in dem nach Debug-Punkten gesucht werden soll.
    • Bereich. Legen Sie den Namen des Bereichs fest, in dem nach Debug-Punkten gesucht werden soll.

    Verwenden Sie das Caret-Symbol (^) als Trennzeichen für mehrere Eigenschaften. Beispiel: fetchAllFilter=debugpointType=logpoint^scope=MyApp

    Datentyp: Zeichenfolge
    Tabelle : 9. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    debugpointType

    Erforderlich. Typ des hinzuzufügenden, zu löschenden oder zu aktualisierenden Debug-Punkts.

    Gültige Werte:
    • breakpoint
    • Protokollpunkt

    Datentyp: Zeichenfolge
    assessmentZeichenfolge

    Text für einen Protokollpunkt oder bedingten Haltepunkt.

    Für einen Protokollpunkt ist evaluationString die Protokollnachricht.

    Für einen bedingten Haltepunkt ist evaluationString die Bedingung. Wenn Sie beispielsweise eine Liste von Benutzer-IDs durchlaufen und möchten, dass der Debugger nur angehalten wird, wenn die Benutzer-ID 38493 lautet, können Sie innerhalb der Schleife einen bedingten Haltepunkt mit Benutzer-ID == 38493 als Bedingung hinzufügen. Der Debugger hält nur an diesem Haltepunkt an, wenn die Bedingung erfüllt ist.

    Wenn der Haltepunkt kein bedingter Haltepunkt ist, ist evaluationString eine leere Zeichenfolge.

    Datentyp: Zeichenfolge
    fieldName Erforderlich. Name des Felds, das den serverseitigen Skriptinhalt enthält.

    Datentyp: Zeichenfolge
    zeilennummer Zeilennummer im serverseitigen Skript, die angibt, wo der Haltepunkt oder Protokollpunkt hinzugefügt, gelöscht oder aktualisiert werden soll.

    Datentyp: Zahl
    operation Erforderlich. Vorgang, der für den Haltepunkt oder Protokollpunkt ausgeführt werden soll.
    Gültige Werte:
    • Hinzufügen
    • löschen
    • Aktualisieren

    Datentyp: Zeichenfolge
    scriptId Erforderlich. Sys_id für das serverseitige Skript.

    Datentyp: Zeichenfolge
    tableName Erforderlich. Name der Tabelle, die das serverseitige Skript enthält, z. B. sys_script oder sys_script_include.

    Datentyp: Zeichenfolge

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

    Standard: application/json
    Content-Type Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml.

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

    Tabelle : 12. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    angeforderte Debugpunkte Liste der angeforderten Haltepunkte und Protokollpunkte. Wird als Array von Objekten dargestellt.
    "requestedDebugpoints": [
  {
    "scriptId": "String",
    "evaluationString": "String",
    "operation": "String",
    "tableName": "String",
    "fieldName": "String",
    "status": "String",
    "lineNumber": Number,
    "debugpointType": "String"
  }
]

    Datentyp: Array
    angeforderteDebugpunkte.Skript-ID Sys_id für das serverseitige Skript.

    Datentyp: Zeichenfolge
    angeforderteDebugpoints.evaluationZeichenfolge Für einen Protokollpunkt oder bedingten Haltepunkt hinzugefügter Text. Für einen Protokollpunkt ist evaluationString die Protokollnachricht. Für einen bedingten Haltepunkt ist evaluationString die Bedingung.

    Datentyp: Zeichenfolge
    angeforderteDebugpoints.operation

    Vorgang, der für den Haltepunkt oder Protokollpunkt ausgeführt wird.

    Mögliche Werte:
    • Hinzufügen
    • löschen
    • Aktualisieren

    Datentyp: Zeichenfolge
    angeforderte Debugpunkte.Tabellenname Name der Tabelle, die das serverseitige Skript enthält, z. B. sys_script oder sys_script_include.

    Datentyp: Zeichenfolge
    angeforderteDebugpoints.fieldName Name des Felds, das den serverseitigen Skriptinhalt enthält.

    Datentyp: Zeichenfolge
    angeforderteDebugpoints.status

    Ergebnis der Anweisung zum Hinzufügen, Löschen oder Aktualisieren eines bestimmten Haltepunkts oder Protokollpunkts.

    Mögliche Werte:
    • Fehler
    • ignored
    • Erfolg
    Eine Anforderung zum Hinzufügen, Löschen oder Aktualisieren eines Debug-Punkts wird in den folgenden Situationen ignoriert:
    • Sie fordert zum Löschen eines Haltepunkts oder Protokollpunkts an, der nicht vorhanden ist.
    • Sie fordert das Hinzufügen eines Haltepunkts oder Protokollpunkts an, der mit einem bereits vorhandenen identisch ist.

    Datentyp: Zeichenfolge
    angeforderteDebugpoints.lineNumber Zeilennummer im serverseitigen Skript, die angibt, wo der Haltepunkt oder Protokollpunkt hinzugefügt, gelöscht oder aktualisiert wurde.

    Datentyp: Zahl
    angeforderteDebugpoints.debugpointType

    Typ des hinzugefügten, gelöschten oder aktualisierten Debug-Punkts.

    Mögliche Werte:
    • breakpoint
    • Protokollpunkt

    Datentyp: Zeichenfolge
    status Ergebnis der Gesamtaktion. Der Statuscode für den HTTP-Aufruf.

    Datentyp: Zahl

    cURL-Anforderung

    In diesem Beispiel wird ein bedingter Haltepunkt in Zeile 12 im Skript hinzugefügt.

    curl "https://instance.servicenow.com/api/now/js/debugpoints/process" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data “[
{
\"tableName\": \"sys_script_include\",
\"scriptId\": \"d65f78c40a0a0b6900196656f35913d3\",
\"fieldname\": \"script\",
\"lineNumber\": 12,
\"evaluationString\": \"a == false\",
\"debugpointType\": \"breakpoint\",
\"operation\": \"add\"
}
]” \
--user 'username':'password'
    {
  "result": {
    "requestedDebugpoints": [
      {
        "scriptId": "d65f78c40a0a0b6900196656f35913d3",
        "evaluationString": "a == false",
        "operation": "add",
        "tableName": "sys_script_include",
        "fieldName": "script",
        "status": "success",
        "lineNumber": 12,
        "debugpointType": "breakpoint"
      }
    ],
    "status": 200
  }
}