API für kontinuierliche Integration/kontinuierliche Bereitstellung (CICD)

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 66 Minuten Lesedauer

    • Die CICD Die API stellt Endpunkte bereit, die die Integration mit Common ermöglichen DevOps Tools zum Erstellen von Pipelines. Diese Tools umfassen Jenkins, Azure Pipelines, GitLab, GitHub Actions, Atlassian Bambus/Pipelines und mehr.

    Es bietet Integratoren die Möglichkeit, zu erstellen CICD Pipelines für ServiceNow AI Platform Anwendungen, die durch Abruf-/Zusammenführungsanforderungs-Workflows gesteuert werden, typisch für die quellengesteuerte Entwicklung. Sie nutzt die Quellcodeverwaltung, das Anwendungs-Repository und Automated Test Framework Funktionen.

    Die CI/CD Die API stellt die folgenden Produkt- und Funktionsbereiche bereit:

    • Quellcodeverwaltung

      Wenden Sie Remote-Changes für eine Anwendung an, die über die Funktion „Quellcodeverwaltung“ in Studio mit einem Remote-Git-Repository verknüpft ist, auf einer bestimmten Instanz.

      Importiert eine Anwendung mit der angegebenen Repository-URL und dem angegebenen Verzweigungsnamen.

    • Anwendungs-Repository: Verfügbar für bereichsbezogene Anwendungen, globale Anwendungen, Anwendungsanpassungen für bereichsbezogene Anwendungen auf der ServiceNow Store, Und über Plugins.
      • Veröffentlichen Sie eine Anwendung aus einer Instanz im verbundenen Anwendungs-Repository.
      • Installieren Sie eine Anwendung auf einer Instanz aus dem verbundenen Anwendungs-Repository.
      • Rollback einer Anwendung durchführen, die über den Rollback-Kontext installiert wurde.
    • Batch
      • Definieren Sie eine JSON-Manifestdatei, um mehrere Anwendungen zusammen im Batch-Modus zu installieren.
      • Rollback für die gesamte Batch-Installation über den Rollback-Kontext durchführen.
      • Gibt die Ergebnisse einer Batch-Installation basierend auf einem angegebenen Ergebnisbezeichner zurück.
    • Plugins
      • Aktivieren Sie ein Plugin.
      • Rollback eines Plugins über Rollback-Kontext durchführen.
    • Automated Test Framework (ATF)
      • Starten Sie eine ATF-Test-Suite.
      • Erhalten Sie das Ergebnis „Bestanden/Fehlschlagen“ einer ATF-Test-Suite.
    • Instanzscan
      • Starten Sie einen Instanzscan (vollständiger Punktscan in der Tabelle, Punktscan im Datensatz, bereichsbezogene Anwendung, Update-Satz, Kombination dieser Elemente).
      • Ruft das Ergebnis „Bestanden/Fehlschlagen“ einer Instanz-Scan-Ausführung ab.
    • Fortschritt

      Ruft den Prozentsatz der Fertigstellung für eine Instanz für Prozesse ab, die von anderen Endpunktaufrufen initiiert wurden. Mit dieser Funktion können Sie bis zum Abschluss abfragen, bevor Sie mit dem nächsten Schritt fortfahren.

    Diese API verwendet ein asynchrones Antwortmodell. Wenn Sie einen Endpunkt aufrufen, z. B. um eine Test-Suite auszuführen /sn_cicd/testsuite/Run , Der Endpunkt startet die zugehörige Funktion, z. B. das Starten der Ausführung der Test-Suite. Der Endpunkt gibt dann eine Antwortnachricht zurück, die normalerweise den Ausführungsstatus der angeforderten Funktion enthält Ausstehend , Zusammen mit einem eindeutigen Bezeichner und einem eindeutigen Link. Verwenden Sie diese Informationen, um zusätzliche Informationen über Fortschritt, Quelle, Ergebnisse und/oder Ergebnisse der Anforderung zu erhalten. Je nach Funktionsanforderung können Sie eine der folgenden Methoden verwenden, um zusätzliche Informationen zu einer Anforderung zu erhalten:
    • Rufen Sie an /sn_cicd/Progress/{Progress_ID} Endpunkt, der verwendet links.progress.idParameter, der vom initiierenden Endpunkt zurückgegeben wird.
    • Rufen Sie an /sn_cicd/testsuite/results/{result_ID} Endpunkt, der verwendet links.result.idParameter, der vom initiierenden Endpunkt zurückgegeben wird.
    • Rufen Sie an /sn_cicd/instance_Scan/result/{Progress_ID} Endpunkt, der verwendet links.progress.idParameter, der vom initiierenden Endpunkt zurückgegeben wird.
    • Rufen Sie an /sn_cicd/sc/apply_stash/{stash_ID} Endpunkt, der verwendet links.stash.idParameter, der von zurückgegeben wird /sn_cicd/Progress/{Progress_ID} Endpunkt.
    • Verknüpfen Sie mit links.<progress/result/source/findings>.urlParameter, der vom initiierenden Endpunkt zurückgegeben wird.
    Hinweis:
    Um eine Anwendung aus einem Repository zu installieren, muss die Anwendung zuerst mit im Repository veröffentlicht werden /sn_cicd/App_repo/published Endpunkt. Nach der Veröffentlichung kann jede Instanz, die mit diesem Repository verbunden ist, die Anwendung installieren und ein Rollback durchführen. Wenn die Anwendung nicht zuerst veröffentlicht wird, schlägt die Installationsanforderung fehl.

    Zur Verwendung dieser API ist die Rolle sn_cicd.sys_ci_Automation oder admin erforderlich.

    Beginnt in Tokyo, CICD API-Endpunkte, die abrufen müssen Instanzweite Sperre/Mutex Um den angeforderten Vorgang auszuführen, wird eine Warteschlange verwendet, anstatt Anforderungen abzulehnen, während der Instanzweite Sperre/Mutex Ist belegt. Mehrere CICD Pipelines stellen gleichzeitig Anforderungen, ohne die Ablehnung zu erkennen und es erneut zu versuchen, und können stattdessen einfach den Fortschritt überwachen, wie zuvor bei erfolgreichen Anforderungen. Dieses Verhalten ist standardmäßig aktiviert.

    Die aktuelle Warteschlange kann von einem Anwender mit der Administratorrolle überprüft werden, indem er zu navigiert Systemdiagnose ->Warteschlange Für Anwendungsvorgänge . Von hier aus kann die Warteschlange vom Administrator angehalten und fortgesetzt werden, um andere manuelle Vorgänge zu ermöglichen, die möglicherweise erfordern Instanzweite Sperre/Mutex .
    Hinweis:
    Wenn angehalten, wird jeder laufende Vorgang bis zum Abschluss ausgeführt, es wird jedoch kein neuer Vorgang gestartet. Die API akzeptiert weiterhin neue Anforderungen und stellt sie in die Warteschlange. Ein ausstehender Vorgang kann auch abgebrochen werden, bevor er ausgeführt wird, indem der aufgeführte Ausführungstracker auf den Status „Abgebrochen“ aktualisiert wird. Wenn ein Vorgang aus irgendeinem Grund nach der in „com.Glide.Update_Operation.Job_Cancel_timeout_minutes“ angegebenen Zeitüberschreitung nicht fortgesetzt werden kann (Standard: 48 Stunden), wird er abgebrochen.
    Wenn ein Upgrade geplant ist, wechselt die Warteschlange zwei Stunden vor dem Upgrade in den Status „Upgrade angehalten“, es sei denn, dies wird durch die Eigenschaft com.Glide.Update_Operation.Queue_Upgrade_window überschrieben. Dadurch kann jeder laufende Vorgang abgeschlossen werden, bevor das Upgrade beginnt.
    Hinweis:
    Die Warteschlange wird automatisch fortgesetzt, wenn das Upgrade abgeschlossen ist.
    Für zusätzliche Informationen zu CICD, Siehe:

    CI/CD – GET /sn_cicd/App/Batch/results/{result_ID}

    Gibt die Ergebnisse einer Batch-Installation basierend auf einem angegebenen Ergebnisbezeichner zurück.

    Rufen Sie diese Methode auf, nachdem Sie aufgerufen haben /sn_cicd/App/Batch/install Endpunkt zum Abrufen der Ergebnisse der Batch-Installation. Verwenden Sie den in zurückgegebenen Wert links.results.idParameter der Rückgabeergebnisse von /sn_cicd/App/Batch/install Endpunkt als result_idFür diesen Endpunkt. Sie können auch anrufen /api/sn_cicd/Progress/{Progress_ID} Endpunkt zum Abrufen von Informationen zum Fortschritt der Installation, falls sie noch nicht abgeschlossen wurde.

    URL-Format

    Versionierte URL: /api/sn_cicd/{api_Version}/App/Batch/results/{result_ID}

    Standard-URL: /api/sn_cicd/App/Batch/results/{result_ID}

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    result_id SYS_ID der Batch-Installation, für die Ergebnisinformationen zurückgegeben werden sollen. Dieser Wert wird in zurückgegeben links.results.idParameter von /sn_cicd/App/Batch/install Endpunkt.

    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 REST API-HTTP-Antwortcodes .

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Die Anwenderanmeldeinformationen sind falsch.
    403 Unzulässig. Der Anwender ist kein Administrator oder verfügt nicht über die Rolle „sn_cicd.sys_ci_Automation“.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    405 Ungültige Methode. Die Funktionalität ist inaktiv.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Fehler Fehlermeldung mit Details zum Fehler.

    Datentyp: Zeichenfolge
    batch_items JSON-Array, in dem jedes Objekt Details zu einer Paketinstallation bereitstellt.

    Datentyp: Array

    "batch_items" [{
  "customization_version": "String",
  "id": "String",
  "install_date": "String",
  "name": "String",
  "notes": "String",
  "state": "String",
  "status_message": "String",
  "type": "String",
  "url": "String",
  "version": "String" 
}]
    Batch_items.Customization_Version Gilt nur, wenn batch_items.typeParameter ist auf festgelegt Anwendung Oder Plugin Und requested_customization_versionParameter wird in der Batch-Installationsanforderung übergeben. Version der Store-Anwendung oder bereichsbezogen ServiceNow Zu installierendes Plugin-Anpassungspaket, z. B. 1.0.2 oder 2,3.

    Datentyp: Zeichenfolge
    Batch_items.ID SYS_ID der Anwendung oder Bezeichner des zu installierenden Plugins. Identisch mit packages.idParameter in initiierend /sn_cicd/App/Batch/install Endpunktaufruf.

    Datentyp: Zeichenfolge
    batch_items.install_date Datum und Uhrzeit der Installation des Pakets. Leer, wenn die Anforderung noch ausgeführt wird.

    Datentyp: Zeichenfolge
    batch_items.name Name des Pakets.

    Datentyp: Zeichenfolge
    batch_items.notes Vom Anwender angegebene Hinweise zum Paket. Identisch mit packages.notesParameter in initiierend /sn_cicd/App/Batch/install Endpunktaufruf.

    Datentyp: Zeichenfolge
    Batch_items.State Aktueller Status der zugehörigen Paketinstallation.
    Mögliche Werte:
    • Fehlgeschlagen
    • In Bearbeitung
    • Installiert
    • Ungültig
    • Bereit
    • Zurückgesetzt

    Datentyp: Zeichenfolge
    Batch_items.Status_message Beschreibt alle Fehler, die während der Installation des Pakets und/oder Anpassungen aufgetreten sind.

    Datentyp: Zeichenfolge
    Batch_items.type Typ der Anwendung. Identisch mit packages.typeParameter in initiierend /sn_cicd/App/Batch/install Endpunktaufruf.
    Gültige Werte:
    • Anwendung
    • Plugin

    Datentyp: Zeichenfolge
    Batch_items.url URL des zugehörigen Paketinstallationsdatensatzes auf Ihrem ServiceNow Instanz.

    Datentyp: Zeichenfolge
    Batch_items.Version Version des zu installierenden Pakets, z. B. 1.0.2 oder 2,3. Identisch mit packages.requested_versionParameter in initiierend /sn_cicd/App/Batch/install Endpunktaufruf.

    Datentyp: Zeichenfolge
    batch_plan Beschreibt den Installations-Batch-Plan.

    Datentyp: Objekt

    "batch_plan": {
  "id": "String",
  "name": "String",
  "notes": "String",
  "state": "String",
  "url": "String"
}
    Batch_Plan.ID SYS_ID der Rückgabeergebnisinformationen. Gleicher Wert wie der, der in übergeben wurde result_idAnforderungsparameter.

    Datentyp: Zeichenfolge
    batch_plan.name Vom Anwender angegebener beschreibender Name für diese Batch-Anforderung. Identisch mit nameParameter in initiierend /sn_cicd/App/Batch/install Endpunktaufruf.

    Datentyp: Zeichenfolge
    batch_plan.notes Hinweise, die beim Aufruf der Batch-Installation übergeben wurden. Identisch mit notesParameter in initiierend /sn_cicd/App/Batch/install Endpunktaufruf.

    Datentyp: Zeichenfolge
    Batch_Plan.State Aktueller Status der gesamten Batch-Installation.
    Mögliche Werte:
    • Fehlgeschlagen
    • In Bearbeitung
    • Installiert
    • Ungültig
    • Partielle Installation
    • Bereit
    • Zurückgesetzt

    Datentyp: Zeichenfolge
    Batch_Plan.url URL des Batch-Installationsplandatensatzes auf Ihrem ServiceNow Instanz.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    In diesem Beispiel wird der Status eines Batch-Installationsplans mit der Bezeichnung Release 2,0 IT Operations überprüft.

    curl 'instance.servicenow.com/api/sn_cicd/app/batch/results/df24b1e9db2d0110b5e3f6c5ae97c561 \
--request GET \
--header 'Accept: application/json' \
--user 'username':'password' 
    {
"result": {
  "batch_plan": {
    "name":“Release 2.0 IT Operations”,
    "id": "df24b1e9db2d0110b5e3f6c5ae97c561",
    "url": "https://instance.service-now.com/sys_batch_install_plan.do?sys_id=df24b1e9db2d0110b5e3f6c5ae97c561",
    "state": "Installed",
    "notes": "User specified notes for batch install plan",
  }
  "batch_items": [
    {
      "name": "com.sn_cicd_spoke",
      "type": "Application",
      "version": "7.0.0",
      "state": "Installed",
      "install_date": "2020-08-31 15:30:01",
      "id": "c159b1e9db1c0010b5e3f6c5ae961903",
      "url":"https://instance.service-now.com/sys_batch_install_item.do?sys_id=c159b1e9db1c0010b5e3f6c5ae961903",
      "notes" : ""
    },
    {
      "name": "Customization for CSM App1",
      "type": "Application",
      "version": "1.0.0",
      "state": "Installed",
      "install_date": "2020-08-31 15:32:01",
      "id": "e824b1e9db2d1001b5e3f6c5ae97d628",
      "url": "https://instance.service-now.com/sys_batch_install_item.do?sys_id=e824b1e9db2d1001b5e3f6c5ae97d628",
      "notes": "Customized headers.",
      "customization_version": "2.1.1”,
      "status_message": ""

    }]
  }
}

    CI/CD – GET /sn_cicd/instance_Scan/result/{Progress_ID}

    Gibt den aktuellen Fortschritt und Status der CI/CD-Instanz-Scan-Funktion zurück, die einer übergebenen Fortschritts-ID zugeordnet ist. Rufen Sie diese Methode auf, nachdem Sie einen der anderen CI/CD-Endpunkte des Instanzscans aufgerufen haben, z. B. /sn_cicd/instance_Scan/Full_Scan Oder /sn_cicd/instance_Scan/Point_Scan .

    Hinweis:
    Dieser Endpunkt ist Teil von Ausführungsservice für CICD-Instanz-Scan API und wird unter verwendet sn_cicd Namespace.

    URL-Format

    Versionierte URL: /api/sn_cicd/{api_Version}/instance_Scan/result/{Progress_ID}

    Standard-URL: /api/sn_cicd/instance_Scan/result/{Progress_ID}

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

    Unterstützte Anforderungsparameter

    Tabelle : 7. Parameter
    Parameter 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
    progress_id Eindeutiger Bezeichner der Funktion, für die Fortschrittsinformationen zurückgegeben werden sollen. Dieser Wert wird in zurückgegeben links.progress.idParameter des Endpunkts, der die Aktion initiiert hat, z. B. /sn_cicd/instance_Scan/Full_Scan Oder /sn_cicd/instance_Scan/Point_Scan .

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

    Standard: application/json
    Tabelle : 9. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    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. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Die Anwenderanmeldeinformationen sind falsch.
    403 Unzulässig. Der Anwender ist kein Administrator oder verfügt nicht über die Rolle „sn_cicd.sys_ci_Automation“.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

    Anforderungstext

    Die API akzeptiert diese JSON- oder XML-Elemente im Anforderungstext.

    Tabelle : 11. Im Anforderungstext akzeptierte Elemente
    Elemente Beschreibung
    Keine

    Antwort-Haupttext

    Die API gibt diese JSON- oder XML-Elemente im Antwort-Haupttext zurück.

    Tabelle : 12. Im Antwort-Haupttext zurückgegebene Elemente
    Elemente Beschreibung
    Fehler Fehlermeldung mit Details zum Fehler.

    Datentyp: Zeichenfolge
    Links Informationen zu Links und sys_IDs, die dem Update-Satz zugeordnet sind.

    Datentyp: Objekt

    "links": {
  "progress": {Object}
}
    Links.Ergebnisse Objekt, das Informationen zu den Instanzscanergebnissen enthält.
    Links.Ergebnisse.Bezeichnung Zusätzliche Informationen zu den Ergebnissen des Instanz-Scans.
    Links.Ergebnisse.url URL, die zum Abrufen einer Liste von Datensätzen verwendet werden soll, die gegen die Prüfungen verstoßen.
    links.progress Fortschrittsinformationen zum Vorgang, der für den Update-Satz ausgeführt wird.

    Datentyp: Objekt

    "progress": {
  "id": "String",
  "url": "String"
}
    links.progress.id Eindeutiger Bezeichner des Fortschrittsdetails.
    links.progress.url URL, die zum Abrufen der Fortschrittsdetails des für den Update-Satz ausgeführten Vorgangs verwendet werden soll.

    Datentyp: Zeichenfolge
    Links.Ergebnisse ID und URL der Ausführungsergebnisse.

    Datentyp: Objekt

    "results": {
  "id": "String",
  "url": "String"
}
    links.results.id SYS_ID des Datensatzes der Instanz-Scan-Ergebnisse.
    Links.Ergebnisse.url URL, die zum Abrufen der Ergebnisse des Instanzscans verwendet werden soll.
    status Zahl, die den Ausführungsstatus der Aktion darstellt, die für den Update-Satz ausgeführt wird. Entspricht status_labelDeskriptor.
    Mögliche Werte:
    • 0: Ausstehend
    • 1: Wird Ausgeführt
    • 2: Erfolgreich
    • 3: Fehlgeschlagen
    • 4: Abgebrochen

    Datentyp: Zeichenfolge
    status_detail Detaillierte Nachricht zum Ausführungsstatus, falls verfügbar. Entspricht dem Feld Detailed_message in der Tabelle „Ausführungstracker“ [sys_Execution_Tracker].

    Datentyp: Zeichenfolge
    status_label Ausführungsstatus der Update-Satz-Aktion. Entspricht statusNummer.
    Mögliche Werte:
    • Abgebrochen
    • Fehlgeschlagen
    • Ausstehend
    • Wird ausgeführt
    • Erfolgreich

    Datentyp: Zeichenfolge
    status_message Zusätzliche Informationen dazu, warum der Vorgang fehlgeschlagen ist. Gibt eine leere Zeichenfolge zurück, wenn der Vorgang erfolgreich ist.

    Datentyp: Zeichenfolge

    Beispiel für eine cURL-Anforderung

    curl 'instance.service-now.com/api/sn_cicd/instance_scan/result/a74c70a11b7800103d374087bc4bcb28' \
