Script Debugger-API

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 6 Minuten Lesedauer

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

    Weitere Informationen zum Script Debugger finden Sie unter Script 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. in einer Business-Regel oder 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 Anwender, der die Anforderung ausgeführt hat, hat keine Berechtigung zum Zugriff auf Haltepunkt- oder Protokollpunktinformationen für den angegebenen Datensatz.

    Parameter des Antworttexts (JSON oder XML)

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

    Datentyp: Boolesch
    Debugpunkte 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> .evaluationString Text des Haltepunkts. Wenn der Haltepunkt bedingt ist, enthält die Bewertungszeichenfolge 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
    Debugpunkte.Protokollpunkt 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
    Debugpunkte.Protokollpunkt<line_number> Zeilennummer für den Protokollpunkt.
    <line_number>: {
  "evaluationString": "String"
  "sysId": "String"
}

    Datentyp: Objekt
    Debugpunkte.Protokollpunkt<line_number> .evaluationString Text des Protokollpunkts. Enthält die protokollierte Nachricht.

    Datentyp: Zeichenfolge
    Debugpunkte.Protokollpunkt<line_number> .sysId Sys_id des Protokollpunkts.

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

    Datentyp: Objekt
    Schlüssel.Skriptfeld Name des Felds, das das Skript enthält.

    Datentyp: Zeichenfolge
    Schlüssel.Skript-ID Sys_id des Skripts.

    Datentyp: Zeichenfolge
    Schlüssel.Skripttyp Name der Tabelle, die das Skript enthält.

    Datentyp: Zeichenfolge
    Schlüssel.Wert Die Pfadparameter, die zum Stellen der Anforderung verwendet werden. In der folgenden Reihenfolge aufgeführt.
    • 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 enthält 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"
    }
  }
}

    Script Debugger – POST js/debugpoints/process

    Sie können Haltepunkte oder Protokollpunkte in einem serverseitigen Skript wie einer Business-Regel oder einer Skripteinbindung hinzufügen, aktualisieren oder entfernen. 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
    fetchAll Bei „wahr“ wird eine Liste aller vom Anwender hinzugefügten oder aktualisierten Haltepunkte oder Protokollpunkte zurückgegeben.

    Datentyp: Boolesch

    Standardwert: false
    abrufenAlleFilter

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

    Gültige Werte:
    • debugpointType Legen Sie entweder einen Haltepunkt oder einen Protokollpunkt fest.
    • scriptId Legen Sie dies auf die sys_id des Skripts fest, in dem nach Debug-Punkten gesucht werden soll.
    • Umfang. 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 Debug-Punkts, der hinzugefügt, gelöscht oder aktualisiert werden soll.

    Gültige Werte:
    • breakpoint
    • Protokollpunkt

    Datentyp: Zeichenfolge
    Auswertungszeichenfolge

    Text für einen Protokollpunkt oder bedingten Haltepunkt.

    Bei einem Protokollpunkt ist evaluationString die Protokollnachricht.

    Bei einem bedingten Haltepunkt ist evaluationString die Bedingung. Wenn Sie beispielsweise eine Liste von Anwender-IDs durchlaufen und möchten, dass der Debugger nur dann angehalten wird, wenn die Anwender-ID 38493 lautet, können Sie innerhalb der Schleife einen bedingten Haltepunkt mit der Bedingung „userID == 38493“ hinzufügen. Der Debugger wird an diesem Haltepunkt nur angehalten, wenn die Bedingung „wahr“ 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. Für den Haltepunkt oder Protokollpunkt auszuführender Vorgang.
    Gültige Werte:
    • Hinzufügen
    • delete
    • 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.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    angeforderteDebugpunkte 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
    RequestedDebugpoints.ScriptId Sys_id für das serverseitige Skript.

    Datentyp: Zeichenfolge
    RequestedDebugpoints.evaluationString Text, der für einen Protokollpunkt oder bedingten Haltepunkt hinzugefügt wurde. Bei einem Protokollpunkt ist evaluationString die Protokollnachricht. Bei einem bedingten Haltepunkt ist evaluationString die Bedingung.

    Datentyp: Zeichenfolge
    hat Debugpunkte.Vorgang angefordert

    Für den Haltepunkt oder Protokollpunkt durchgeführter Vorgang.

    Mögliche Werte:
    • Hinzufügen
    • delete
    • Aktualisieren

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

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

    Datentyp: Zeichenfolge
    hat Debugpunkte.Status angefordert

    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:
    • Es fordert das Löschen eines nicht vorhandenen Haltepunkts oder Protokollpunkts an.
    • Fordert das Hinzufügen eines Haltepunkts oder Protokollpunkts an, der mit einem bereits vorhandenen identisch ist.

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

    Datentyp: Zahl
    angeforderteDebugpunkte.DebugpunktTyp

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