--request GET \
--header 'Accept: application/json' \
--user 'username':'password'
    {
    "result": {
        "links": {
            "findings": {
                "url": "https://instance.service-now.com/api/now/table/scan_finding?sysparm_query%3Dresult%3D6f4cf8651b7800103d374087bc4bcb41%5EORDERBYsys_id",
                "label": "First 10,000 findings"
            },
            "progress": {
                "id": "a74c70a11b7800103d374087bc4bcb28",
                "url": "https://instance.service-now.com/api/sn_cicd/progress/a74c70a11b7800103d374087bc4bcb28"
            },
            "results": {
                "id": "a74c70a11b7800103d374087bc4bcb28",
                "url": "https://instance.service-now.com/api/sn_cicd/instance_scan/result/a74c70a11b7800103d374087bc4bcb28"
            }
        },
        "status": "2",
        "status_label": "Successful",
        "status_message": "",
        "status_detail": "",
        "error": ""
    }
}

    CI/CD – GET /sn_cicd/Progress/{Progress_ID}

    Gibt den aktuellen Fortschritt und Status von zurück Kontinuierliche Integration und kontinuierliche Bereitstellung (CICD) Funktion, die einer angegebenen Fortschritts-ID zugeordnet ist.

    Rufen Sie diese Methode auf, nachdem Sie einen der asynchronen CICD-Endpunkte wie aufgerufen haben /sn_cicd/App_repo/published , /sn_cicd/App_repo/install , /sn_cicd/testsuite/Run , Oder /sn_cicd/sc/apply_stash .

    URL-Format

    Versionierte URL: /api/sn_cicd/{api_Version}/Progress/{Progress_ID}

    Standard-URL: /api/sn_cicd/Progress/{Progress_ID}

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    progress_id Eindeutiger Bezeichner der Funktion, für die Fortschrittsinformationen zurückgegeben werden sollen.

    Dieser Wert wird in zurückgegeben links.progress.idParameter des Endpunkts, der die Aktion initiiert hat, z. B. /sn_cicd/App_repo/published , /sn_cicd/App_repo/install , /sn_cicd/testsuite/Run , Oder /sn_cicd/sc/apply_stash .

    Datentyp: Zeichenfolge
    Tabelle : 14. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 15. 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 : 16. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 17. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 18. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Die Anwenderanmeldeinformationen sind falsch.
    403 Unzulässig. Der Anwender ist kein Administrator oder verfügt nicht über die Rolle „sn_cicd.sys_ci_Automation“.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    405 Ungültige Methode. Die Funktionalität ist inaktiv.
    409 Konflikt. Das angeforderte Element ist nicht eindeutig.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Fehler Fehlermeldung mit Details zum Fehler.

    Datentyp: Zeichenfolge
    Links Informationen zu Links und sys_IDs, die dem Update-Satz zugeordnet sind.

    Datentyp: Objekt

    "links": {
  "progress": {Object}
}
    links.progress Fortschrittsinformationen zum Vorgang, der für den Update-Satz ausgeführt wird.

    Datentyp: Objekt

    "progress": {
  "id": "String",
  "url": "String"
}
    links.progress.id SYS_ID mit Fortschrittsdetails für den Vorgang. Sie können diesen Wert beim Aufrufen des Endpunkts verwenden CI/CD – GET /sn_cicd/Progress/{Progress_ID}.

    Datentyp: Zeichenfolge
    links.progress.url URL, die zum Abrufen der Fortschrittsdetails des für den Update-Satz ausgeführten Vorgangs verwendet werden soll.

    Datentyp: Zeichenfolge
    Links.Ergebnisse ID und URL der Ausführungsergebnisse.

    Datentyp: Objekt

    "results": {
  "id": "String",
  "url": "String"
}
    links.results.id SYS_ID der Ergebnisinformationen. Verwenden Sie diesen Wert, wenn Sie den zugehörigen Ergebnisendpunkt aufrufen.

    Datentyp: Zeichenfolge
    Links.Ergebnisse.url URL, die zum Abrufen der Ergebnisse der Endpunktausführung verwendet werden soll.

    Datentyp: Zeichenfolge
    Links.Quelle SYS_ID- und URL-Informationen zum Quelldatensatz in der Tabelle „Ausführungstracker“ [sys_Execution_Tracker].

    Datentyp: Objekt

    "source": {
  "id": "String",
  "url": "String"
}
    links.source.id Eindeutiger Bezeichner des Quelldatensatzes.

    Tabelle: Ausführungstracker-Tabelle [sys_Execution_Tracker]

    Datentyp: Zeichenfolge
    Links.Quelle.url URL, die zum Abrufen der Quellinformationen in der Tabelle „Ausführungstracker“ [sys_Execution_Tracker] verwendet werden soll.

    Datentyp: Zeichenfolge
    Links.Stash Ob während eines erstellt wurde Apply_Changes Vorgang: Dieses Objekt enthält Informationen zum Stash. Dieses Objekt wird nicht zurückgegeben, wenn kein Stash erstellt wurde.

    Datentyp: Objekt

    "stash": { 
 "id": "String",
 "url": "String"
}
    links.stash.id Eindeutiger Bezeichner des erstellten Stash. Verwenden Sie diesen Wert, wenn Sie aufrufen CI/CD – POST /sn_cicd/sc/apply_stash/{stash_ID} Endpunkt, um den Stash anzuwenden.

    Datentyp: Zeichenfolge
    Links.Stash.url URL des zugeordneten Stash.

    Datentyp: Zeichenfolge
    percent_complete Prozentsatz der abgeschlossenen Anforderung.

    Datentyp: Zahl
    Status Zahl, die den Ausführungsstatus der Aktion darstellt, die für den Update-Satz ausgeführt wird. Entspricht status_labelDeskriptor.
    Mögliche Werte:
    • 0: Ausstehend
    • 1: Wird Ausgeführt
    • 2: Erfolgreich
    • 3: Fehlgeschlagen
    • 4: Abgebrochen

    Datentyp: Zeichenfolge
    status_detail Detaillierte Nachricht zum Ausführungsstatus, falls verfügbar. Entspricht dem Feld Detailed_message in der Tabelle „Ausführungstracker“ [sys_Execution_Tracker].

    Datentyp: Zeichenfolge
    status_label Ausführungsstatus der Update-Satz-Aktion. Entspricht statusNummer.
    Mögliche Werte:
    • Abgebrochen
    • Fehlgeschlagen
    • Ausstehend
    • Wird ausgeführt
    • Erfolgreich

    Datentyp: Zeichenfolge
    status_message Zusätzliche Beschreibung des aktuellen Status der Aktion, falls verfügbar.

    Datentyp: Zeichenfolge

    Ruft den Fortschritt einer Test-Suite-Ausführung ab

    curl 'instance.servicenow.com/api/sn_cicd/progress/a4fae8911bdc00103d374087bc4bcbbd' \
--request GET \
--header 'Accept: application/json' \
--user 'username':'password'

    Fortschritt des Aufrufs „Changes anwenden“.

    {
    "result": {
        "links": {
            "progress": {
                "id": "a4fae8911bdc00103d374087bc4bcbbd",
                "url": "https://instance.servicenow.com/api/sn_cicd/progress/a4fae8911bdc00103d374087bc4bcbbd"
            },
            "source": {
                "id": "59c4c4d11b5c00103d374087bc4bcb26",
                "url": "https://instance.servicenow.com/api/now/table/sys_app/59c4c4d11b5c00103d374087bc4bcb26"
            }
        },
        "status": "2",
        "status_label": "Successful",
        "status_message": "This operation succeeded",
        "status_detail": "Successfully applied commit 1f14e11a7dedcbfa194beb5875fcdaa15ed8accb from source control",
        "error": "",
        "percent_complete": 100
    }
}

    Ruft den Fortschritt eines Aufrufs zum Anwenden von Changes ab. In diesem Fall gab es nicht gespeicherte/nicht bestätigte Änderungen an der Instanz in Studio, daher wurde ein Stash erstellt, um die nicht gespeicherten Änderungen zu speichern

    curl 'instance.servicenow.com/api/sn_cicd/progress/a4fae8911bdc00103d374087bc4bcbbd' \
--request GET \
--header 'Accept: application/json' \
--user 'username':'password'

    Fortschritt bei der Bereitstellung von Informationen zum erstellten Stash.

    {
"result": {
   "links": {
      "progress": {
         "id": "5b12eca4e0429110f8771827f8fd36a4",
         "url": "https://instance.servicenow.com/api/sn_cicd/progress/5b12eca4e0429110f8771827f8fd36a4"
       },
       "stash": {
         "id": "fc2224e4e0429110f8771827f8fd3634",
         "url": "https://instance.servicenow.com/api/sn_cicd/sc/apply_stash/fc2224e4e0429110f8771827f8fd3634"
}
    },
    "status": "2",
    "status_label": "Successful",
    "status_message": "This operation succeeded",
    "status_detail": "Successfully applied commit fa5626f6f1f7fef677c16b4a0dd8b22ba8a6e311 from source control",
    "error": "",
    "percent_complete": 100
  }
}

    cURL-Anforderung

    curl 'instance.servicenow.com/api/sn_cicd/progress/5b12eca4e0429110f8771827f8fd36a4' \
--request GET \
--header 'Accept: application/json' \
--user 'username':'password'

    Fortschritt einer Test-Suite-Ausführung (/sn_cicd/testsuite/Run).

    {
"result": {
   "links": {
      "progress": {
         "id": "e891389d1b1040103d374087bc4bcb75",
         "url": "https://instance.servicenow.com/api/sn_cicd/progress/e891389d1b1040103d374087bc4bcb75"
       },
       "results": {
         "id": "2891389d1b1040103d374087bc4bcb09",
         "url": "https://instance.servicenow.com/api/sn_cicd/testsuite/results/2891389d1b1040103d374087bc4bcb09"
       }
    },
    "status": "2",
    "status_label": "Successful",
    "status_message": "Suite passed",
    "status_detail": "Suite passed",
    "error": "",
    "percent_complete": 100
  }
}

    CI/CD – GET /sn_cicd/testsuite/results/{result_ID}

    Gibt die Ergebnisse einer Test-Suite-Ausführung basierend auf einem angegebenen Ergebnisbezeichner zurück.

    Rufen Sie diesen Endpunkt nach dem Aufruf an /sn_cicd/Progress/{Progress_ID} Um das Ergebnis der ausgeführten Test-Suite abzurufen.

    URL-Format

    Versionierte URL: /api/sn_cicd/{api_Version}/testsuite/results/{result_ID}

    Standard-URL: /api/sn_cicd/testsuite/results/{result_ID}

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    result_id Eindeutiger Bezeichner der abzurufenden Test-Suite-Ergebnisse. Die entsprechende /sn_cicd/Progress/{Progress_ID} Endpunktaufruf gibt diese Informationen zurück.

    Datentyp: Zeichenfolge
    Tabelle : 20. Abfrageparameter
    Name Beschreibung
    Keine
    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 REST API-HTTP-Antwortcodes .

    Tabelle : 24. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Die Anwenderanmeldeinformationen sind falsch.
    403 Unzulässig. Der Anwender ist kein Administrator oder verfügt nicht über die Rolle „sn_cicd.sys_ci_Automation“.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    405 Ungültige Methode. Die Funktionalität ist inaktiv.
    409 Konflikt. Das angeforderte Element ist nicht eindeutig.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Child_Suite_results Ergebnisse geschachtelter Test-Suites. Das Format dieses Inhalts ist mit dem übergeordneten Test identisch.
    Fehler Fehlermeldung.

    Datentyp: Zeichenfolge
    Links Objekt, das alle Links und sys_IDs enthält, die der Antwort zugeordnet sind.

    Datentyp: Objekt
    Links.Ergebnisse Objekt, das die Ergebnisinformationen enthält.

    Datentyp: Objekt
    links.results.id Eindeutiger Bezeichner der Ergebnisinformationen. Verwenden Sie diesen Wert, wenn Sie den Endpunkt aufrufen /sn_cicd/testsuite/results/{result_ID} .

    Datentyp: Zeichenfolge
    Links.Ergebnisse.url URL, die zum Abrufen der Ergebnisse der Endpunktausführung verwendet werden soll, z. B. Ergebnisse.

    Datentyp: Zeichenfolge
    percent_complete Prozentsatz der abgeschlossenen Anforderung.
    rolledup_test_error_count Anzahl der Tests mit Fehlern.

    Datentyp: Zahl
    rolledup_test_failure_count Anzahl der fehlgeschlagenen Tests.

    Datentyp: Zahl
    rolledup_test_skip_count Anzahl der übersprungenen Tests.

    Datentyp: Zahl
    rolledup_test_success_count Anzahl der Tests, die erfolgreich ausgeführt wurden.

    Datentyp: Zahl
    status Numerischer Ausführungsstatus. Verwendet mit status_label, Z. B. 0: Ausstehend.
    Werte:
    • 0 (Ausstehend)
    • 1 (Wird Ausgeführt)
    • 2 (Erfolgreich)
    • 3 (Fehlgeschlagen)
    • 4 (Abgebrochen)

    Datentyp: Zeichenfolge
    status_detail Zusätzliche Informationen zum aktuellen Status.

    Datentyp: Zeichenfolge
    status_label Beschreibung des Ausführungsstatus. Verwendet mit status, Z. B. 0: Ausstehend.
    Werte:
    • Ausstehend
    • Wird ausgeführt
    • Erfolgreich
    • Fehlgeschlagen
    • Abgebrochen

    Datentyp: Zeichenfolge
    status_message Beschreibung des aktuellen Status.

    Datentyp: Zeichenfolge
    test_suite_duration Zeit, die für die Ausführung der Test-Suite benötigt wurde.

    Einheit: Sekunden

    Datentyp: Zeichenfolge
    test_suite_name Name der Test-Suite.

    Datentyp: Zeichenfolge
    test_suite_status Status der Test-Suite.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    curl 'instance.servicenow.com/api/sn_cicd/testsuite/results/2891389d1b1040103d374087bc4bcb09' \
--request GET \
--header 'Accept: application/json' \
--user 'username':'password'
    {
"result": {
   "links": {
       "results": {
           "id": "2891389d1b1040103d374087bc4bcb09",
           "url": "https://instance.servicenow.com/sys_atf_test_suite_result.do?sys_id=2891389d1b1040103d374087bc4bcb09"
       }
   },
   "status": "2",
   "status_label": "Successful",
   "status_message": "",
   "status_detail": "",
   "error": "",
   "test_suite_status": "success",
   "test_suite_duration": "1 Second",
   "rolledup_test_success_count": 1,
   "rolledup_test_failure_count": 0,
   "rolledup_test_error_count": 0,
   "rolledup_test_skip_count": 0,
   "test_suite_name": "Quick Test",
   "child_suite_results": []
 }
}

    CI/CD – NACH /sn_cicd/App/Batch/install

    Installiert zwei oder mehr Pakete in einem einzelnen angegebenen Batch.

    Ein Batch kann eine beliebige Kombination der folgenden Typen enthalten:
    • Anwendung:
      • Bereichsbezogene Anwendungen in ServiceNow Store Die sich nicht im Besitz Ihres Unternehmens befinden
      • Bereichsbezogene oder globale Anwendungen im Anwendungs-Repository, die sich im Besitz Ihres Unternehmens befinden
      • Ihre Anwendungsanpassungen für Store-Anwendungen im Anwendungs-Repository
    • ServiceNow Plugin:

      Anwendungsanpassungen für bereichsbezogene Anwendungen, die in einem Plugin verpackt und im Anwendungs-Repository veröffentlicht wurden.

    Hinweis:
    Dieser Endpunkt verwendet ein asynchrones Antwortmodell. Wenn Sie einen Endpunkt aufrufen, wird die zugehörige Funktion gestartet, z. B. das Starten der Ausführung des Batch-Installationsplans. Der Endpunkt gibt dann eine Antwortnachricht zurück, die den Ausführungsstatus der angeforderten Funktion (normalerweise Ausstehend) zusammen mit einem eindeutigen Bezeichner und einem eindeutigen Link enthält. Verwenden Sie diese Informationen, um zusätzliche Informationen über den Fortschritt oder die Ergebnisse der Anforderung zu erhalten.

    URL-Format

    Versionierte URL: /api/sn_cicd/{api_Version}/App/Batch/install

    Standard-URL: /api/sn_cicd/App/Batch/install

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    Tabelle : 26. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 27. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    name Erforderlich. Vom Anwender angegebener beschreibender Name für diese Batch-Anforderung.

    Datentyp: Zeichenfolge
    Notizen Vom Anwender angegebene zusätzliche Hinweise zum Batch-Installationsplan.

    Datentyp: Zeichenfolge

    Standard: Null
    Pakete Erforderlich. JSON-Array, in dem jedes Objekt Details eines zu installierenden Pakets angibt.

    Datentyp: Array

    "packages": [{
  "id": "String",
  "load_demo_data": Boolean,
  "notes": "String",
  "requested_customization_version": "String",
  "requested_version": "String",
  "type": "String" 
}]
    Packages.ID Erforderlich. SYS_ID der Anwendung oder Bezeichner des zu installierenden Plugins.

    Datentyp: Zeichenfolge
    Packages.load_Demo_Data Kennzeichnung, die angibt, ob Demodaten bei der Installation des Pakets geladen werden.
    Gültige Werte:
    • Wahr: Demodaten müssen geladen werden.
    • Falsch: Demodaten dürfen nicht geladen werden.

    Datentyp: Boolesch

    Standardwert: false
    packages.notes Vom Anwender angegebene Hinweise zum Paket.

    Datentyp: Zeichenfolge

    Standard: Null
    Pakete.REQUESTED_Customization_Version Version der Anwendungsanpassung an die Store-Anwendung oder den bereichsbezogenen ServiceNow Zu installierendes Plugin, z. B. 1.0.2 oder 2,3.

    Datentyp: Zeichenfolge

    Standard: Keine. Wenn dieser Parameter nicht festgelegt ist, sucht das System nicht nach Anpassungen für die Anwendung.
    Pakete.REQUESTED_Version Erforderlich, wenn packages.typeIst auf festgelegt Anwendung ; Ignoriert, wenn auf festgelegt Plugin . Version des zu installierenden Pakets, z. B. 1.0.2 oder 2,3.

    Datentyp: Zeichenfolge
    Pakete.Typ Erforderlich. Typ des Pakets.
    Gültige Werte:
    • Anwendung
    • Plugin

    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 : 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 REST API-HTTP-Antwortcodes .

    Tabelle : 30. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Die Anwenderanmeldeinformationen sind falsch.
    403 Unzulässig. Der Anwender ist kein Administrator oder verfügt nicht über die Rolle „sn_cicd.sys_ci_Automation“.
    405 Ungültige Methode. Die Funktion ist deaktiviert.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Fehler Fehlermeldung mit Details zum Fehler.

    Datentyp: Zeichenfolge
    Links Alle Links und sys_IDs, die der Antwort zugeordnet sind.

    Datentyp: Objekt

    "links": {
  "progress": {Object},
  "results": {Object},
  "rollback": {Object}
}
    links.progress Fortschrittsinformationen zum Vorgang, der für den Update-Satz ausgeführt wird.

    Datentyp: Objekt

    "progress": {
  "id": "String",
  "url": "String"
}
    links.progress.id SYS_ID mit Fortschrittsdetails für den Vorgang. Sie können diesen Wert beim Aufrufen des Endpunkts verwenden CI/CD – GET /sn_cicd/Progress/{Progress_ID}.

    Datentyp: Zeichenfolge
    links.progress.url URL, die zum Abrufen der Fortschrittsdetails des für den Update-Satz ausgeführten Vorgangs verwendet werden soll.

    Datentyp: Zeichenfolge
    Links.Ergebnisse Beschreibt die Informationen zum Ergebnislink.

    Datentyp: Objekt

    "results": {
  "id": "String",
  "url": "String"
}
    links.results.id SYS_ID der Ergebnisse des Batch-Endpunktaufrufs. Verwenden Sie diesen Wert, wenn Sie den in angegebenen Endpunkt aufrufen links.results.urlZum Abfragen der Batch-Installationsergebnisse.

    Datentyp: Zeichenfolge
    Links.Ergebnisse.url URL, die zum Abrufen der Ergebnisse der Batch-Installation verwendet werden soll.

    Datentyp: Zeichenfolge
    Links.Rollback Beschreibt die Rollback-Informationen für die Batch-Installation.

    Datentyp: Objekt

    "rollback": {
  "id": "String"
}
    links.rollback.id SYS_ID der Rollback-Details für die installierten Pakete. Verwenden Sie diesen Parameter, um die Installation der angegebenen Pakete mithilfe von auf ihre vorherigen Versionen zurückzusetzen /sn_cicd/App/Batch/Rollback/{Rollback_ID} Endpunkt.
    Hinweis:
    Die Rollback-Fähigkeit ist erst verfügbar, nachdem die Installation abgeschlossen ist.

    Datentyp: Zeichenfolge
    percent_complete Prozentsatz der abgeschlossenen Anforderung.

    Datentyp: Zahl
    Status Zahl, die den Ausführungsstatus der Aktion darstellt, die für den Update-Satz ausgeführt wird. Entspricht status_labelDeskriptor.
    Mögliche Werte:
    • 0: Ausstehend
    • 1: Wird Ausgeführt
    • 2: Erfolgreich
    • 3: Fehlgeschlagen
    • 4: Abgebrochen

    Datentyp: Zeichenfolge
    status_detail Detaillierte Nachricht zum Ausführungsstatus, falls verfügbar. Entspricht dem Feld Detailed_message in der Tabelle „Ausführungstracker“ [sys_Execution_Tracker].

    Datentyp: Zeichenfolge
    status_label Ausführungsstatus der Update-Satz-Aktion. Entspricht statusNummer.
    Mögliche Werte:
    • Abgebrochen
    • Fehlgeschlagen
    • Ausstehend
    • Wird ausgeführt
    • Erfolgreich

    Datentyp: Zeichenfolge
    status_message Zusätzliche Beschreibung des aktuellen Status der Aktion, falls verfügbar.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Dieses Beispiel initiiert eine Batch-Installation mit der Bezeichnung Release 2,2-Bereitstellung, die drei Pakete (eines von jedem Typ) zur Installation enthält.

    curl 'instance.servicenow.com/api/sn_cicd/app/batch/install \
--request POST \
--header 'Accept: application/json' \
--user 'username':'password' \
--data { "name": "Release 2.2 Deployment",
 "packages": [
   {
     "id": "syd_id_abcefghi",
     "type": "application",
     "load_demo_data": false,
     "requested_version": "1.0.2",
     "notes": "User specific text to describe this application install"
   },
   { 
     "id": "syd_id_defabcde",
     "type": "application",
     "requested_version": "1.0.0",
     "requested_customization_version": "2.0.7",
     "notes": "Customization for CSM App1"
   },
   {
     "id": "com.glide.some.plugin",
     "type": "plugin",
     "load_demo_data": true,
     "notes": "Plugin related notes"
   }]
 }
    {
"result": {
   "links": {
     "progress": {
       "id": "c159b1e9db1c0010b5e3f6c5ae961903",
       "url": "https://instance.servicenow.com/api/sn_cicd/progress/c159b1e9db1c0010b5e3f6c5ae961903"
     },
     "results": {
       "id": "df24b1e9db2d0110b5e3f6c5ae97c561",
       "url": "https://instance.servicenow.com/api/sn_cicd/app/batch/results/df24b1e9db2d0110b5e3f6c5ae97c561"
     },
     "rollback":{
       "id": "a329f82e871da64c724ba21c82a764f2"
     },
   },
   "status": "0",
   "status_label": "Pending",
   "status_message": "",
   "status_detail": "",
   "error": "",
   "percent_complete": 0
  }
}

    CI/CD – NACH /sn_cicd/App/Batch/Rollback/{Rollback_ID}

    Setzt alle Pakete, die einer bestimmten Batch-Installation zugeordnet sind, auf ihre vorherigen Versionen zurück.

    Dieser Endpunkt funktioniert in Verbindung mit /sn_cicd/App/Batch/install Endpunkt. Die rollback_idWird in den Rückgabeergebnissen dieses Endpunkts bereitgestellt. Wenn dieser Endpunkt aufgerufen wird, werden alle in der zugehörigen Installation angegebenen Pakete zurückgesetzt. Sie können kein Rollback einzelner Pakete durchführen. Wenn keine vorherige Version vorhanden ist, deinstalliert der Endpunkt das zugehörige Paket.

    Hinweis:
    Dieser Endpunkt verwendet ein asynchrones Antwortmodell. Wenn Sie einen Endpunkt aufrufen, wird die zugehörige Funktion gestartet, z. B. das Starten der Ausführung des Batch-Installationsplans. Der Endpunkt gibt dann eine Antwortnachricht zurück, die den Ausführungsstatus der angeforderten Funktion (normalerweise Ausstehend) zusammen mit einem eindeutigen Bezeichner und einem eindeutigen Link enthält. Verwenden Sie diese Informationen, um zusätzliche Informationen über den Fortschritt oder die Ergebnisse der Anforderung zu erhalten.

    URL-Format

    Versionierte URL: /api/sn_cicd/{api_Version}/App/Batch/Rollback/{Rollback_ID}

    Standard-URL: /api/sn_cicd/App/Batch/Rollback/{Rollback_ID}

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    rollback_id SYS_ID des Batch-Installationsplans, für den ein Rollback der installierten Pakete auf die vorherigen Versionen durchgeführt werden soll. Dieser Wert wird in zurückgegeben links.rollback.idParameter von /sn_cicd/App/Batch/install Endpunkt.

    Datentyp: Zeichenfolge
    Tabelle : 32. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 33. 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 : 34. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 35. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 36. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Die Anwenderanmeldeinformationen sind falsch.
    403 Unzulässig. Der Anwender ist kein Administrator oder verfügt nicht über die Rolle „sn_cicd.sys_ci_Automation“.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    405 Ungültige Methode. Die Funktionalität ist inaktiv.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Fehler Fehlermeldung mit Details zum Fehler.

    Datentyp: Zeichenfolge
    Links Alle Links und sys_IDs, die der Antwort zugeordnet sind.

    Datentyp: Objekt

    "links": {
  "progress": {Object}
}
    links.progress Fortschrittsinformationen zum Vorgang, der für den Update-Satz ausgeführt wird.

    Datentyp: Objekt

    "progress": {
  "id": "String",
  "url": "String"
}
    links.progress.id SYS_ID mit Fortschrittsdetails für den Vorgang. Sie können diesen Wert beim Aufrufen des Endpunkts verwenden CI/CD – GET /sn_cicd/Progress/{Progress_ID}.

    Datentyp: Zeichenfolge
    links.progress.url URL, die zum Abrufen der Fortschrittsdetails des für den Update-Satz ausgeführten Vorgangs verwendet werden soll.

    Datentyp: Zeichenfolge
    percent_complete Prozentsatz der abgeschlossenen Anforderung.

    Datentyp: Zahl
    Status Zahl, die den Ausführungsstatus der Aktion darstellt, die für den Update-Satz ausgeführt wird. Entspricht status_labelDeskriptor.
    Mögliche Werte:
    • 0: Ausstehend
    • 1: Wird Ausgeführt
    • 2: Erfolgreich
    • 3: Fehlgeschlagen
    • 4: Abgebrochen

    Datentyp: Zeichenfolge
    status_detail Detaillierte Nachricht zum Ausführungsstatus, falls verfügbar. Entspricht dem Feld Detailed_message in der Tabelle „Ausführungstracker“ [sys_Execution_Tracker].

    Datentyp: Zeichenfolge
    status_label Ausführungsstatus der Update-Satz-Aktion. Entspricht statusNummer.
    Mögliche Werte:
    • Abgebrochen
    • Fehlgeschlagen
    • Ausstehend
    • Wird ausgeführt
    • Erfolgreich

    Datentyp: Zeichenfolge
    status_message Zusätzliche Beschreibung des aktuellen Status der Aktion, falls verfügbar.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    In diesem Beispiel werden alle Pakete im angegebenen Installations-Batch-Plan auf ihre vorherige Version zurückgesetzt.

    curl 'instance.servicenow.com/api/sn_cicd/app/batch/rollback/a329f82e871da64c724ba21c82a764f2 \
--request POST \
--header 'Accept: application/json' \
--user 'username':'password'
    {
"result": {
   "links": {
     "progress": {
       "id": "c159b1e9db1c0010b5e3f6c5ae961903",
       "url": "https://instance.servicenow.com/api/sn_cicd/progress/c159b1e9db1c0010b5e3f6c5ae961903"
     },
   "status": "0",
   "status_label": "Pending",
   "status_message": "",
   "status_detail": "",
   "error": "",
   "percent_complete": 0
  }
}

    CI/CD – NACH /sn_cicd/App_repo/install

    Installiert die angegebene Anwendung aus dem Anwendungs-Repository auf der Instanz, die den Endpunkt aufruft.

    Mit diesem Endpunkt können Sie unverändert und anwenderdefiniert installieren ServiceNow Basissystem und ServiceNow Store Anwendungen, angepasst ServiceNow Plugins und Ihre eigenen ServiceNow Anwendungen.

    Im Folgenden werden die Parameter beschrieben, die Sie übergeben müssen, um bestimmte Anwendungsfälle zu implementieren. Alle Parameter, die nicht angegeben sind, werden nicht übergeben und verwenden die zugehörigen Standardwerte.

    • Um nur die Basisanwendung und nicht die entsprechenden Anwendungsanpassungen zu installieren.
      • sys_ID: SYS_ID der Basisanwendung, die angepasst wurde.
      • Base_App_Version: Version der zu installierenden Basisanwendung.
    • Um eine angegebene Version von Anwendungsanpassungen zu installieren und die empfohlene Basisanwendungsversion automatisch zu installieren. Die empfohlene Basisanwendungsversion ist die Version der Basisanwendung, die zum Zeitpunkt der letzten Veröffentlichung der Anpassungen auf der Instanz installiert wurde. Jede Version von Anwendungsanpassungen verfügt über eine entsprechende empfohlene Basisanwendungsversion.
      • sys_ID: SYS_ID der Anwendung, die angepasst wurde.
      • auto_Upgrade_Base_App: Wahr
      • Version: Version der zu installierenden Anwendungsanpassungen.
    • Zum Installieren der neuesten Version der Anwendungsanpassungen und der entsprechenden empfohlenen Basisanwendungsversion.
      • sys_ID: SYS_ID der Anwendung, die angepasst wurde.
      • auto_Upgrade_Base_App: Wahr
    • Um die neueste Version der Anwendungsanpassungen zu installieren, aber nicht ein Upgrade der Basisanwendung auf die empfohlene Basisanwendungsversion der Anwendungsanpassungen durchzuführen.
      • sys_ID: SYS_ID der Anwendung, die angepasst wurde.
      • auto_Upgrade_Base_App: Falsch
    • Zum Installieren von Anwendungsanpassungen zusammen mit dem Umfang ServiceNow Plugin des aktuellen Release.
      • Umfang: Umfang des Plugins, der angepasst wurde ODER
      • sys_ID: SYS_ID der Anwendung, die angepasst wurde. Dies ist nicht die ID des Plugins.
      • Version: Version der zu installierenden Anwendungsanpassungen.
    • Zum Installieren von Anwendungsanpassungen für ein bereits installiertes und aktiviertes bereichsbezogenes Plugin.
      • sys_ID: SYS_ID der Anwendung, die angepasst wurde. Dies ist nicht die ID des Plugins.
      • auto_Upgrade_Base_App: Falsch
      • Version: Version der zu installierenden Anwendungsanpassungen.

    Da Basis-Plugins nur eine Version pro Familienrelease haben können, ist auto_upgrade_base_appUnd base_app_versionParameter gelten nicht für Anwendungsanpassungsinstallationen für Plugins. Um ein Plugin zum ersten Mal in einer Instanz zu aktivieren, verwenden Sie /sn_cicd/Plugin/{Plugin_ID}/Aktivieren Stattdessen Endpunkt.

    Hinweis:
    Dieser Endpunkt verwendet ein asynchrones Antwortmodell. Wenn Sie einen Endpunkt aufrufen, wird die zugehörige Funktion gestartet, z. B. das Starten der Ausführung des Batch-Installationsplans. Der Endpunkt gibt dann eine Antwortnachricht zurück, die den Ausführungsstatus der angeforderten Funktion (normalerweise Ausstehend) zusammen mit einem eindeutigen Bezeichner und einem eindeutigen Link enthält. Verwenden Sie diese Informationen, um zusätzliche Informationen über den Fortschritt oder die Ergebnisse der Anforderung zu erhalten.

    URL-Format

    Versionierte URL: /api/sn_cicd/{api_Version}/App_repo/install

    Standard-URL: /api/sn_cicd/App_repo/install

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    Tabelle : 38. Abfrageparameter
    Name Beschreibung
    auto_Upgrade_Base_App Gilt nur, wenn Sie Anwendungsanpassungen installieren möchten und die Basisanwendung auf einer Version basiert, die höher als die derzeit installierte Version ist.

    Kennzeichnung, die angibt, ob die zugeordnete Basisanwendung automatisch auf eine spätere Version aktualisiert werden soll.

    Gültige Werte:
    • Wahr: Upgrade der zugehörigen Basisanwendung automatisch durchführen.
    • Falsch: Belassen Sie die Basisanwendung als Version, die derzeit auf der Instanz installiert ist.

    Datentyp: Boolesch

    Standardwert: false
    Base_App_Version Version der zu installierenden Basisanwendung. Eine -Basisanwendung ist eine beliebige Drittpartei-Anwendung, die in verfügbar ist ServiceNow Store.

    Wenn die Anwendung keine Anwendungsanpassungen hat oder wenn die Anwendung über Anwendungsanpassungen verfügt und Sie nur die Basisanwendung aktualisieren, geben Sie die aktualisierte Version der Anwendung in diesen Parameter ein. Wenn Sie Anwendungsanpassungen aktualisieren, übergeben Sie diesen Parameter nicht, sondern übergeben Sie versionParameter.

    Datentyp: Zeichenfolge

    Standard: Null
    scope Erforderlich, wenn sys_idIst nicht angegeben. Bereichsname der Anwendung, z. B. X_Aah_custom_App .

    Datentyp: Zeichenfolge

    Tabelle: Im Feld Umfang in der Tabelle „Anwenderdefinierte Anwendung“ [sys_App] oder der Tabelle „Store-Anwendung“ [sys_Store_App].
    sys_id Erforderlich, wenn scopeIst nicht angegeben. SYS_ID der zu installierenden Anwendung.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „SYS-ID“ in der Tabelle „Anwenderdefinierte Anwendung“ [sys_App] oder „Store-Anwendung“ [sys_Store_App].
    Version Version der zu installierenden Anwendung.

    Datentyp: Zeichenfolge

    Standard: Wenn base_app_versionParameter ist leer und auto_upgrade_base_appDer Parameter ist auf „wahr“ festgelegt, installiert die neuesten Anwendungsanpassungen und die empfohlene Basisanwendungsversion (solange die Basisanwendung nicht heruntergestuft wird).

    Wenn auto_upgrade_base_appDer Parameter ist „falsch“, installiert die Anwendungsanpassungen, die Basisanwendung wird jedoch nicht aktualisiert.

    Wenn base_app_versionParameter ist definiert, installiert nur die Basisanwendung.
    Tabelle : 39. 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 : 40. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 41. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 42. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Die Anwenderanmeldeinformationen sind falsch.
    403 Unzulässig. Der Anwender ist kein Administrator oder verfügt nicht über die Rolle „sn_cicd.sys_ci_Automation“.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    405 Ungültige Methode. Die Funktionalität ist inaktiv.
    409 Konflikt. Das angeforderte Element ist nicht eindeutig.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Fehler Fehlermeldung mit Details zum Fehler.

    Datentyp: Zeichenfolge
    Links Informationen zu Links und sys_IDs, die dem Update-Satz zugeordnet sind.

    Datentyp: Objekt

    "links": {
  "progress": {Object}
}
    links.progress Fortschrittsinformationen zum Vorgang, der für den Update-Satz ausgeführt wird.

    Datentyp: Objekt

    "progress": {
  "id": "String",
  "url": "String"
}
    links.progress.id SYS_ID mit Fortschrittsdetails für den Vorgang. Sie können diesen Wert beim Aufrufen des Endpunkts verwenden CI/CD – GET /sn_cicd/Progress/{Progress_ID}.

    Datentyp: Zeichenfolge
    links.progress.url URL, die zum Abrufen der Fortschrittsdetails des für den Update-Satz ausgeführten Vorgangs verwendet werden soll.

    Datentyp: Zeichenfolge
    percent_complete Prozentsatz der abgeschlossenen Anforderung.

    Datentyp: Zahl
    rollback_version Falls verfügbar, die zuvor installierte Version. Wenn nicht verfügbar, null.

    Datentyp: Zeichenfolge
    status Zahl, die den Ausführungsstatus der Aktion darstellt, die für den Update-Satz ausgeführt wird. Entspricht status_labelDeskriptor.
    Mögliche Werte:
    • 0: Ausstehend
    • 1: Wird Ausgeführt
    • 2: Erfolgreich
    • 3: Fehlgeschlagen
    • 4: Abgebrochen

    Datentyp: Zeichenfolge
    status_detail Detaillierte Nachricht zum Ausführungsstatus, falls verfügbar. Entspricht dem Feld Detailed_message in der Tabelle „Ausführungstracker“ [sys_Execution_Tracker].

    Datentyp: Zeichenfolge
    status_label Ausführungsstatus der Update-Satz-Aktion. Entspricht statusNummer.
    Mögliche Werte:
    • Abgebrochen
    • Fehlgeschlagen
    • Ausstehend
    • Wird ausgeführt
    • Erfolgreich

    Datentyp: Zeichenfolge
    status_message Zusätzliche Beschreibung des aktuellen Status der Aktion, falls verfügbar.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    curl 'instance.servicenow.com/api/sn_cicd/app_repo/install?sys_id=2d146921dbd80010caf55268dc9619d8' \
--request POST \
--header 'Accept: application/json' \
--user 'username':'password'
    {
"result": {
   "links": {
     "progress": {
        "id": "c159b1e9db1c0010b5e3f6c5ae961903",
        "url": "https://instance.servicenow.com/api/sn_cicd/progress/c159b1e9db1c0010b5e3f6c5ae961903"
      }
   },
   "status": "0",
   "status_label": "Pending",
   "status_message": "",
   "status_detail": "",
   "error": "",
   "percent_complete": 0,
   "rollback_version": "1.1.0"
  }
}

    CI/CD – NACH /sn_cicd/App_repo/published

    Veröffentlicht die angegebene Anwendung und alle ihre Artefakte im Anwendungs-Repository.

    Hinweis:
    Wenn bei Aufruf dieses Endpunkts nicht Commits an nachverfolgten Dateien vorgenommen werden, wird ein Statuscode für ungültige Anforderung 400 zurückgegeben. Sie können die Änderungen entweder manuell in bestätigen Studio Oder rufen Sie an CI/CD – NACH /sn_cicd/sc/apply_Changes Endpunkt zum Stash der Changes. Änderungen, die in der Tabelle „Kundenupdates“ [sys_Update_xml] nicht nachverfolgt werden, werden nach der Veröffentlichung im Anwendungs-Repository automatisch festgeschrieben. Informationen zum Layout der Changes in der Tabelle „Kundenupdates“ und eine Beschreibung der Changes, die in dieser Tabelle nicht dargestellt werden, finden Sie unter Customer Updates table.

    URL-Format

    Versionierte URL: /api/sn_cicd/{api_Version}/App_repo/published

    Standard-URL: /api/sn_cicd/App_repo/published

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    Tabelle : 44. Abfrageparameter
    Name Beschreibung
    dev_Notes Entwicklernotizen, die mit der Anwendung gespeichert werden sollen.

    Datentyp: Zeichenfolge
    scope Erforderlich, wenn sys_idIst nicht angegeben. Der Umfang der Anwendung.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld Umfang der Tabelle „Anwenderdefinierte Anwendung“ [sys_App].
    sys_id Erforderlich, wenn scopeIst nicht angegeben. Die sys_ID der Anwendung, die im Repository gespeichert werden soll.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld SYS-ID der Tabelle „Anwenderdefinierte Anwendung“ [sys_App].
    Version Version, unter der die Anwendung gespeichert werden soll.

    Wenn die Versionsnummer übergeben wird, verwendet der Veröffentlichungsprozess diese Version und aktualisiert die lokale Anwendungsversion, falls sie sich unterscheidet. Wenn die Versionsnummer nicht übergeben wird, verwendet der Veröffentlichungsprozess die aktuelle Version der lokalen Anwendung und schlägt fehl, wenn diese Version im Anwendungs-Repository vorhanden ist.

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

    Standard: application/json
    Tabelle : 47. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 48. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Anforderung fehlgeschlagen.

    Mögliche Probleme:

    • Die Anwendungsversion ist nicht korrekt oder ein Downgrade.
    • Die Anwendung ist mit der Quellcodeverwaltung verbunden und enthält nicht bestätigte Changes, die gelöst werden müssen.
    Weitere Informationen finden Sie in der zurückgegebenen Fehlermeldung.
    401 Die Anwenderanmeldeinformationen sind falsch.
    403 Unzulässig. Der Anwender ist kein Administrator oder verfügt nicht über die Rolle „sn_cicd.sys_ci_Automation“.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    405 Ungültige Methode. Die Funktionalität ist inaktiv.
    409 Konflikt. Das angeforderte Element ist nicht eindeutig.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Fehler Fehlermeldung mit Details zum Fehler.

    Datentyp: Zeichenfolge
    Links Informationen zu Links und sys_IDs, die dem Update-Satz zugeordnet sind.

    Datentyp: Objekt

    "links": {
  "progress": {Object}
}
    links.progress Fortschrittsinformationen zum Vorgang, der für den Update-Satz ausgeführt wird.

    Datentyp: Objekt

    "progress": {
  "id": "String",
  "url": "String"
}
    links.progress.id SYS_ID mit Fortschrittsdetails für den Vorgang. Sie können diesen Wert beim Aufrufen des Endpunkts verwenden CI/CD – GET /sn_cicd/Progress/{Progress_ID}.

    Datentyp: Zeichenfolge
    links.progress.url URL, die zum Abrufen der Fortschrittsdetails des für den Update-Satz ausgeführten Vorgangs verwendet werden soll.

    Datentyp: Zeichenfolge
    percent_complete Prozentsatz der abgeschlossenen Anforderung.

    Datentyp: Zahl
    Status Detaillierte Nachricht zum Ausführungsstatus, falls verfügbar. Entspricht dem Feld Detailed_message in der Tabelle „Ausführungstracker“ [sys_Execution_Tracker].

    Datentyp: Zeichenfolge
    status_detail Detaillierte Nachricht zum Ausführungsstatus, falls verfügbar. Entspricht dem Feld Detailed_message in der Tabelle „Ausführungstracker“ [sys_Execution_Tracker].

    Datentyp: Zeichenfolge
    status_label Ausführungsstatus der Update-Satz-Aktion. Entspricht statusNummer.
    Mögliche Werte:
    • Abgebrochen
    • Fehlgeschlagen
    • Ausstehend
    • Wird ausgeführt
    • Erfolgreich

    Datentyp: Zeichenfolge
    status_message Zusätzliche Beschreibung des aktuellen Status der Aktion, falls verfügbar.

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie die Anwendung mit der angegebenen sys_ID und allen zugehörigen Artefakten im Anwendungs-Repository veröffentlicht wird.

    curl 'instance.servicenow.com/api/sn_cicd/app_repo/publish?sys_id=4dd9686d1b9800103d374087bc4bcb3d' \
--request POST \
--header 'Accept: application/json' \
--user 'username':'password'
    {
"result": {
   "links": {
       "progress": {
           "id": "d174f8e11bd800103d374087bc4bcbd9",
           "url": "https://instance.service-now.com/api/sn_cicd/progress/d174f8e11bd800103d374087bc4bcbd9"
        }
    },
    "status": "0",
    "status_label": "Pending",
    "status_message": "",
    "status_detail": "",
    "error": "",
    "percent_complete": 0
  }
}

    CI/CD: NACH /sn_cicd/App_repo/Rollback

    Initiiert ein Rollback einer angegebenen Anwendung auf eine angegebene Version.

    Hinweis:
    Die Rollback-Funktionalität ist erst verfügbar, nachdem die Installation abgeschlossen ist.

    URL-Format

    Versionierte URL: /api/sn_cicd/{api_Version}/App_repo/Rollback

    Standard-URL: /api/sn_cicd/App_repo/Rollback

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    Tabelle : 50. Abfrageparameter
    Name Beschreibung
    scope Erforderlich, wenn sys_idIst nicht angegeben. Der Bereichsname der Anwendung, die zurückgesetzt werden soll.

    Datentyp: Zeichenfolge
    sys_id Erforderlich, wenn scopeIst nicht angegeben. Die sys_ID der Anwendung, die zurückgesetzt werden soll.

    Datentyp: Zeichenfolge
    Version Erforderlich. Version der Anwendung, die nach dem Rollback-Vorgang erwartet wird. Wenn die Anforderung das Rollback einer App Customization-Installation ist, legen Sie dieses Feld auf die Version der Basisanwendung fest, die das System nach dem Rollback-Vorgang voraussichtlich haben wird.

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

    Standard: application/json
    Tabelle : 53. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 54. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Die Anwenderanmeldeinformationen sind falsch.
    403 Unzulässig. Der Anwender ist kein Administrator oder verfügt nicht über die Rolle „sn_cicd.sys_ci_Automation“.
    405 Ungültige Methode. Die Funktionalität ist inaktiv.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Fehler Fehlermeldung mit Details zum Fehler.

    Datentyp: Zeichenfolge
    Links Informationen zu Links und sys_IDs, die dem Update-Satz zugeordnet sind.

    Datentyp: Objekt

    "links": {
  "progress": {Object}
}
    links.progress Fortschrittsinformationen zum Vorgang, der für den Update-Satz ausgeführt wird.

    Datentyp: Objekt

    "progress": {
  "id": "String",
  "url": "String"
}
    links.progress.id SYS_ID mit Fortschrittsdetails für den Vorgang. Sie können diesen Wert beim Aufrufen des Endpunkts verwenden CI/CD – GET /sn_cicd/Progress/{Progress_ID}.

    Datentyp: Zeichenfolge
    links.progress.url URL, die zum Abrufen der Fortschrittsdetails des für den Update-Satz ausgeführten Vorgangs verwendet werden soll.

    Datentyp: Zeichenfolge
    percent_complete Prozentsatz der abgeschlossenen Anforderung.

    Datentyp: Zahl
    Status Zahl, die den Ausführungsstatus der Aktion darstellt, die für den Update-Satz ausgeführt wird. Entspricht status_labelDeskriptor.
    Mögliche Werte:
    • 0: Ausstehend
    • 1: Wird Ausgeführt
    • 2: Erfolgreich
    • 3: Fehlgeschlagen
    • 4: Abgebrochen

    Datentyp: Zeichenfolge
    status_detail Detaillierte Nachricht zum Ausführungsstatus, falls verfügbar. Entspricht dem Feld Detailed_message in der Tabelle „Ausführungstracker“ [sys_Execution_Tracker].

    Datentyp: Zeichenfolge
    status_label Ausführungsstatus der Update-Satz-Aktion. Entspricht statusNummer.
    Mögliche Werte:
    • Abgebrochen
    • Fehlgeschlagen
    • Ausstehend
    • Wird ausgeführt
    • Erfolgreich

    Datentyp: Zeichenfolge
    status_message Zusätzliche Beschreibung des aktuellen Status der Aktion, falls verfügbar.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    curl 'instance.servicenow.com/api/sn_cicd/app_repo/rollback?sys_id=2d146921dbd80010caf55268dc9619d8&version=1.1.0' \
--request POST \
--header 'Accept: application/json' \
--user 'username':'password'
    {
"result": {
   "links": {
      "progress": {
          "id": "f7ddb1eddb1c0010b5e3f6c5ae9619c1",
          "url": "https://instance.service-now.com/api/sn_cicd/progress/f7ddb1eddb1c0010b5e3f6c5ae9619c1"
       }
   },
   "status": "0",
   "status_label": "Pending",
   "status_message": "",
   "status_detail": "",
   "error": "",
   "percent_complete": 0
  }
}

    CI/CD – POST /sn_cicd/instance_Scan/Full_Scan

    Führt alle aktiven Prüfungen aus, die in Ihrer Instanz vorhanden sind.

    Sie können Prüfungen ausführen, die mit bereitgestellt werden Instance Scan Oder Sie können eigene Schecks erstellen. Weitere Informationen finden Sie unter Instanzscan .

    Hinweis:
    Dieser Endpunkt ist Teil von Ausführungsservice für CICD-Instanz-Scan API und wird unter verwendet sn_cicd Namespace.

    URL-Format

    Versionierte URL: /api/sn_cicd/{api_Version}/instance_Scan/Full_Scan

    Standard-URL: /api/sn_cicd/instance_Scan/Full_Scan

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

    Unterstützte Anforderungsparameter

    Tabelle : 55. Parameter
    Parameter 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

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

    Standard: application/json
    Tabelle : 57. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    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 : 58. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Die Anwenderanmeldeinformationen sind falsch.
    403 Unzulässig. Der Anwender ist kein Administrator oder verfügt nicht über die Rolle „sn_cicd.sys_ci_Automation“.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

    Anforderungstext

    Die API akzeptiert diese JSON- oder XML-Elemente im Anforderungstext.

    Tabelle : 59. Im Anforderungstext akzeptierte Elemente
    Elemente Beschreibung
    Keine

    Antwort-Haupttext

    Die API gibt diese JSON- oder XML-Elemente im Antwort-Haupttext zurück.

    Tabelle : 60. Im Antwort-Haupttext zurückgegebene Elemente
    Elemente Beschreibung
    Fehler Fehlermeldung mit Details zum Fehler.

    Datentyp: Zeichenfolge
    Links Informationen zu Links und sys_IDs, die dem Update-Satz zugeordnet sind.

    Datentyp: Objekt

    "links": {
  "progress": {Object}
}
    links.progress Fortschrittsinformationen zum Vorgang, der für den Update-Satz ausgeführt wird.

    Datentyp: Objekt

    "progress": {
  "id": "String",
  "url": "String"
}
    links.progress.id Eindeutiger Bezeichner des Fortschrittsdetails. Verwenden Sie diesen Wert, wenn Sie den Endpunkt aufrufen /sn_cicd/instance_Scan/result/{Progress_ID} .
    links.progress.url URL, die zum Abrufen der Fortschrittsdetails des für den Update-Satz ausgeführten Vorgangs verwendet werden soll.

    Datentyp: Zeichenfolge
    status Zahl, die den Ausführungsstatus der Aktion darstellt, die für den Update-Satz ausgeführt wird. Entspricht status_labelDeskriptor.
    Mögliche Werte:
    • 0: Ausstehend
    • 1: Wird Ausgeführt
    • 2: Erfolgreich
    • 3: Fehlgeschlagen
    • 4: Abgebrochen

    Datentyp: Zeichenfolge
    status_detail Detaillierte Nachricht zum Ausführungsstatus, falls verfügbar. Entspricht dem Feld Detailed_message in der Tabelle „Ausführungstracker“ [sys_Execution_Tracker].

    Datentyp: Zeichenfolge
    status_label Ausführungsstatus der Update-Satz-Aktion. Entspricht statusNummer.
    Mögliche Werte:
    • Abgebrochen
    • Fehlgeschlagen
    • Ausstehend
    • Wird ausgeführt
    • Erfolgreich

    Datentyp: Zeichenfolge
    status_message Zusätzliche Informationen dazu, warum der Vorgang fehlgeschlagen ist. Gibt eine leere Zeichenfolge zurück, wenn der Vorgang erfolgreich ist.

    Datentyp: Zeichenfolge

    Beispiel für eine cURL-Anforderung

    curl 'instance.service-now.com/api/sn_cicd/instance_scan/full_scan' \
--request POST \
--header 'Accept: application/json' \
--user 'username':'password'
    {
"result": {
   "links": {
       "progress": {
           "id": "a4fae8911bdc00103d374087bc4bcbbd",
           "url": "https://instance.service-now/api/sn_cicd/progress/a4fae8911bdc00103d374087bc4bcbbd"
        }
    },
    "status": "0",
    "status_label": "Pending",
    "status_message": "",
    "status_detail": "",
    "error": ""
  }
}

    CI/CD – POST /sn_cicd/instance_Scan/Point_Scan

    Führt alle anwendbaren Prüfungen für einen angegebenen Datensatz aus.

    Wenn Sie beispielsweise einen Punktscan für ein Katalogelement ausführen, werden nur die Prüfungen ausgeführt, die für die Tabelle „Katalogelement“ gelten, und nur der angegebene Datensatz wird gescannt.

    Sie können Prüfungen ausführen, die mit bereitgestellt werden Instance Scan Oder Sie können eigene Schecks erstellen. Weitere Informationen finden Sie unter Instanzscan .

    Hinweis:
    Dieser Endpunkt ist Teil von Ausführungsservice für CICD-Instanz-Scan API und wird unter verwendet sn_cicd Namespace.

    URL-Format

    Versionierte URL: /api/sn_cicd/{api_Version}/instance_Scan/Point_Scan

    Standard-URL: /api/sn_cicd/instance_Scan/Point_Scan

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    target_table Erforderlich. Name der Tabelle, in der sich der zu scannende Datensatz befindet, z. B. „Incident“.

    Datentyp: Zeichenfolge
    target_sys_id Erforderlich. Die sys_ID des Datensatzes innerhalb der angegebenen Tabelle, die gescannt werden soll.

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

    Standard: application/json
    Tabelle : 63. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    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 : 64. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung. Ungültige oder leere Abfrageparameter.
    401 Die Anwenderanmeldeinformationen sind falsch.
    403 Unzulässig. Der Anwender ist kein Administrator oder verfügt nicht über die Rolle „sn_cicd.sys_ci_Automation“.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

    Anforderungstext

    Die API akzeptiert diese JSON- oder XML-Elemente im Anforderungstext.

    Tabelle : 65. Im Anforderungstext akzeptierte Elemente
    Elemente Beschreibung
    Keine

    Antwort-Haupttext

    Die API gibt diese JSON- oder XML-Elemente im Antwort-Haupttext zurück.

    Tabelle : 66. Im Antwort-Haupttext zurückgegebene Elemente
    Elemente Beschreibung
    Fehler Fehlermeldung mit Details zum Fehler.

    Datentyp: Zeichenfolge
    Links Informationen zu Links und sys_IDs, die dem Update-Satz zugeordnet sind.

    Datentyp: Objekt

    "links": {
  "progress": {Object}
}
    links.progress Fortschrittsinformationen zum Vorgang, der für den Update-Satz ausgeführt wird.

    Datentyp: Objekt

    "progress": {
  "id": "String",
  "url": "String"
}
    links.progress.id Eindeutiger Bezeichner des Fortschrittsdetails. Verwenden Sie diesen Wert, wenn Sie den Endpunkt aufrufen /sn_cicd/instance_Scan/result/{Progress_ID} .
    links.progress.url URL, die zum Abrufen der Fortschrittsdetails des für den Update-Satz ausgeführten Vorgangs verwendet werden soll.

    Datentyp: Zeichenfolge
    status Zahl, die den Ausführungsstatus der Aktion darstellt, die für den Update-Satz ausgeführt wird. Entspricht status_labelDeskriptor.
    Mögliche Werte:
    • 0: Ausstehend
    • 1: Wird Ausgeführt
    • 2: Erfolgreich
    • 3: Fehlgeschlagen
    • 4: Abgebrochen

    Datentyp: Zeichenfolge
    status_detail Detaillierte Nachricht zum Ausführungsstatus, falls verfügbar. Entspricht dem Feld Detailed_message in der Tabelle „Ausführungstracker“ [sys_Execution_Tracker].

    Datentyp: Zeichenfolge
    status_label Ausführungsstatus der Update-Satz-Aktion. Entspricht statusNummer.
    Mögliche Werte:
    • Abgebrochen
    • Fehlgeschlagen
    • Ausstehend
    • Wird ausgeführt
    • Erfolgreich

    Datentyp: Zeichenfolge
    status_message Zusätzliche Informationen dazu, warum der Vorgang fehlgeschlagen ist. Gibt eine leere Zeichenfolge zurück, wenn der Vorgang erfolgreich ist.

    Datentyp: Zeichenfolge

    Beispiel für eine cURL-Anforderung

    curl 'instance.service-now.com/api/sn_cicd/instance_scan/point_scan?target_table=incident&target_sys_id=2d146921dbd80010caf55268dc9619d8' \
--request POST \
--header 'Accept: application/json' \
--user 'username':'password'
    {
"result": {
   "links": {
       "progress": {
           "id": "a4fae8911bdc00103d374087bc4bcbbd",
           "url": "https://instance.service-now/api/sn_cicd/progress/a4fae8911bdc00103d374087bc4bcbbd"
        }
    },
    "status": "0",
    "status_label": "Pending",
    "status_message": "",
    "status_detail": "",
    "error": ""
  }
}

    CI/CD – POST /sn_cicd/instance_Scan/Suite_Scan/Combo/{Combo_sys_ID}

    Führt einen Scan mit einer Suite und einem Ziel (bereichsbezogene Apps oder Update-Sätze) aus, die bereits zuvor ausgeführt wurden.

    Bevor Sie diesen Endpunkt aufrufen, müssen Sie aufrufen /sn_cicd/instance_Scan/Suite_Scan/{Suite_sys_ID}/scope_Apps Oder /sn_cicd/instance_Scan/Suite_Scan/{Suite_sys_ID}/Update_Sets Endpunkte, oder Führen Sie einen Suite-Scan aus In der Anwenderoberfläche.

    Hinweis:
    Dieser Endpunkt ist Teil von Ausführungsservice für CICD-Instanz-Scan API und wird unter verwendet sn_cicd Namespace.

    URL-Format

    Versionierte URL: /api/sn_cicd/{api_Version}/instance_Scan/Suite_Scan/Combo/{Combo_sys_ID}

    Standard-URL: /api/sn_cicd/instance_Scan/Suite_Scan/Combo/{Combo_sys_ID}

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    Combo_sys_ID SYS_ID des auszuführenden Scans. Der Scan muss ein vorhandener Scan sein, den Sie erneut ausführen möchten.

    Datentyp: Zeichenfolge

    Tabelle: Combo [Scan_Combo]
    Tabelle : 68. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 69. 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 : 70. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 71. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 72. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Die Anwenderanmeldeinformationen sind falsch.
    403 Unzulässig. Der Anwender ist kein Administrator oder verfügt nicht über die Rolle „sn_cicd.sys_ci_Automation“.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

    Antworttext-Parameter (JSON oder XML)

    Element Beschreibung
    Fehler Fehlermeldung mit Details zum Fehler.

    Datentyp: Zeichenfolge
    Links Informationen zu Links und sys_IDs, die dem Update-Satz zugeordnet sind.

    Datentyp: Objekt

    "links": {
  "progress": {Object}
}
    links.progress Fortschrittsinformationen zum Vorgang, der für den Update-Satz ausgeführt wird.

    Datentyp: Objekt

    "progress": {
  "id": "String",
  "url": "String"
}
    links.progress.id Eindeutiger Bezeichner des Fortschrittsdetails. Verwenden Sie diesen Wert, wenn Sie den Endpunkt aufrufen /sn_cicd/instance_Scan/result/{Progress_ID} .

    Datentyp: Zeichenfolge
    links.progress.url URL, die zum Abrufen der Fortschrittsdetails des für den Update-Satz ausgeführten Vorgangs verwendet werden soll.

    Datentyp: Zeichenfolge
    status Zahl, die den Ausführungsstatus der Aktion darstellt, die für den Update-Satz ausgeführt wird. Entspricht status_labelDeskriptor.
    Mögliche Werte:
    • 0: Ausstehend
    • 1: Wird Ausgeführt
    • 2: Erfolgreich
    • 3: Fehlgeschlagen
    • 4: Abgebrochen

    Datentyp: Zeichenfolge
    status_detail Detaillierte Nachricht zum Ausführungsstatus, falls verfügbar. Entspricht dem Feld Detailed_message in der Tabelle „Ausführungstracker“ [sys_Execution_Tracker].

    Datentyp: Zeichenfolge
    status_label Ausführungsstatus der Update-Satz-Aktion. Entspricht statusNummer.
    Mögliche Werte:
    • Abgebrochen
    • Fehlgeschlagen
    • Ausstehend
    • Wird ausgeführt
    • Erfolgreich

    Datentyp: Zeichenfolge
    status_message Zusätzliche Informationen dazu, warum der Vorgang fehlgeschlagen ist. Gibt eine leere Zeichenfolge zurück, wenn der Vorgang erfolgreich ist.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    curl "https://instance.servicenow.com/api/sn_cicd/instance_scan/suite_scan/combo/245d29cc1bd32010178aed72604bcb4b" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'

    Antworttext: Erfolg.

    {
  "result": {
    "links": {
      "progress": {
        "id": "c08be5c71b1b2010178aed72604bcb6e",
        "url": "https://instance.servicenow.com/api/sn_cicd/progress/c08be5c71b1b2010178aed72604bcb6e"
      }
    },
    "status": "0",
    "status_label": "Pending",
    "status_message": "",
    "status_detail": "",
    "error": ""
  }
}

    CI/CD – POST /sn_cicd/instance_Scan/Suite_Scan/{Suite_sys_ID}/scoped_Apps

    Führt alle aktiven Prüfungen innerhalb einer Suite anhand einer Liste von bereichsbezogenen Apps aus.

    Hinweis:
    Dieser Endpunkt ist Teil von Ausführungsservice für CICD-Instanz-Scan API und wird unter verwendet sn_cicd Namespace.

    URL-Format

    Versionierte URL: /api/sn_cicd/{api_Version}/instance_Scan/Suite_Scan/{Suite_sys_ID}/scope_Apps

    Standard-URL: /api/sn_cicd/instance_Scan/Suite_Scan/{Suite_sys_ID}/scope_Apps

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    suite_sys_ID SYS_ID des Suite Zur Ausführung.

    Datentyp: Zeichenfolge

    Tabelle: Suite [Scan_Check_Suite]
    Tabelle : 74. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 75. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    App_scope_sys_IDs Erforderlich. Eine Liste der sys_IDs der bereichsbezogenen Anwendungen, die gescannt werden sollen. Darf kein leeres Array sein.
    Datentyp: Array
    app_scope_sys_ids: ["String", "String", "String"]

    Tabelle: Anwendung [sys_scope]

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

    Standard: application/json
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 77. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 78. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Die Anwenderanmeldeinformationen sind falsch.
    403 Unzulässig. Der Anwender ist kein Administrator oder verfügt nicht über die Rolle „sn_cicd.sys_ci_Automation“.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

    Antworttext-Parameter (JSON oder XML)

    Element Beschreibung
    Fehler Fehlermeldung mit Details zum Fehler.

    Datentyp: Zeichenfolge
    Links Informationen zu Links und sys_IDs, die dem Update-Satz zugeordnet sind.

    Datentyp: Objekt

    "links": {
  "progress": {Object}
}
    links.progress Fortschrittsinformationen zum Vorgang, der für den Update-Satz ausgeführt wird.

    Datentyp: Objekt

    "progress": {
  "id": "String",
  "url": "String"
}
    links.progress.id Eindeutiger Bezeichner des Fortschrittsdetails. Verwenden Sie diesen Wert, wenn Sie den Endpunkt aufrufen /sn_cicd/instance_Scan/result/{Progress_ID} .

    Datentyp: Zeichenfolge
    links.progress.url URL, die zum Abrufen der Fortschrittsdetails des für den Update-Satz ausgeführten Vorgangs verwendet werden soll.

    Datentyp: Zeichenfolge
    status Zahl, die den Ausführungsstatus der Aktion darstellt, die für den Update-Satz ausgeführt wird. Entspricht status_labelDeskriptor.
    Mögliche Werte:
    • 0: Ausstehend
    • 1: Wird Ausgeführt
    • 2: Erfolgreich
    • 3: Fehlgeschlagen
    • 4: Abgebrochen

    Datentyp: Zeichenfolge
    status_detail Detaillierte Nachricht zum Ausführungsstatus, falls verfügbar. Entspricht dem Feld Detailed_message in der Tabelle „Ausführungstracker“ [sys_Execution_Tracker].

    Datentyp: Zeichenfolge
    status_label Ausführungsstatus der Update-Satz-Aktion. Entspricht statusNummer.
    Mögliche Werte:
    • Abgebrochen
    • Fehlgeschlagen
    • Ausstehend
    • Wird ausgeführt
    • Erfolgreich

    Datentyp: Zeichenfolge
    status_message Zusätzliche Informationen dazu, warum der Vorgang fehlgeschlagen ist. Gibt eine leere Zeichenfolge zurück, wenn der Vorgang erfolgreich ist.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    In diesem Beispiel werden alle aktiven Prüfungen innerhalb einer Suite für eine bereichsbezogene Anwendung ausgeführt.

    curl "https://instance.servicenow.com/api/sn_cicd/instance_scan/suite_scan/833655cc1b94101046e87733cd4bcb4e/scoped_apps" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{app_scope_sys_ids: [\"078e8020950f12a215a92e8ad9b346e0\"]}" \
--user 'username':'password'

    Antworttext: Erfolg.

    {
  "result": {
    "links": {
      "progress": {
        "id": "147fc14b1b572010178aed72604bcbca",
        "url": "https://instance.servicenow.com/api/sn_cicd/progress/147fc14b1b572010178aed72604bcbca"
      }
    },
    "status": "0",
    "status_label": "Pending",
    "status_message": "",
    "status_detail": "",
    "error": ""
  }
}

    CI/CD – POST /sn_cicd/instance_Scan/Suite_Scan/{Suite_sys_ID}/Update_Sets

    Führt alle aktiven Prüfungen innerhalb einer Suite anhand einer Liste von Update-Sätzen aus.

    Hinweis:
    Dieser Endpunkt ist Teil von Ausführungsservice für CICD-Instanz-Scan API und wird unter verwendet sn_cicd Namespace.

    URL-Format

    Versionierte URL: /api/sn_cicd/{api_Version}/instance_Scan/Suite_Scan/{Suite_sys_ID}/Update_Sets

    Standard-URL: /api/sn_cicd/instance_Scan/Suite_Scan/{Suite_sys_ID}/Update_Sets

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    suite_sys_ID SYS_ID des Suite Zur Ausführung.

    Datentyp: Zeichenfolge

    Tabelle: Suite [Scan_Check_Suite]
    Tabelle : 80. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 81. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Update_Set_sys_IDs Erforderlich. Liste der sys_IDs der zu scannenden Update-Sätze. Darf kein leeres Array sein.
    Datentyp: Array
    update_set_sys_ids: ["String", "String", "String"]

    Tabelle: Update-Satz [sys_Update_Set]

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

    Standard: application/json
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 83. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 84. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Die Anwenderanmeldeinformationen sind falsch.
    403 Unzulässig. Der Anwender ist kein Administrator oder verfügt nicht über die Rolle „sn_cicd.sys_ci_Automation“.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

    Antworttext-Parameter (JSON oder XML)

    Element Beschreibung
    Fehler Fehlermeldung mit Details zum Fehler.

    Datentyp: Zeichenfolge
    Links Informationen zu Links und sys_IDs, die dem Update-Satz zugeordnet sind.

    Datentyp: Objekt

    "links": {
  "progress": {Object}
}
    links.progress Fortschrittsinformationen zum Vorgang, der für den Update-Satz ausgeführt wird.

    Datentyp: Objekt

    "progress": {
  "id": "String",
  "url": "String"
}
    links.progress.id Eindeutiger Bezeichner des Fortschrittsdetails. Verwenden Sie diesen Wert, wenn Sie den Endpunkt aufrufen /sn_cicd/instance_Scan/result/{Progress_ID} .

    Datentyp: Zeichenfolge
    links.progress.url URL, die zum Abrufen der Fortschrittsdetails des für den Update-Satz ausgeführten Vorgangs verwendet werden soll.

    Datentyp: Zeichenfolge
    status Zahl, die den Ausführungsstatus der Aktion darstellt, die für den Update-Satz ausgeführt wird. Entspricht status_labelDeskriptor.
    Mögliche Werte:
    • 0: Ausstehend
    • 1: Wird Ausgeführt
    • 2: Erfolgreich
    • 3: Fehlgeschlagen
    • 4: Abgebrochen

    Datentyp: Zeichenfolge
    status_detail Detaillierte Nachricht zum Ausführungsstatus, falls verfügbar. Entspricht dem Feld Detailed_message in der Tabelle „Ausführungstracker“ [sys_Execution_Tracker].

    Datentyp: Zeichenfolge
    status_label Ausführungsstatus der Update-Satz-Aktion. Entspricht statusNummer.
    Mögliche Werte:
    • Abgebrochen
    • Fehlgeschlagen
    • Ausstehend
    • Wird ausgeführt
    • Erfolgreich

    Datentyp: Zeichenfolge
    status_message Zusätzliche Informationen dazu, warum der Vorgang fehlgeschlagen ist. Gibt eine leere Zeichenfolge zurück, wenn der Vorgang erfolgreich ist.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    In diesem Beispiel werden alle aktiven Prüfungen innerhalb einer Suite für einen Update-Satz ausgeführt.

    curl "https://instance.servicenow.com/api/sn_cicd/instance_scan/suite_scan/833655cc1b94101046e87733cd4bcb4e/update_sets" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{update_set_sys_ids: [\"7abef63c1b572010178aed72604bcbfd\"]}" \
--user 'username':'password'

    Antworttext: Erfolg.

    {
  "result": {
    "links": {
      "progress": {
        "id": "d27511031b972010178aed72604bcb72",
        "url": "https://instance.servicenow.com/api/sn_cicd/progress/d27511031b972010178aed72604bcb72"
      }
    },
    "status": "0",
    "status_label": "Pending",
    "status_message": "",
    "status_detail": "",
    "error": ""
  }
}

    CI/CD – POST /sn_cicd/Plugin/{Plugin_ID}/activate

    Aktiviert das angegebene Plugin.

    URL-Format

    Versionierte URL: /api/sn_cicd/{api_Version}/Plugin/{Plugin_ID}/Aktivieren

    Standard-URL: /api/sn_cicd/Plugin/{Plugin_ID}/activate

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    plugin_id Eindeutiger Bezeichner des Plugins. Sie können diesen Bezeichner auf der Seite „Plugins“ innerhalb der Karte des gewünschten Plugins suchen; identifiziert mit dem Namen „ID“.

    Datentyp: Zeichenfolge
    Tabelle : 86. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 87. 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 : 88. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 89. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 90. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Die Anwenderanmeldeinformationen sind falsch.
    403 Unzulässig. Der Anwender ist kein Administrator oder verfügt nicht über die Rolle „sn_cicd.sys_ci_Automation“.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    405 Ungültige Methode. Die Funktionalität ist inaktiv.
    409 Konflikt. Das angeforderte Element ist nicht eindeutig.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Fehler Fehlermeldung mit Details zum Fehler.

    Datentyp: Zeichenfolge
    Links Informationen zu Links und sys_IDs, die dem Update-Satz zugeordnet sind.

    Datentyp: Objekt

    "links": {
  "progress": {Object}
}
    links.progress Fortschrittsinformationen zum Vorgang, der für den Update-Satz ausgeführt wird.

    Datentyp: Objekt

    "progress": {
  "id": "String",
  "url": "String"
}
    links.progress.id SYS_ID mit Fortschrittsdetails für den Vorgang. Sie können diesen Wert beim Aufrufen des Endpunkts verwenden CI/CD – GET /sn_cicd/Progress/{Progress_ID}.

    Datentyp: Zeichenfolge
    links.progress.url URL, die zum Abrufen der Fortschrittsdetails des für den Update-Satz ausgeführten Vorgangs verwendet werden soll.

    Datentyp: Zeichenfolge
    Links.Ergebnisse ID und URL der Ausführungsergebnisse.

    Datentyp: Objekt

    "results": {
  "id": "String",
  "url": "String"
}
    links.results.id SYS_ID der Ergebnisinformationen. Verwenden Sie diesen Wert, wenn Sie den zugehörigen Ergebnisendpunkt aufrufen.

    Datentyp: Zeichenfolge
    Links.Ergebnisse.url URL, die zum Abrufen der Ergebnisse der Endpunktausführung verwendet werden soll.

    Datentyp: Zeichenfolge
    percent_complete Prozentsatz der abgeschlossenen Anforderung.

    Datentyp: Zahl
    Status Zahl, die den Ausführungsstatus der Aktion darstellt, die für den Update-Satz ausgeführt wird. Entspricht status_labelDeskriptor.
    Mögliche Werte:
    • 0: Ausstehend
    • 1: Wird Ausgeführt
    • 2: Erfolgreich
    • 3: Fehlgeschlagen
    • 4: Abgebrochen

    Datentyp: Zeichenfolge
    status_detail Detaillierte Nachricht zum Ausführungsstatus, falls verfügbar. Entspricht dem Feld Detailed_message in der Tabelle „Ausführungstracker“ [sys_Execution_Tracker].

    Datentyp: Zeichenfolge
    status_label Ausführungsstatus der Update-Satz-Aktion. Entspricht statusNummer.
    Mögliche Werte:
    • Abgebrochen
    • Fehlgeschlagen
    • Ausstehend
    • Wird ausgeführt
    • Erfolgreich

    Datentyp: Zeichenfolge
    status_message Zusätzliche Beschreibung des aktuellen Status der Aktion, falls verfügbar.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    curl 'instance.servicenow.com/api/sn_cicd/plugin/com.glide.web_service_aggregate/activate' \
--request POST \
--header 'Accept: application/json' \
--user 'username':'password'
    {
"result": {
   "links": {
      "progress": {
          "id": "5b3f052ddb580010caf55268dc961963",
          "url": "https://instance.service-now.com/api/sn_cicd/progress/5b3f052ddb580010caf55268dc961963"
       }
   },
   "status": "0",
   "status_label": "Pending",
   "status_message": "",
   "status_detail": "",
   "error": "",
   "percent_complete": 0
  }
}

    CI/CD – POST /sn_cicd/Plugin/{Plugin_ID}/Rollback

    Setzt das angegebene Plugin auf die zuvor installierte Version zurück. Wenn keine vorherige Version installiert wurde, gibt einen Fehler zurück.

    URL-Format

    Versionierte URL: /api/sn_cicd/{api_Version}Plugin/{Plugin_ID}/Rollback

    Standard-URL: /api/sn_cicd/Plugin/{Plugin_ID}/Rollback

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    plugin_id Eindeutiger Bezeichner des Plugins. Sie können diesen Bezeichner auf der Seite „Plugins“ innerhalb der Karte des gewünschten Plugins suchen; identifiziert mit dem Namen „ID“.

    Datentyp: Zeichenfolge
    Tabelle : 92. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 93. 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 : 94. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 95. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 96. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Die Anwenderanmeldeinformationen sind falsch.
    403 Unzulässig. Der Anwender ist kein Administrator oder verfügt nicht über die Rolle „sn_cicd.sys_ci_Automation“.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    405 Ungültige Methode. Die Funktionalität ist inaktiv.
    409 Konflikt. Das angeforderte Element ist nicht eindeutig.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Fehler Fehlermeldung mit Details zum Fehler.

    Datentyp: Zeichenfolge
    Links Informationen zu Links und sys_IDs, die dem Update-Satz zugeordnet sind.

    Datentyp: Objekt

    "links": {
  "progress": {Object}
}
    links.progress Fortschrittsinformationen zum Vorgang, der für den Update-Satz ausgeführt wird.

    Datentyp: Objekt

    "progress": {
  "id": "String",
  "url": "String"
}
    links.progress.id SYS_ID mit Fortschrittsdetails für den Vorgang. Sie können diesen Wert beim Aufrufen des Endpunkts verwenden CI/CD – GET /sn_cicd/Progress/{Progress_ID}.

    Datentyp: Zeichenfolge
    links.progress.url URL, die zum Abrufen der Fortschrittsdetails des für den Update-Satz ausgeführten Vorgangs verwendet werden soll.

    Datentyp: Zeichenfolge
    percent_complete Prozentsatz der abgeschlossenen Anforderung.

    Datentyp: Zahl
    Status Zahl, die den Ausführungsstatus der Aktion darstellt, die für den Update-Satz ausgeführt wird. Entspricht status_labelDeskriptor.
    Mögliche Werte:
    • 0: Ausstehend
    • 1: Wird Ausgeführt
    • 2: Erfolgreich
    • 3: Fehlgeschlagen
    • 4: Abgebrochen

    Datentyp: Zeichenfolge
    status_detail Detaillierte Nachricht zum Ausführungsstatus, falls verfügbar. Entspricht dem Feld Detailed_message in der Tabelle „Ausführungstracker“ [sys_Execution_Tracker].

    Datentyp: Zeichenfolge
    status_label Ausführungsstatus der Update-Satz-Aktion. Entspricht statusNummer.
    Mögliche Werte:
    • Abgebrochen
    • Fehlgeschlagen
    • Ausstehend
    • Wird ausgeführt
    • Erfolgreich

    Datentyp: Zeichenfolge
    status_message Zusätzliche Beschreibung des aktuellen Status der Aktion, falls verfügbar.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    curl 'instance.servicenow.com/api/sn_cicd/plugin/com.glide.web_service_aggregate/rollback' \
--request POST \
--header 'Accept: application/json' \
--user 'username':'password'
    {
"result": {
   "links": {
      "progress": {
         "id": "6185dd61db980010caf55268dc961916",
          "url": "https://instance.service-now.com/api/sn_cicd/progress/6185dd61db980010caf55268dc961916"
        }
    },
    "status": "0",
    "status_label": "Pending",
    "status_message": "",
    "status_detail": "",
    "error": "",
    "percent_complete": 0
  }
}

    CI/CD – NACH /sn_cicd/sc/apply_Changes

    Beginnt mit der Anwendung von Änderungen aus einer Remote-Quellcodeverwaltung auf eine bestimmte lokale Anwendung oder Anwendungsanpassung.

    URL-Format

    Versionierte URL: /api/sn_cicd/{api_Version}/sc/apply_changes

    Standard-URL: /api/sn_cicd/sc/apply_changes

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    Tabelle : 98. Abfrageparameter
    Name Beschreibung
    auto_Upgrade_Base_App Gilt nur, wenn Änderungen für die App-Anpassung angewendet werden und der neueste Commit im Git-Repository auf einer Version basiert, die höher ist als die der Basisanwendung, die derzeit auf der lokalen Instanz installiert ist. Kennzeichnung, die angibt, ob das System die Basisanwendung automatisch auf eine spätere Version upgraden soll.

    Datentyp: Boolesch

    Standardwert: wahr
    Branch_Name Name der Verzweigung im Quellcodeverwaltungssystem, von der die Anwendung abgerufen werden soll.

    Datentyp: Zeichenfolge

    Standard: Standardverzweigung, die im Quellcodeverwaltungssystem angegeben ist.
    scope Erforderlich, wenn sys_idIst nicht angegeben. Der Bereichsname der Anwendung, für die die Änderungen angewendet werden sollen, z. B. x_Aah_custom_App. Sie können diesen Wert in finden scopeFeld in der Tabelle „Anwenderdefinierte Anwendung“ [sys_App] oder in der Tabelle „Store-Anwendung“ [sys_Store_App] für die App-Customization.

    Datentyp: Zeichenfolge
    sys_id Erforderlich, wenn scopeIst nicht angegeben. Die sys_ID der Anwendung, für die die Änderungen angewendet werden sollen. Sie können diesen Wert in finden Sys IDFeld in der Tabelle „Anwenderdefinierte Anwendung“ [sys_App] oder in der Tabelle „Store-Anwendung“ [sys_Store_App] für die App-Customization.

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

    Standard: application/json
    Tabelle : 101. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 102. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Die Anwenderanmeldeinformationen sind falsch.
    403 Unzulässig. Der Anwender ist kein Administrator oder verfügt nicht über die Rolle „sn_cicd.sys_ci_Automation“.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    405 Ungültige Methode. Die Funktionalität ist inaktiv.
    409 Konflikt. Das angeforderte Element ist nicht eindeutig.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Fehler Fehlermeldung mit Details zum Fehler.

    Datentyp: Zeichenfolge
    Links Informationen zu Links und sys_IDs, die dem Update-Satz zugeordnet sind.

    Datentyp: Objekt

    "links": {
  "progress": {Object}
}
    links.progress Fortschrittsinformationen zum Vorgang, der für den Update-Satz ausgeführt wird.

    Datentyp: Objekt

    "progress": {
  "id": "String",
  "url": "String"
}
    links.progress.id SYS_ID mit Fortschrittsdetails für den Vorgang. Sie können diesen Wert beim Aufrufen des Endpunkts verwenden CI/CD – GET /sn_cicd/Progress/{Progress_ID}.

    Datentyp: Zeichenfolge
    links.progress.url URL, die zum Abrufen der Fortschrittsdetails des für den Update-Satz ausgeführten Vorgangs verwendet werden soll.

    Datentyp: Zeichenfolge
    percent_complete Prozentsatz der abgeschlossenen Anforderung.

    Datentyp: Zahl
    Status Zahl, die den Ausführungsstatus der Aktion darstellt, die für den Update-Satz ausgeführt wird. Entspricht status_labelDeskriptor.
    Mögliche Werte:
    • 0: Ausstehend
    • 1: Wird Ausgeführt
    • 2: Erfolgreich
    • 3: Fehlgeschlagen
    • 4: Abgebrochen

    Datentyp: Zeichenfolge
    status_detail Detaillierte Nachricht zum Ausführungsstatus, falls verfügbar. Entspricht dem Feld Detailed_message in der Tabelle „Ausführungstracker“ [sys_Execution_Tracker].

    Datentyp: Zeichenfolge
    status_label Ausführungsstatus der Update-Satz-Aktion. Entspricht statusNummer.
    Mögliche Werte:
    • Abgebrochen
    • Fehlgeschlagen
    • Ausstehend
    • Wird ausgeführt
    • Erfolgreich

    Datentyp: Zeichenfolge
    status_message Zusätzliche Informationen dazu, warum der Vorgang fehlgeschlagen ist. Gibt eine leere Zeichenfolge zurück, wenn der Vorgang erfolgreich ist.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    curl 'https://instance.servicenow.com/api/sn_cicd/sc/apply_changes?app_sys_id=043db024db737300a9a754e4dc961915' \
--request POST \
--header 'Accept: application/json' \
--user 'username':'password'
    {
"result": {
   "links": {
       "progress": {
           "id": "a4fae8911bdc00103d374087bc4bcbbd",
           "url": "https://instance.service-now/api/sn_cicd/progress/a4fae8911bdc00103d374087bc4bcbbd"
        }
    },
    "status": "0",
    "status_label": "Pending",
    "status_message": "",
    "status_detail": "",
    "error": "",
    "percent_complete": 0
  }
}

    CI/CD – POST /sn_cicd/sc/apply_stash/{stash_ID}

    Beginnt mit der Anwendung eines zuvor generierten „Stash“ von Changes aus einer Remote-Quellcodeverwaltung auf eine angegebene lokale Anwendung oder Anwendungsanpassung.

    Dieser Endpunkt funktioniert in Verbindung mit POST/api/sn_cicd/sc/apply_changes Und CI/CD – GET /sn_cicd/Progress/{Progress_ID} Endpunkte. Wenn VERÖFFENTLICHEN SIE /api/sn_cicd/sc/apply_changes Endpunkt wird aufgerufen, alle nicht gespeicherten oder nicht bestätigten Änderungen in App Engine Studio In der zugehörigen Instanz werden als in der Datenbank gespeichert Stash .

    Die Möglichkeit, zu bestimmen, ob ein Stash erstellt wurde, als die Änderungen anfänglich angewendet wurden, besteht darin, den aufzurufen RUFEN SIE /sn_cicd/PROGRESS/{PROGRESS_ID} AB Endpunkt. Wenn ein Stash erstellt wurde, wird die sys_ID ( stash_id) Und URL des Stash werden zurückgegeben. Rufen Sie diese Option auf, um die Changes mit Stash auf die zugehörige Anwendung anzuwenden Apply_Stash Endpunkt, der verwendet stash_idZurückgegeben von Fortschritt Endpunkt.

    URL-Format

    Versionierte URL: /api/sn_cicd/{api_Version}/sc/apply_stash/{stash_ID}

    Standard-URL: /api/sn_cicd/sc/apply_stash/{stash_ID}

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    stash_id Eindeutiger Bezeichner des anzuwendenden Stash. Dieser Wert wird in zurückgegeben links.stash.idParameter in der entsprechenden CI/CD – GET /sn_cicd/Progress/{Progress_ID} Endpunktaufruf.

    Datentyp: Zeichenfolge
    Tabelle : 104. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 105. 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 : 106. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Inhaltstyp Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 107. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 108. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Die Anwenderanmeldeinformationen sind falsch.
    403 Unzulässig. Der Anwender ist kein Administrator oder verfügt nicht über die Rolle „sn_cicd.sys_ci_Automation“.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    405 Ungültige Methode. Die Funktionalität ist inaktiv.
    409 Konflikt. Das angeforderte Element ist nicht eindeutig.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Fehler Fehlermeldung mit Details zum Fehler.

    Datentyp: Zeichenfolge
    Links Informationen zu Links und sys_IDs, die dem Update-Satz zugeordnet sind.

    Datentyp: Objekt

    "links": {
  "progress": {Object}
}
    links.progress Fortschrittsinformationen zum Vorgang, der für den Update-Satz ausgeführt wird.

    Datentyp: Objekt

    "progress": {
  "id": "String",
  "url": "String"
}
    links.progress.id SYS_ID mit Fortschrittsdetails für den Vorgang. Sie können diesen Wert beim Aufrufen des Endpunkts verwenden CI/CD – GET /sn_cicd/Progress/{Progress_ID}.

    Datentyp: Zeichenfolge
    links.progress.url URL, die zum Abrufen der Fortschrittsdetails des für den Update-Satz ausgeführten Vorgangs verwendet werden soll.

    Datentyp: Zeichenfolge
    percent_complete Prozentsatz der abgeschlossenen Anforderung.

    Datentyp: Zahl
    Status Zahl, die den Ausführungsstatus der Aktion darstellt, die für den Update-Satz ausgeführt wird. Entspricht status_labelDeskriptor.
    Mögliche Werte:
    • 0: Ausstehend
    • 1: Wird Ausgeführt
    • 2: Erfolgreich
    • 3: Fehlgeschlagen
    • 4: Abgebrochen

    Datentyp: Zeichenfolge
    status_detail Detaillierte Nachricht zum Ausführungsstatus, falls verfügbar. Entspricht dem Feld Detailed_message in der Tabelle „Ausführungstracker“ [sys_Execution_Tracker].

    Datentyp: Zeichenfolge
    status_label Ausführungsstatus der Update-Satz-Aktion. Entspricht statusNummer.
    Mögliche Werte:
    • Abgebrochen
    • Fehlgeschlagen
    • Ausstehend
    • Wird ausgeführt
    • Erfolgreich

    Datentyp: Zeichenfolge
    status_message Zusätzliche Beschreibung des aktuellen Status der Aktion, falls verfügbar.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie der aufgerufen wird Apply_Stash Endpunkt für stash_idFc2224e4e0429110f8771827f8fd3634.

    curl "https://instance.servicenow.com/api/sn_cicd/sc/apply_stash/fc2224e4e0429110f8771827f8fd3634"\
--request POST \
--header "Accept:application/json" \
--header "Content_Type:application/json" \
--user 'username':'password'

    Der Stash steht aus und wurde daher noch nicht angewendet.

    {
  "result": {
    "links": {
      "progress": {
        "id": "6b04ec28e0429110f8771827f8fd36a4",
        "url": "https://instance.servicenow.com/api/sn_cicd/progress/6b04ec28e0429110f8771827f8fd36a4"
      }
    },
    "status": "0",
    "status_label": "Pending",
    "status_message": "",
    "status_detail": "",
    "error": "",
    "percent_complete": 0
  }
}

    CI/CD: NACH /sn_cicd/sc/Import

    Importiert eine Anwendung mit der angegebenen Repository-URL und dem angegebenen Verzweigungsnamen.

    Verwenden Sie diesen Endpunkt, um eine Anwendung aus der Quellcodeverwaltung in die aufrufende Instanz zu importieren, damit Sie dann verwenden können Kontinuierliche Integration und kontinuierliche Bereitstellung (CICD) Endpunkte, z. B. /sn_cicd/sc/apply_changes , Um die Anwendung in oberen Umgebungen bereitzustellen.

    Hinweis:
    Vor der Verwendung dieses Endpunkts ein Git-Repository, das von einer anderen Instanz mit eingerichtet wurde Link zur Quellcodeverwaltung Muss verfügbar sein.

    URL-Format

    Versionierte URL: /api/sn_cicd/{api_Version}/sc/Import

    Standard-URL: /api/sn_cicd/sc/Import

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    Tabelle : 110. Abfrageparameter
    Name Beschreibung
    auto_Upgrade_Base_App Gilt nur, wenn die importierte Anwendung eine App-Anpassung ist und der neueste Commit im Git-Repository auf einer Version basiert, die höher ist als die der Basisanwendung, die derzeit auf der lokalen Instanz installiert ist.

    Kennzeichnung, die angibt, ob das System die Basisanwendung automatisch auf eine spätere Version upgraden soll.

    Gültige Werte:
    • Wahr: Upgrade der Basisanwendung automatisch durchführen.
    • Falsch: Führen Sie kein automatisches Upgrade der Basisanwendung durch.

    Datentyp: Boolesch

    Standardwert: True
    Branch_Name Erforderlich. Name der Verzweigung im Quellcodeverwaltungssystem, aus der die Anwendung importiert werden soll.

    Datentyp: Zeichenfolge
    credential_sys_id SYS_ID der Anmeldeinformationen, die Zugriff auf das Git-Repository haben.

    Datentyp: Zeichenfolge

    Standard: SYS_ID in den Systemeigenschaften glide.source_control.default_basic_auth_credential_sys_id oder glide.source_control.default_ssh_private_key_credential_sys_id festgelegt, je nachdem, ob repo_urlParameter ist ein HTTPS- oder SSH-Repository. Standardmäßig ist diese Eigenschaft leer.
    Mid_Server_sys_ID SYS_ID des MID-Servers, der für Quellsteuerungsvorgänge für diese Anwendung verwendet werden soll.

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge/Null
    repo_url Erforderlich. URL des Git-Repositorys, aus dem die Anwendung importiert werden soll.

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

    Standard: application/json
    Tabelle : 113. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 114. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Die Anwenderanmeldeinformationen sind falsch.
    403 Unzulässig. Der Anwender ist kein Administrator oder verfügt nicht über die Rolle „sn_cicd.sys_ci_Automation“.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    405 Ungültige Methode. Die Funktionalität ist inaktiv.
    409 Konflikt. Das angeforderte Element ist nicht eindeutig.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Fehler Fehlermeldung mit Details zum Fehler.

    Datentyp: Zeichenfolge
    Links Informationen zu Links und sys_IDs, die dem Update-Satz zugeordnet sind.

    Datentyp: Objekt

    "links": {
  "progress": {Object}
}
    links.progress Fortschrittsinformationen zum Vorgang, der für den Update-Satz ausgeführt wird.

    Datentyp: Objekt

    "progress": {
  "id": "String",
  "url": "String"
}
    links.progress.id SYS_ID mit Fortschrittsdetails für den Vorgang. Sie können diesen Wert beim Aufrufen des Endpunkts verwenden CI/CD – GET /sn_cicd/Progress/{Progress_ID}.

    Datentyp: Zeichenfolge
    links.progress.url URL, die zum Abrufen der Fortschrittsdetails des für den Update-Satz ausgeführten Vorgangs verwendet werden soll.

    Datentyp: Zeichenfolge
    percent_complete Prozentsatz der abgeschlossenen Anforderung.

    Datentyp: Zahl
    Status Zahl, die den Ausführungsstatus der Aktion darstellt, die für den Update-Satz ausgeführt wird. Entspricht status_labelDeskriptor.
    Mögliche Werte:
    • 0: Ausstehend
    • 1: Wird Ausgeführt
    • 2: Erfolgreich
    • 3: Fehlgeschlagen
    • 4: Abgebrochen

    Datentyp: Zeichenfolge
    status_detail Detaillierte Nachricht zum Ausführungsstatus, falls verfügbar. Entspricht dem Feld Detailed_message in der Tabelle „Ausführungstracker“ [sys_Execution_Tracker].

    Datentyp: Zeichenfolge
    status_label Ausführungsstatus der Update-Satz-Aktion. Entspricht statusNummer.
    Mögliche Werte:
    • Abgebrochen
    • Fehlgeschlagen
    • Ausstehend
    • Wird ausgeführt
    • Erfolgreich

    Datentyp: Zeichenfolge
    status_message Zusätzliche Beschreibung des aktuellen Status der Aktion, falls verfügbar.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie die Anwendung importiert wird, die sich unter befindet https://code.devsnc.com/some-user/ncRegrApp1.git In Main_Branch .

    curl "https://instance.servicenow.com/api/sn_cicd/sc/import?repo_url=https%3A%2F%2Fcode.devsnc.com%2Fsome-user%2FncRegrApp1.git&branch_name=main_branch&credential_sys_id=af9b6d6180feb010f8779c30d4dd6b6b" \
--request POST \
--header "Accept:application/json" \
--user 'admin':'admin'

    Gibt den Fortschritt des Imports zurück.

    {
  "result": {
    "links": {
      "progress": {
        "id": "a18c06ea64f23010f87769cd983d4574",
        "url": "https://instance.servicenow.com/api/sn_cicd/progress/a18c06ea64f23010f87769cd983d4574"
      }
    },
    "status": "0",
    "status_label": "Pending",
    "status_message": "",
    "status_detail": "",
    "error": "",
    "percent_complete": 0
  }
}

    CI/CD: NACH /sn_cicd/testsuite/Run

    Startet eine angegebene automatisierte Test-Suite. Die Test-Suite wird auf der Instanz ausgeführt, von der aus der Endpunkt aufgerufen wurde.

    Hinweis:
    Wenn die von Ihnen ausgeführte Suite UI-Tests enthält, müssen Sie entweder einen geplanten Client Test Runner geöffnet haben oder die Ausführung von Headless Test Runner konfigurieren können. Weitere Informationen finden Sie unter Headless-Browser für Automated Test Framework .

    URL-Format

    Versionierte URL: /api/sn_cicd/{api_Version}/testsuite/Run

    Standard-URL: /api/sn_cicd/testsuite/Run

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    Tabelle : 116. Abfrageparameter
    Name Beschreibung
    Browsername Name des Browsers, der zum Ausführen des Client-Tests verwendet werden soll. Dieser Wert muss mit den Angaben im geplanten Client-Test Runner übereinstimmen. Weitere Informationen zu geplanten Client-Test Runners finden Sie unter Geplante Client-Test Runner .

    Datentyp: Zeichenfolge

    Gültige Werte: (Muss nur Kleinbuchstaben enthalten)

    • Beliebig
    • chrome
    • firefox
    • Edge
    • ie
    • safari

    Standard: Beliebig
    Browser_Version Startwert der in angegebenen Version des Browsers browser_nameZur Ausführung des Tests. Wenn Sie beispielsweise „9“ eingeben, werden alle 9.x.x.x-Versionen aktiviert. Dieser Wert muss mit den Angaben im geplanten Client-Test Runner übereinstimmen.

    Datentyp: Zeichenfolge
    Is_Performance_Run Optional.

    Kennzeichnung, die angibt, ob die Test-Suite als Leistungstest (Leistungsausführung) ausgeführt werden soll.

    Gültige Werte:
    • Wahr: Führt die Test-Suite als Leistungstest aus.
    • Falsch: Führt die Test-Suite mit dem Standardverhalten eines Standard-Funktionstests der Instanz aus.

    Standardwert: false
    os_name Name des Betriebssystems, unter dem die Test-Suite ausgeführt werden soll. Dieser Wert muss mit den Angaben im geplanten Client-Test Runner übereinstimmen.

    Datentyp: Zeichenfolge
    os_version Startwert der Version des Betriebssystems, unter der die Test-Suite ausgeführt werden soll. Wenn Sie beispielsweise „8“ eingeben, werden alle 8.x.x.x-Versionen aktiviert. Dieser Wert muss mit den Angaben im geplanten Client-Test Runner übereinstimmen.

    Datentyp: Zeichenfolge
    Run_in_Cloud Optional. Kennzeichnung, die angibt, ob die Test-Suite in Cloud Runner oder manuell ausgeführt werden soll.
    Gültige Werte:
    • Wahr: Führt die Test-Suite mit Cloud Runner aus.
    • Falsch: Führt die Test-Suite mit dem manuellen Test Runner aus.

    Standardwert: false
    Test_Suite_sys_ID Erforderlich, wenn test_suite_nameIst nicht angegeben. Die sys_ID der auszuführenden Test-Suite.

    Datentyp: Zeichenfolge

    Tabelle: Test [sys_atf_Test_Suite]
    test_suite_name Erforderlich, wenn test_suite_sys_idIst nicht angegeben. Der Name der auszuführenden Test-Suite.

    Datentyp: Zeichenfolge

    Tabelle: Test [sys_atf_Test_Suite]
    Tabelle : 117. 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 : 118. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 119. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 120. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Die Anwenderanmeldeinformationen sind falsch.
    403 Unzulässig. Der Anwender ist kein Administrator oder verfügt nicht über die Rolle „sn_cicd.sys_ci_Automation“.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    405 Ungültige Methode. Die Funktionalität ist inaktiv.
    409 Konflikt. Das angeforderte Element ist nicht eindeutig.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Fehler Fehlermeldung mit Details zum Fehler.

    Datentyp: Zeichenfolge
    Links Informationen zu Links und sys_IDs, die dem Update-Satz zugeordnet sind.

    Datentyp: Objekt

    "links": {
  "progress": {Object}
}
    links.progress Fortschrittsinformationen zum Vorgang, der für den Update-Satz ausgeführt wird.

    Datentyp: Objekt

    "progress": {
  "id": "String",
  "url": "String"
}
    links.progress.id SYS_ID mit Fortschrittsdetails für den Vorgang. Sie können diesen Wert beim Aufrufen des Endpunkts verwenden CI/CD – GET /sn_cicd/Progress/{Progress_ID}.

    Datentyp: Zeichenfolge
    links.progress.url URL, die zum Abrufen der Fortschrittsdetails des für den Update-Satz ausgeführten Vorgangs verwendet werden soll.

    Datentyp: Zeichenfolge
    Links.Ergebnisse ID und URL der Ausführungsergebnisse.

    Datentyp: Objekt

    "results": {
  "id": "String",
  "url": "String"
}
    links.results.id SYS_ID der Ergebnisinformationen. Verwenden Sie diesen Wert, wenn Sie den zugehörigen Ergebnisendpunkt aufrufen.

    Datentyp: Zeichenfolge
    Links.Ergebnisse.url URL, die zum Abrufen der Ergebnisse der Endpunktausführung verwendet werden soll.

    Datentyp: Zeichenfolge
    percent_complete Prozentsatz der abgeschlossenen Anforderung.

    Datentyp: Zahl
    Status Zahl, die den Ausführungsstatus der Aktion darstellt, die für den Update-Satz ausgeführt wird. Entspricht status_labelDeskriptor.
    Mögliche Werte:
    • 0: Ausstehend
    • 1: Wird Ausgeführt
    • 2: Erfolgreich
    • 3: Fehlgeschlagen
    • 4: Abgebrochen

    Datentyp: Zeichenfolge
    status_detail Detaillierte Nachricht zum Ausführungsstatus, falls verfügbar. Entspricht dem Feld Detailed_message in der Tabelle „Ausführungstracker“ [sys_Execution_Tracker].

    Datentyp: Zeichenfolge
    status_label Ausführungsstatus der Update-Satz-Aktion. Entspricht statusNummer.
    Mögliche Werte:
    • Abgebrochen
    • Fehlgeschlagen
    • Ausstehend
    • Wird ausgeführt
    • Erfolgreich

    Datentyp: Zeichenfolge
    status_message Zusätzliche Beschreibung des aktuellen Status der Aktion, falls verfügbar.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    curl 'https://instance.servicenow.com/api/sn_cicd/testsuite/run?test_suite_sys_id=632e43900b20220050192f15d6673a7e' \
--request POST \
--header 'Accept: application/json' \
--user 'username':'password'
    {
"result": {
   "links": {
       "progress": {
           "id": "0578a8d91bdc00103d374087bc4bcbcc",
           "url": "https://instance.service-now.com/api/sn_cicd/progress/0578a8d91bdc00103d374087bc4bcbcc"
        }
   },
   "status": "0",
   "status_label": "Pending",
   "status_message": "",
   "status_detail": "",
   "error": "",
   "percent_complete": 0
  }
}

    Fehlerantwort:

    {
"result": {
    "status": "3",
    "status_label": "Failed",
    "status_message": "",
    "status_detail": "",
    "error": "Scheduled test/suite execution is disabled. Change the value of property 'sn_atf.schedule.enabled' to true to enable it"
  }
}