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

Die CICD- API stellt Endpunkte bereit, die die Integration mit gängigen DevOps -Tools zum Erstellen von Pipelines ermöglichen. Zu diesen Tools gehören Jenkins, Azure Pipelines, GitLab, GitHub Actions, Atlassian Bread/Pipelines usw.

Sie bietet Integratoren die Möglichkeit, CICD -Pipelines für Now Platform -Anwendungen zu erstellen, die durch Pull-/Merge-Anforderungs-Workflows gesteuert werden, die für die quellengesteuerte Entwicklung typisch sind. Dabei werden die Funktionen Quellcodeverwaltung, Anwendungs-Repository und Automated Test Framework genutzt.

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

• Quellcodeverwaltung

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

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

• Anwendungs-Repository: Verfügbar für bereichsbezogene Anwendungen, globale Anwendungen, Anwendungsanpassungen für bereichsbezogene Anwendungen unter ServiceNow Storeund ü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.
  • Führen Sie ein Rollback für eine Anwendung durch, die über den Rollback-Kontext installiert wurde.
• Batch
  • Definieren Sie eine JSON-Manifestdatei für die Batch-Installation mehrerer Anwendungen gleichzeitig.
  • Setzt die gesamte Batch-Installation über den Rollback-Kontext zurück.
  • Gibt die Ergebnisse einer Batch-Installation basierend auf einem angegebenen Ergebnisbezeichner zurück.
• Plugins
  • Aktivieren Sie ein Plugin.
  • Rollback eines Plugins über einen Rollback-Kontext.
• Automated Test Framework (ATF)
  • Starten Sie eine ATF-Test-Suite.
  • Ruft das Bestanden/Nicht bestanden-Ergebnis einer ATF-Test-Suite ab.
• Instanzscan
  • Starten eines Instanzscans (vollständig, Punktscan in Tabelle, Punktscan in Datensatz, bereichsbezogene Anwendung, Update Set, Kombination dieser Elemente.)
  • Ruft das Bestanden/Fehlgeschlagen-Ergebnis eines Instanzscans ab.
• Fortschritt

  Rufen Sie den Prozentsatz der Fertigstellung in einer Instanz für Prozesse ab, die durch andere Endpunktaufrufe initiiert wurden. Sie können diese Funktion verwenden, um den Abschluss des Fortschritts abzurufen, bevor Sie mit dem nächsten Schritt fortfahren.

Diese API verwendet ein asynchrones Antwortmodell. Wenn Sie einen Endpunkt aufrufen, z. B. um die Test-Suite /sn_cicd/testsuite/run auszuführen, startet der Endpunkt die zugehörige Funktion, z. B. die Ausführung der Test-Suite. Der Endpunkt gibt dann eine Antwortnachricht zurück, die den Ausführungsstatus der angeforderten Funktion, in der Regel Ausstehend, zusammen mit einem eindeutigen Bezeichner und einem Link enthält. Verwenden Sie diese Informationen, um zusätzliche Informationen über den Fortschritt, die Quelle, die Ergebnisse und/oder die Ergebnisse der Anforderung zu erhalten. Je nach Funktionsanforderung können Sie auf eine der folgenden Arten zusätzliche Informationen zu einer Anforderung erhalten:

• Rufen Sie den Endpunkt /sn_cicd/progress/{progress_id} mit dem Parameter links.progress.id auf, der vom initiierenden Endpunkt zurückgegeben wird.
• Rufen Sie den Endpunkt /sn_cicd/testsuite/results/{result_id} mit dem Parameter links.result.id auf, der vom initiierenden Endpunkt zurückgegeben wurde.
• Rufen Sie den Endpunkt /sn_cicd/instance_scan/result/{progress_id} mit dem Parameter links.progress.id auf, der vom initiierenden Endpunkt zurückgegeben wird.
• Rufen Sie den Endpunkt /sn_cicd/sc/apply_stash/{stash_id} mit dem Parameter links.stash.id auf, der vom Endpunkt/sn_cicd/progress/{progress_id} zurückgegeben wird.
• Verknüpfen Sie mit dem Parameter links.<progress/result/source/findings>.url, der vom initiierenden Endpunkt zurückgegeben wird.

Hinweis:

Um eine Anwendung aus einem Repository zu installieren, muss die Anwendung zuerst mit dem Endpunkt /sn_cicd/app_repo/publish im Repository veröffentlicht werden. Nach der Veröffentlichung kann die Anwendung von jeder mit diesem Repository verbundenen Instanz installiert und zurückgesetzt werden. 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.

Ab Tokyoverwenden die CICD API-Endpunkte, die die instanzweite Sperre/den Mutex abrufen müssen, um den angeforderten Vorgang auszuführen, eine Warteschlange, anstatt Anforderungen abzulehnen, während die instanzweite Sperre/der Mutex belegt ist. Mehrere CICD -Pipelines stellen gleichzeitig Anforderungen, ohne die Ablehnung und Wiederholung zu erkennen. Stattdessen können sie den Fortschritt einfach wie bei zuvor erfolgreichen Anforderungen überwachen. Dieses Verhalten ist standardmäßig aktiviert.

Die aktuelle Warteschlange kann von einem Benutzer mit der Rolle admin überprüft werden, indem er zu Systemdiagnose -> Warteschlange für Anwendungsvorgängenavigiert. Von hier aus kann die Warteschlange vom Administrator angehalten und fortgesetzt werden, um andere manuelle Vorgänge zu ermöglichen, die möglicherweise die instanzweite Sperre/Mutexerfordern.

Hinweis:

Im angehaltenen Zustand werden alle laufenden Vorgänge vollständig 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 vor Beginn der Ausführung abgebrochen werden, indem der aufgeführte Ausführungstracker in den Status „Abgebrochen“ versetzt wird. Wenn ein Vorgang aus irgendeinem Grund nach der in „com.glide.update_operation.job_cancel_timeout_minutes“ angegebenen Zeitüberschreitung (Standard: 48 Stunden) nicht fortgesetzt werden kann, wird er abgebrochen.

Wenn ein Upgrade geplant ist, wird die Warteschlange zwei Stunden vor dem Upgrade in den Status „Upgrade angehalten“ versetzt, sofern dies nicht durch die Eigenschaft „com.glide.update_operation.queue_upgrade_window“ überschrieben wird. Dadurch können laufende Vorgänge abgeschlossen werden, bevor das Upgrade beginnt.

Hinweis:

Die Warteschlange wird automatisch fortgesetzt, wenn das Upgrade abgeschlossen ist.

Weitere Informationen zu CICDfinden Sie unter:

• Spoke für kontinuierliche Integration und kontinuierliche Bereitstellung (CICD)
• https://plugins.jenkins.io/servicenow-cicd/
• https://marketplace.visualstudio.com/items?itemName=ServiceNow.vss-services-servicenow-cicd
• https://github.com/marketplace?type=actions&query=servicenow
• https://hub.docker.com/r/servicenowdevx/sncicd-gitlab-docker

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 den Endpunkt /sn_cicd/app/batch/install aufgerufen haben, um die Ergebnisse der Batch-Installation zu erhalten. Verwenden Sie den im Parameter links.results.id der Rückgabeergebnisse des Endpunkts „ /sn_cicd/app/batch/install “ zurückgegebenen Wert als result_id für diesen Endpunkt. Sie können auch den Endpunkt /api/sn_cicd/progress/{progress_id} aufrufen, um Informationen zum Fortschritt der Installation zu erhalten, wenn sie noch nicht abgeschlossen wurde.

URL-Format

URL mit Versionsangabe: /api/sn_cicd/{api_version}/app/batch/results/{result_id}

Standard-URL: /api/sn_cicd/app/batch/results/{result_id}

Unterstützte Anforderungsparameter

Tabelle : 1. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
result_id	Sys_id der Batch-Installation, für die Ergebnisinformationen zurückgegeben werden sollen. Dieser Wert wird im Parameter links.results.id des Endpunkts „ /sn_cicd/app/batch/install“ zurückgegeben. Datentyp: Zeichenfolge

Tabelle : 2. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 3. Anforderungstextparameter (XML oder JSON)

Name	Beschreibung
Keine

Kopfzeilen

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.

Tabelle : 4. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json

Tabelle : 5. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

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

Tabelle : 6. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
401	Die Anmeldeinformationen des Anwenders sind falsch.
403	Unzulässig. Der Benutzer ist kein Administrator und 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.

Parameter des Antworttexts (JSON oder XML)

Name	Beschreibung
Fehler	Fehlermeldung. Datentyp: Zeichenfolge
batch_items	JSON-Array, bei 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 der Parameter batch_items.type auf „ Anwendung “ oder „ Plugin “ festgelegt ist und der Parameter requested_customization_version in der Batch-Installationsanforderung übergeben wird. Version des zu installierenden Anpassungspakets für die Store App oder das bereichsbezogene Plugin ServiceNow, 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 dem Parameter packages.id im initiierenden Endpunktaufruf /sn_cicd/app/batch/install. 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 Notizen zum Paket. Identisch mit dem Parameter packages.notes im initiierenden Endpunktaufruf /sn_cicd/app/batch/install. 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 von Anpassungen aufgetreten sind. Datentyp: Zeichenfolge
„batch_items.type“	Typ der Anwendung. Identisch mit dem Parameter packages.type im initiierenden Endpunktaufruf /sn_cicd/app/batch/install. Gültige Werte: Anwendung Plugin Datentyp: Zeichenfolge
„batch_items.url“	URL des zugehörigen Paketinstallationsdatensatzes in Ihrer Instanz ServiceNow. Datentyp: Zeichenfolge
„batch_items.version“	Version des zu installierenden Pakets, z. B. 1.0.2 oder 2.3. Identisch mit dem Parameter packages.requested_version im initiierenden Endpunktaufruf /sn_cicd/app/batch/install. 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. Derselbe Wert wie im Anforderungsparameter result_id übergeben. Datentyp: Zeichenfolge
„batch_plan.name“	Vom Anwender angegebener beschreibender Name für diese Batch-Anforderung. Identisch mit dem Parameter name im initiierenden Endpunktaufruf /sn_cicd/app/batch/install. Datentyp: Zeichenfolge
„batch_plan.notes“	Hinweise, die beim Aufrufen der Batch-Installation übergeben wurden. Identisch mit dem Parameter notes im initiierenden Endpunktaufruf /sn_cicd/app/batch/install. 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-Installationsplan-Datensatzes in Ihrer Instanz ServiceNow. 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 Scan-Funktion der CI-/CD-Instanz zurück, die einer übergebenen Bearbeitungs-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 der CICD-Instanz-Scanausführungsservice- API und wird unter dem Namespace sn_cicd verwendet.

URL-Format

URL mit Versionsangabe: /api/sn_cicd/{api_version}/instance_scan/result/{progress_id}

Standard-URL: /api/sn_cicd/instance_scan/result/{progress_id}

Unterstützte Anforderungsparameter

Tabelle : 7. Parameter

Parameter	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
progress_id	Eindeutiger Bezeichner der Funktion, für die Fortschrittsinformationen zurückgegeben werden sollen. Dieser Wert wird im Parameter links.progress.id des Endpunkts zurückgegeben, von dem die Aktion initiiert wurde, 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 Anmeldeinformationen des Anwenders sind falsch.
403	Unzulässig. Der Benutzer ist kein Administrator und 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. Datentyp: Zeichenfolge
Links	Alle Links und sys_ids, die der Antwort zugeordnet sind. Datentyp: Objekt "links": { "progress": {Object} }
Links.Ergebnisse	Objekt, das Informationen zu den Ergebnissen des Instanzscans enthält.
links.ergebnisse.bezeichnung	Zusätzliche Informationen zu den Instanzscanfunden.
links.ergebnisse.url	URL zum Abrufen einer Liste von Datensätzen, die gegen die Prüfungen verstoßen haben.
links.fortschritt	Beschreibt die Fortschrittslinkinformationen. Datentyp: Objekt "progress": { "id": "String", "url": "String" }
links.progress.id	Eindeutiger Bezeichner des Fortschrittsdetails.
links.fortschritt.url	URL zum Abrufen der Fortschrittsdetails. Datentyp: Zeichenfolge
links.ergebnisse	Ergebnisinformationen. Datentyp: Objekt "results": { "id": "String", "url": "String" }
links.results.id	Sys_id des Datensatzes mit Instanzscanergebnissen.
links.Ergebnisse.URL	URL zum Abrufen der Ergebnisse des Instanzscans.
status	Numerischer Ausführungsstatus. Verwendet mit status_label. 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. Werte: Abgebrochen Fehlgeschlagen Ausstehend Wird ausgeführt Erfolgreich Datentyp: Zeichenfolge
status_message	Zusätzliche Informationen dazu, warum der Vorgang fehlgeschlagen ist. Leer, 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 der Funktion Kontinuierliche Integration und kontinuierliche Bereitstellung (CICD) zurück, die einer angegebenen Fortschritts-ID zugeordnet ist.

Rufen Sie diese Methode auf, nachdem Sie einen der asynchronen CICD-Endpunkte wie /sn_cicd/app_repo/publish, /sn_cicd/app_repo/install, /sn_cicd/testsuite/runoder /sn_cicd/sc/apply_stash aufgerufen haben.

URL-Format

URL mit Versionsnummer: /api/sn_cicd/{api_version}/progress/{progress_id}

Standard-URL: /api/sn_cicd/progress/{progress_id}

Unterstützte Anforderungsparameter

Tabelle : 13. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
progress_id	Eindeutiger Bezeichner der Funktion, für die Fortschrittsinformationen zurückgegeben werden sollen. Dieser Wert wird im Parameter links.progress.id des Endpunkts zurückgegeben, der die Aktion initiiert hat, z. B. /sn_cicd/app_repo/publish, /sn_cicd/app_repo/install, /sn_cicd/testsuite/runoder /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 HTTP-Antwortcodesder REST-API.

Tabelle : 18. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
401	Die Anmeldeinformationen des Anwenders sind falsch.
403	Unzulässig. Der Benutzer ist kein Administrator und 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.

Parameter des Antworttexts (JSON oder XML)

Name	Beschreibung
Fehler	Fehlermeldung. Datentyp: Zeichenfolge
Links	Alle Links und sys_ids, die der Antwort zugeordnet sind. Datentyp: Objekt "links": { "progress": {Object} }
links.fortschritt	Beschreibt die Fortschrittslinkinformationen. Datentyp: Objekt "progress": { "id": "String", "url": "String" }
links.progress.id	Eindeutiger Bezeichner zum Abrufen der Fortschrittsdetails für den Vorgang. Verwenden Sie diesen Wert, wenn Sie den Endpunkt /sn_cicd/progress/{progress_id}aufrufen. Datentyp: Zeichenfolge
links.fortschritt.url	URL zum Abrufen der Fortschrittsdetails. Datentyp: Zeichenfolge
links.ergebnisse	Ergebnisinformationen. Datentyp: Objekt "results": { "id": "String", "url": "String" }
links.results.id	Eindeutiger Bezeichner der Ergebnisinformationen. Verwenden Sie diesen Wert, wenn Sie den zugeordneten Ergebnissedpunkt aufrufen. Datentyp: Zeichenfolge
links.Ergebnisse.URL	URL zum Abrufen der Ergebnisse der Endpunktausführung, z. B. Ergebnisse. Datentyp: Zeichenfolge
links.quelle	Quellinformationen. Datentyp: Objekt "source": { "id": "String", "url": "String" }
links.source.id	Eindeutiger Bezeichner des Quelldatensatzes in der Tabelle „Ausführungstracker“ [sys_execution_tracker]. Datentyp: Zeichenfolge
links.quelle.url	URL zum Abrufen der Quellinformationen in der Tabelle „Ausführungstracker“ [sys_execution_tracker]. Datentyp: Zeichenfolge
links.stash	Wenn während eines Vorgangs „ apply_changes “ erstellt wurde, enthält dieses Objekt 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 Stashes. Verwenden Sie diesen Wert, wenn Sie den Endpunkt CI/CD – POST /sn_cicd/sc/apply_stash/{stash_id} aufrufen, um den Stash anzuwenden. Datentyp: Zeichenfolge
links.stash.url	URL des zugeordneten Stashes. Datentyp: Zeichenfolge
percent_complete	Prozentsatz der Anforderung, die abgeschlossen ist. Datentyp: Zahl
status	Numerischer Ausführungsstatus. Verwendet mit status_label. 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. Werte: Abgebrochen Fehlgeschlagen Ausstehend Wird ausgeführt Erfolgreich Datentyp: Zeichenfolge
status_message	Beschreibung des aktuellen Status. Datentyp: Zeichenfolge

Rufen Sie 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 zum Anwenden von Changes.

{
    "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 lagen in Studio nicht gespeicherte/nicht committete Änderungen in der Instanz vor, sodass ein Stash erstellt wurde, 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 beim Bereitstellen 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 von /sn_cicd/progress/{progress_id} auf, um das Ergebnis der ausgeführten Test-Suite zu erhalten.

URL-Format

URL mit Versionsnummer: /api/sn_cicd/{api_version}/testsuite/results/{result_id}

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

Unterstützte Anforderungsparameter

Tabelle : 19. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
result_id	Eindeutiger Bezeichner der abzurufenden Test-Suite-Ergebnisse. Der entsprechende Endpunktaufruf /sn_cicd/progress/{progress_id} 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 HTTP-Antwortcodesder REST-API.

Tabelle : 24. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
401	Die Anmeldeinformationen des Anwenders sind falsch.
403	Unzulässig. Der Benutzer ist kein Administrator und 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.

Parameter des Antworttexts (JSON oder XML)

Name	Beschreibung
child_suite_results	Ergebnisse der geschachtelten Test-Suites. Das Format dieses Inhalts entspricht dem des übergeordneten Tests.
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 /sn_cicd/testsuite/results/{result_id} aufrufen. Datentyp: Zeichenfolge
links.Ergebnisse.URL	URL zum Abrufen der Ergebnisse der Endpunktausführung, z. B. Ergebnisse. Datentyp: Zeichenfolge
percent_complete	Prozentsatz der Anforderung, die abgeschlossen ist.
rolledup_test_error_count	Anzahl der Tests mit Fehlern. Datentyp: Zahl
rolledup_test_failure_count	Anzahl der Tests, die fehlgeschlagen sind. Datentyp: Zahl
rolledup_test_skip_count	Anzahl der übersprungenen Tests. Datentyp: Zahl
rolledup_test_success_count	Anzahl der erfolgreich durchgeführten Tests. Datentyp: Zahl
status	Numerischer Ausführungsstatus. Wird mit status_labelverwendet, 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. Wird mit statusverwendet, 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: POST /sn_cicd/app/batch/install

Installiert zwei oder mehr Pakete in einem angegebenen Batch.

Ein Batch kann eine beliebige Kombination der folgenden Typen enthalten:

• Anwendung:
  • Bereichsbezogene Anwendungen im ServiceNow Store, die nicht im Besitz Ihres Unternehmens sind
  • Bereichsbezogene oder globale Anwendungen im Anwendungs-Repository, deren Besitzer Ihr Unternehmen ist
  • Ihre Anwendungsanpassungen für Store Apps im App-Repository
• ServiceNow Plugin:

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

Hinweis:

Dieser Endpunkt verwendet ein asynchrones Antwortmodell. Wenn Sie einen Endpunkt aufrufen, löst er die zugehörige Funktion aus, 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 (in der Regel Ausstehend) sowie einen eindeutigen Bezeichner und einen Link enthält. Verwenden Sie diese Informationen, um zusätzliche Informationen über den Fortschritt oder die Ergebnisse der Anforderung zu erhalten.

URL-Format

URL mit Versionsnummer: /api/sn_cicd/{api_version}/app/batch/install

Standard-URL: /api/sn_cicd/app/batch/install

Unterstützte Anforderungsparameter

Tabelle : 25. Pfadparameter

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

Tabelle : 26. Abfrageparameter

Name	Beschreibung
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, wobei 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" }]
Pakete.ID	Erforderlich. Sys_id der Anwendung oder Bezeichner des zu installierenden Plugins. Datentyp: Zeichenfolge
pakete.last_demo_daten	Kennzeichnung, die angibt, ob bei der Installation des Pakets Demodaten geladen werden. Gültige Werte: „wahr“: Demodaten müssen geladen werden. „falsch“: Demodaten dürfen nicht geladen werden. Datentyp: Boolesch Standardwert: false
Pakete.Hinweise	Vom Anwender angegebene Notizen zum Paket. Datentyp: Zeichenfolge Standard: Null
Pakete.Angefordert_Anpassung_Version	Version der Anwendungsanpassung an die Store App oder an das zu installierende bereichsbezogene Plugin ServiceNow, 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.Angeforderte_Version	Erforderlich, wenn packages.type auf Anwendungfestgelegt ist; Wird ignoriert, wenn auf Pluginfestgelegt. 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 HTTP-Antwortcodesder REST-API.

Tabelle : 30. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
401	Die Anmeldeinformationen des Anwenders sind falsch.
403	Unzulässig. Der Benutzer ist kein Administrator und verfügt nicht über die Rolle sn_cicd.sys_ci_automation.
405	Ungültige Methode. Die Funktion ist deaktiviert.

Parameter des Antworttexts (JSON oder XML)

Name	Beschreibung
Fehler	Fehlermeldung. Datentyp: Zeichenfolge
Links	Alle Links und sys_ids, die der Antwort zugeordnet sind. Datentyp: Objekt "links": { "progress": {Object}, "results": {Object}, "rollback": {Object} }
links.fortschritt	Beschreibt die Fortschrittslinkinformationen. Datentyp: Objekt "progress": { "id": "String", "url": "String" }
links.progress.id	Eindeutiger Bezeichner zum Abrufen der Fortschrittsdetails für den Vorgang. Verwenden Sie diesen Wert, wenn Sie den Endpunkt /sn_cicd/progress/{progress_id}aufrufen. Datentyp: Zeichenfolge
links.fortschritt.url	URL zum Abrufen der Fortschrittsdetails. Datentyp: Zeichenfolge
links.ergebnisse	Beschreibt die Informationen des Ergebnislinks. 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 links.results.url angegebenen Endpunkt aufrufen, um die Ergebnisse der Batch-Installation abzufragen. Datentyp: Zeichenfolge
links.Ergebnisse.URL	URL zum Abrufen der Ergebnisse der Batch-Installation. 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 des Endpunkts „/sn_cicd/app/batch/rollback/{rollback_id}“ auf ihre vorherigen Versionen zurückzusetzen. Hinweis: Die Rollback-Funktion ist nur nach Abschluss der Installation verfügbar. Datentyp: Zeichenfolge
percent_complete	Prozentsatz der Anforderung, die abgeschlossen ist. Datentyp: Zahl
status	Numerischer Ausführungsstatus. Verwendet mit status_label. 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. Werte: Abgebrochen Fehlgeschlagen Ausstehend Wird ausgeführt Erfolgreich Datentyp: Zeichenfolge
status_message	Beschreibung des aktuellen Status. Datentyp: Zeichenfolge

cURL-Anforderung

Dieses Beispiel initiiert eine Batch-Installation namens Release 2.2 Deployment, 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 – POST /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 arbeitet mit dem Endpunkt /sn_cicd/app/batch/install zusammen. rollback_id wird in den zurückgegebenen Ergebnissen dieses Endpunkts bereitgestellt. Wenn dieser Endpunkt aufgerufen wird, werden alle in der zugehörigen Installation angegebenen Pakete zurückgesetzt. können Sie kein Rollback für einzelne Pakete durchführen. Wenn keine frühere Version vorhanden ist, deinstalliert der Endpunkt das zugehörige Paket.

Hinweis:

Dieser Endpunkt verwendet ein asynchrones Antwortmodell. Wenn Sie einen Endpunkt aufrufen, löst er die zugehörige Funktion aus, 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 (in der Regel Ausstehend) sowie einen eindeutigen Bezeichner und einen Link enthält. Verwenden Sie diese Informationen, um zusätzliche Informationen über den Fortschritt oder die Ergebnisse der Anforderung zu erhalten.

URL-Format

URL mit Versionsangabe: /api/sn_cicd/{api_version}/app/batch/rollback/{rollback_id}

Standard-URL: /api/sn_cicd/app/batch/rollback/{rollback_id}

Unterstützte Anforderungsparameter

Tabelle : 31. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
rollback_id	Sys_id des Batch-Installationsplans, für den die installierten Pakete auf ihre vorherigen Versionen zurückgesetzt werden sollen. Dieser Wert wird im Parameter links.rollback.id des Endpunkts „ /sn_cicd/app/batch/install“ zurückgegeben. 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 HTTP-Antwortcodesder REST-API.

Tabelle : 36. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
401	Die Anmeldeinformationen des Anwenders sind falsch.
403	Unzulässig. Der Benutzer ist kein Administrator und 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.

Parameter des Antworttexts (JSON oder XML)

Name	Beschreibung
Fehler	Fehlermeldung. Datentyp: Zeichenfolge
Links	Alle Links und sys_ids, die der Antwort zugeordnet sind. Datentyp: Objekt "links": { "progress": {Object} }
links.fortschritt	Beschreibt die Fortschrittslinkinformationen. Datentyp: Objekt "progress": { "id": "String", "url": "String" }
links.progress.id	Eindeutiger Bezeichner zum Abrufen der Fortschrittsdetails für den Vorgang. Verwenden Sie diesen Wert, wenn Sie den Endpunkt /sn_cicd/progress/{progress_id}aufrufen. Datentyp: Zeichenfolge
links.fortschritt.url	URL zum Abrufen der Fortschrittsdetails. Datentyp: Zeichenfolge
percent_complete	Prozentsatz der Anforderung, die abgeschlossen ist. Datentyp: Zahl
status	Numerischer Ausführungsstatus. Verwendet mit status_label. 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. Werte: Abgebrochen Fehlgeschlagen Ausstehend Wird ausgeführt Erfolgreich Datentyp: Zeichenfolge
status_message	Beschreibung des aktuellen Status. Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel werden alle Pakete im angegebenen Installations-Batch-Plan auf die 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: POST /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 sowohl unveränderte und angepasste ServiceNow Basissystem- und ServiceNow Store -Anwendungen, angepasste ServiceNow -Plugins und Ihre eigenen ServiceNow -Anwendungen installieren.

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

• Nur die Basisanwendung und nicht die entsprechenden Anwendungsanpassungen installieren
  • sys_id: Sys_id der Basisanwendung, die angepasst wurde.
  • base_app_version: Version der zu installierenden Basisanwendung.
• Zur Installation einer angegebenen Version von Anwendungsanpassungen und zur automatischen Installation der empfohlenen Basisanwendungsversion. Die empfohlene Basisanwendungsversion ist die Version der Basisanwendung, die zum Zeitpunkt der letzten Veröffentlichung der Anpassungen auf der Instanz installiert war. Jede Version von Anwendungsanpassungen hat eine entsprechende empfohlene Basisanwendungsversion.
  • sys_id: Sys_id der Anwendung, die angepasst wurde.
  • auto_upgrade_base_app: wahr
  • version: Version der zu installierenden Anwendungsanpassungen.
• Zur Installation der neuesten Version der Anwendungsanpassungen und der entsprechenden empfohlenen Basisanwendungsversion.
  • sys_id: Sys_id der Anwendung, die angepasst wurde.
  • auto_upgrade_base_app: wahr
• Dient zum Installieren der aktuellen Version der Anwendungsanpassungen, aber nicht zum Aktualisieren der Basisanwendung auf die empfohlene Basisanwendungsversion der Anwendungsanpassungen.
  • sys_id: Sys_id der Anwendung, die angepasst wurde.
  • auto_upgrade_base_app: falsch
• Dient zur Installation von Anwendungsanpassungen zusammen mit dem bereichsbezogenen Plugin ServiceNow des aktuellen Release.
  • scope: Umfang des Plugins, das 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.
• Um Anwendungsanpassungen für ein bereits installiertes und aktiviertes bereichsbezogenes Plugin zu installieren.
  • 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, gelten die Parameter auto_upgrade_base_app und base_app_version nicht für Anwendungsanpassungsinstallationen für Plugins. Um ein Plugin zum ersten Mal in einer Instanz zu aktivieren, verwenden Sie stattdessen den Endpunkt /sn_cicd/plugin/{plugin_id}/activate.

Hinweis:

Dieser Endpunkt verwendet ein asynchrones Antwortmodell. Wenn Sie einen Endpunkt aufrufen, löst er die zugehörige Funktion aus, 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 (in der Regel Ausstehend) sowie einen eindeutigen Bezeichner und einen Link enthält. Verwenden Sie diese Informationen, um zusätzliche Informationen über den Fortschritt oder die Ergebnisse der Anforderung zu erhalten.

URL-Format

URL mit Versionsnummer: /api/sn_cicd/{api_version}/app_repo/install

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

Unterstützte Anforderungsparameter

Tabelle : 37. Pfadparameter

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

Tabelle : 38. Abfrageparameter

Name	Beschreibung
auto_upgrade_base_app	Gilt nur, wenn Sie Anwendungsanpassungen installieren möchten und die Basisanwendung auf einer späteren Version als der aktuell installierten Version erstellt wurde. Kennzeichnung, die angibt, ob für die zugeordnete Basisanwendung automatisch ein Upgrade auf eine spätere Version durchgeführt werden soll. Gültige Werte: „wahr“: Automatisches Upgrade der zugehörigen Basisanwendung. „falsch“: Behält die Basisanwendung in der aktuell auf der Instanz installierten Version bei. Datentyp: Boolesch Standardwert: false
base_app_version	Version der zu installierenden Basisanwendung. Eine Basisanwendung ist eine beliebige Drittanbieteranwendung, die inServiceNow Storeverfügbar ist. Wenn die Anwendung über keine Anwendungsanpassungen verfügt oder wenn die Anwendung über Anwendungsanpassungen verfügt und Sie nur die Basisanwendung aktualisieren, geben Sie in diesem Parameter die aktualisierte Version der Anwendung ein. Wenn Sie Anwendungsanpassungen aktualisieren, übergeben Sie nicht diesen Parameter, sondern den Parameter version. Datentyp: Zeichenfolge Standard: Null
scope	Erforderlich, wenn sys_id nicht angegeben ist. Bereichsname der Anwendung, z. B. x_aah_custom_app. Sie finden diesen Wert im Feld scope in der Tabelle „Anwenderdefinierte Anwendung“ [sys_app] oder „Store-Anwendung“ [sys_store_app]. Datentyp: Zeichenfolge
sys_id	Erforderlich, wenn scope nicht angegeben ist. Sys_id der zu installierenden Anwendung. Sie finden diesen Wert im Feld Sys ID in der Tabelle „Anwenderdefinierte Anwendung“ [sys_app] oder „Store-Anwendung“ [sys_store_app]. Datentyp: Zeichenfolge
Version	Version der zu installierenden Anwendung. Datentyp: Zeichenfolge Standard: Wenn der Parameter base_app_version leer ist und der Parameter auto_upgrade_base_app auf „true“ festgelegt ist, werden die neuesten Anwendungsanpassungen und die empfohlene Basisanwendungsversion installiert (sofern die Basisanwendung nicht heruntergestuft wird). Wenn der Parameter auto_upgrade_base_app auf „false“ festgelegt ist, werden die Anwendungsanpassungen installiert, die Basisanwendung wird jedoch nicht aktualisiert. Wenn der Parameter base_app_version definiert ist, 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 HTTP-Antwortcodesder REST-API.

Tabelle : 42. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
401	Die Anmeldeinformationen des Anwenders sind falsch.
403	Unzulässig. Der Benutzer ist kein Administrator und 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.

Parameter des Antworttexts (JSON oder XML)

Name	Beschreibung
Fehler	Fehlermeldung. Datentyp: Zeichenfolge
Links	Alle Links und sys_ids, die der Antwort zugeordnet sind. Datentyp: Objekt "links": { "progress": {Object} }
links.fortschritt	Beschreibt die Fortschrittslinkinformationen. Datentyp: Objekt "progress": { "id": "String", "url": "String" }
links.progress.id	Eindeutiger Bezeichner zum Abrufen der Fortschrittsdetails für den Vorgang. Verwenden Sie diesen Wert, wenn Sie den Endpunkt /sn_cicd/progress/{progress_id}aufrufen. Datentyp: Zeichenfolge
links.fortschritt.url	URL zum Abrufen der Fortschrittsdetails. Datentyp: Zeichenfolge
percent_complete	Prozentsatz der Anforderung, die abgeschlossen ist. Datentyp: Zahl
rollback_version	Falls verfügbar, die zuvor installierte Version. Falls nicht verfügbar, null. Datentyp: Zeichenfolge
status	Numerischer Ausführungsstatus. Verwendet mit status_label. 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. Werte: Abgebrochen Fehlgeschlagen Ausstehend Wird ausgeführt Erfolgreich Datentyp: Zeichenfolge
status_message	Beschreibung des aktuellen Status. 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: POST /sn_cicd/app_repo/publish

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

Hinweis:

Wenn beim Aufrufen dieses Endpunkts nicht committete Änderungen an nachverfolgten Dateien vorhanden sind, wird der Statuscode „400 Ungültige Anforderung“ zurückgegeben. Sie können die Changes entweder manuell in Studio committen oder den CI/CD – POST /sn_cicd/sc/apply_changes -Endpunkt aufrufen, um die Changes zu speichern. Changes, die in der Tabelle „Kundenupdates“ [sys_update_xml] nicht nachverfolgt werden, werden nach der Veröffentlichung im App-Repository automatisch committet. Informationen zum Layout der Changes in der Tabelle „Kunden-Updates“ und eine Beschreibung der Changes, die in dieser Tabelle nicht dargestellt werden, finden Sie unter Customer Updates table.

URL-Format

URL mit Versionsnummer: /api/sn_cicd/{api_version}/app_repo/publish

Standard-URL: /api/sn_cicd/app_repo/publish

Unterstützte Anforderungsparameter

Tabelle : 43. Pfadparameter

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

Tabelle : 44. Abfrageparameter

Name	Beschreibung
dev_notes	Entwicklerhinweise, die mit der Anwendung gespeichert werden sollen. Datentyp: Zeichenfolge
scope	Erforderlich, wenn sys_id nicht angegeben ist. Umfang der Anwendung. Sie finden diesen Wert im Feld scope in der Tabelle „Anwenderdefinierte Anwendung“ [sys_app]. Datentyp: Zeichenfolge
sys_id	Erforderlich, wenn scope nicht angegeben ist. Die sys_id der Anwendung, die im Repository gespeichert werden soll. Sie finden diesen Wert im Feld Sys ID in der Tabelle „Anwenderdefinierte Anwendung“ [sys_app]. Datentyp: Zeichenfolge
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 abweicht. 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 HTTP-Antwortcodesder REST-API.

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 committete Änderungen, die gelöst werden müssen. Weitere Informationen finden Sie in der zurückgegebenen Fehlermeldung.
401	Die Anmeldeinformationen des Anwenders sind falsch.
403	Unzulässig. Der Benutzer ist kein Administrator und 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.

Parameter des Antworttexts (JSON oder XML)

Name	Beschreibung
Fehler	Fehlermeldung. Datentyp: Zeichenfolge
Links	Alle Links und sys_ids, die der Antwort zugeordnet sind. Datentyp: Objekt "links": { "progress": {Object} }
links.fortschritt	Beschreibt die Fortschrittslinkinformationen. Datentyp: Objekt "progress": { "id": "String", "url": "String" }
links.progress.id	Eindeutiger Bezeichner zum Abrufen der Fortschrittsdetails für den Vorgang. Verwenden Sie diesen Wert, wenn Sie den Endpunkt /sn_cicd/progress/{progress_id}aufrufen. Datentyp: Zeichenfolge
links.fortschritt.url	URL zum Abrufen der Fortschrittsdetails. Datentyp: Zeichenfolge
percent_complete	Prozentsatz der Anforderung, die abgeschlossen ist. Datentyp: Zahl
status	Zusätzliche Informationen zum aktuellen Status. Datentyp: Zeichenfolge
status_detail	Zusätzliche Informationen zum aktuellen Status. Datentyp: Zeichenfolge
status_label	Beschreibung des Ausführungsstatus. Verwendet mit status. Werte: Abgebrochen Fehlgeschlagen Ausstehend Wird ausgeführt Erfolgreich Datentyp: Zeichenfolge
status_message	Beschreibung des aktuellen Status. Datentyp: Zeichenfolge

Das folgende Beispiel zeigt, wie Sie die Anwendung mit der angegebenen sys_id und alle ihre Artefakte im App-Repository veröffentlichen.

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: POST /sn_cicd/app_repo/rollback

Initiiert ein Rollback einer angegebenen Anwendung auf eine angegebene Version.

Hinweis:

Die Rollback-Funktion ist erst nach Abschluss der Installation verfügbar.

URL-Format

URL mit Versionsnummer: /api/sn_cicd/{api_version}/app_repo/rollback

Standard-URL: /api/sn_cicd/app_repo/rollback

Unterstützte Anforderungsparameter

Tabelle : 49. Pfadparameter

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

Tabelle : 50. Abfrageparameter

Name	Beschreibung
scope	Erforderlich, wenn sys_id nicht angegeben ist. Der Bereichsname der Anwendung, für die ein Rollback ausgeführt werden soll. Datentyp: Zeichenfolge
sys_id	Erforderlich, wenn scope nicht angegeben ist. Die sys_id der Anwendung für das Rollback. Datentyp: Zeichenfolge
Version	Erforderlich. Version der Anwendung, die nach dem Rollbackvorgang erwartet wird. Wenn die Anforderung darin besteht, ein Rollback für eine App-Anpassungsinstallation durchzuführen, legen Sie dieses Feld auf die Version der Basisanwendung fest, die das System nach dem Rollback-Vorgang voraussichtlich hat. 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 HTTP-Antwortcodesder REST-API.

Tabelle : 54. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
401	Die Anmeldeinformationen des Anwenders sind falsch.
403	Unzulässig. Der Benutzer ist kein Administrator und 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.

Parameter des Antworttexts (JSON oder XML)

Name	Beschreibung
Fehler	Fehlermeldung. Datentyp: Zeichenfolge
Links	Alle Links und sys_ids, die der Antwort zugeordnet sind. Datentyp: Objekt "links": { "progress": {Object} }
links.fortschritt	Beschreibt die Fortschrittslinkinformationen. Datentyp: Objekt "progress": { "id": "String", "url": "String" }
links.progress.id	Eindeutiger Bezeichner zum Abrufen der Fortschrittsdetails für den Vorgang. Verwenden Sie diesen Wert, wenn Sie den Endpunkt /sn_cicd/progress/{progress_id}aufrufen. Datentyp: Zeichenfolge
links.fortschritt.url	URL zum Abrufen der Fortschrittsdetails. Datentyp: Zeichenfolge
percent_complete	Prozentsatz der Anforderung, die abgeschlossen ist. Datentyp: Zahl
status	Numerischer Ausführungsstatus. Verwendet mit status_label. 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. Werte: Abgebrochen Fehlgeschlagen Ausstehend Wird ausgeführt Erfolgreich Datentyp: Zeichenfolge
status_message	Beschreibung des aktuellen Status. 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 in Ihrer Instanz aus.

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

Hinweis:

Dieser Endpunkt ist Teil der CICD-Instanz-Scanausführungsservice- API und wird unter dem Namespace sn_cicd verwendet.

URL-Format

URL mit Versionsnummer: /api/sn_cicd/{api_version}/instance_scan/full_scan

Standard-URL: /api/sn_cicd/instance_scan/full_scan

Unterstützte Anforderungsparameter

Tabelle : 55. Parameter

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

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 Anmeldeinformationen des Anwenders sind falsch.
403	Unzulässig. Der Benutzer ist kein Administrator und 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. Datentyp: Zeichenfolge
Links	Alle Links und sys_ids, die der Antwort zugeordnet sind. Datentyp: Objekt "links": { "progress": {Object} }
links.fortschritt	Beschreibt die Fortschrittslinkinformationen. Datentyp: Objekt "progress": { "id": "String", "url": "String" }
links.progress.id	Eindeutiger Bezeichner des Fortschrittsdetails. Verwenden Sie diesen Wert, wenn Sie den Endpunkt /sn_cicd/instance_scan/result/{progress_id}aufrufen.
links.fortschritt.url	URL zum Abrufen der Fortschrittsdetails. Datentyp: Zeichenfolge
status	Numerischer Ausführungsstatus. Verwendet mit status_label. 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. Werte: Abgebrochen Fehlgeschlagen Ausstehend Wird ausgeführt Erfolgreich Datentyp: Zeichenfolge
status_message	Zusätzliche Informationen dazu, warum der Vorgang fehlgeschlagen ist. Leer, 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 zutreffenden 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 Instance Scan bereitgestellt werden, oder Sie können eigene Prüfungen erstellen. Weitere Informationen finden Sie unter Instanzscan.

Hinweis:

Dieser Endpunkt ist Teil der CICD-Instanz-Scanausführungsservice- API und wird unter dem Namespace sn_cicd verwendet.

URL-Format

URL mit Versionsnummer: /api/sn_cicd/{api_version}/instance_scan/point_scan

Standard-URL: /api/sn_cicd/instance_scan/point_scan

Unterstützte Anforderungsparameter

Tabelle : 61. Parameter

Parameter	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
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 zu scannenden Datensatzes in der angegebenen Tabelle. 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 Anmeldeinformationen des Anwenders sind falsch.
403	Unzulässig. Der Benutzer ist kein Administrator und 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. Datentyp: Zeichenfolge
Links	Alle Links und sys_ids, die der Antwort zugeordnet sind. Datentyp: Objekt "links": { "progress": {Object} }
links.fortschritt	Beschreibt die Fortschrittslinkinformationen. Datentyp: Objekt "progress": { "id": "String", "url": "String" }
links.progress.id	Eindeutiger Bezeichner des Fortschrittsdetails. Verwenden Sie diesen Wert, wenn Sie den Endpunkt /sn_cicd/instance_scan/result/{progress_id}aufrufen.
links.fortschritt.url	URL zum Abrufen der Fortschrittsdetails. Datentyp: Zeichenfolge
status	Numerischer Ausführungsstatus. Verwendet mit status_label. 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. Werte: Abgebrochen Fehlgeschlagen Ausstehend Wird ausgeführt Erfolgreich Datentyp: Zeichenfolge
status_message	Zusätzliche Informationen dazu, warum der Vorgang fehlgeschlagen ist. Leer, 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 die Endpunkte /sn_cicd/instance_scan/suite_scan/{suite_sys_id}/scoped_apps oder /sn_cicd/instance_scan/suite_scan/{suite_sys_id}/update_sets aufrufen oder einen Suite-Scan in der Anwenderoberfläche ausführen.

Hinweis:

Dieser Endpunkt ist Teil der CICD-Instanz-Scanausführungsservice- API und wird unter dem Namespace sn_cicd verwendet.

URL-Format

URL mit Versionsangabe: /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}

Unterstützte Anforderungsparameter

Tabelle : 67. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
„combo_sys_id“	Die sys_id des auszuführenden Scans. Bei der Prüfung muss es sich um eine vorhandene Prüfung handeln, die Sie erneut ausführen möchten. Befindet sich in der Tabelle „Combo“ [scan_combo]. Datentyp: Zeichenfolge

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

Tabelle : 72. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
401	Die Anmeldeinformationen des Anwenders sind falsch.
403	Unzulässig. Der Benutzer ist kein Administrator und verfügt nicht über die Rolle sn_cicd.sys_ci_automation.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

Parameter des Antworttexts (JSON oder XML)

Element	Beschreibung
Fehler	Fehlermeldung. Datentyp: Zeichenfolge
Links	Alle Links und sys_ids, die der Antwort zugeordnet sind. Datentyp: Objekt "links": { "progress": {Object} }
links.fortschritt	Beschreibt die Fortschrittslinkinformationen. Datentyp: Objekt "progress": { "id": "String", "url": "String" }
links.progress.id	Eindeutiger Bezeichner des Fortschrittsdetails. Verwenden Sie diesen Wert, wenn Sie den Endpunkt /sn_cicd/instance_scan/result/{progress_id}aufrufen.
links.fortschritt.url	URL zum Abrufen der Fortschrittsdetails. Datentyp: Zeichenfolge
status	Numerischer Ausführungsstatus. Verwendet mit status_label. 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. Werte: Abgebrochen Fehlgeschlagen Ausstehend Wird ausgeführt Erfolgreich Datentyp: Zeichenfolge
status_message	Zusätzliche Informationen dazu, warum der Vorgang fehlgeschlagen ist. Leer, 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 in einer Suite anhand einer Liste von bereichsbezogenen Apps aus.

Hinweis:

Dieser Endpunkt ist Teil der CICD-Instanz-Scanausführungsservice- API und wird unter dem Namespace sn_cicd verwendet.

URL-Format

URL mit Versionsnummer: /api/sn_cicd/{api_version}/instance_scan/suite_scan/{suite_sys_id}/scoped_apps

Standard-URL: /api/sn_cicd/instance_scan/suite_scan/{suite_sys_id}/scoped_apps

Unterstützte Anforderungsparameter

Tabelle : 73. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
Suite_Sys_ID	Die sys_id der auszuführenden Suite. Befindet sich in der Tabelle „Suite“ [scan_check_suite]. Datentyp: Zeichenfolge

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 zu scannenden bereichsbezogenen Anwendungen. Befindet sich in der Anwendungstabelle [sys_scope]. Das Array darf kein leeres Array sein. Datentyp: Array app_scope_sys_ids: ["String", "String", "String"]

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

Tabelle : 78. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
401	Die Anmeldeinformationen des Anwenders sind falsch.
403	Unzulässig. Der Benutzer ist kein Administrator und verfügt nicht über die Rolle sn_cicd.sys_ci_automation.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

Parameter des Antworttexts (JSON oder XML)

Element	Beschreibung
Fehler	Fehlermeldung. Datentyp: Zeichenfolge
Links	Alle Links und sys_ids, die der Antwort zugeordnet sind. Datentyp: Objekt "links": { "progress": {Object} }
links.fortschritt	Beschreibt die Fortschrittslinkinformationen. Datentyp: Objekt "progress": { "id": "String", "url": "String" }
links.progress.id	Eindeutiger Bezeichner des Fortschrittsdetails. Verwenden Sie diesen Wert, wenn Sie den Endpunkt /sn_cicd/instance_scan/result/{progress_id}aufrufen.
links.fortschritt.url	URL zum Abrufen der Fortschrittsdetails. Datentyp: Zeichenfolge
status	Numerischer Ausführungsstatus. Verwendet mit status_label. 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. Werte: Abgebrochen Fehlgeschlagen Ausstehend Wird ausgeführt Erfolgreich Datentyp: Zeichenfolge
status_message	Zusätzliche Informationen dazu, warum der Vorgang fehlgeschlagen ist. Leer, wenn der Vorgang erfolgreich ist. Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel werden alle aktiven Prüfungen in 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 in einer Suite anhand einer Liste von Update-Sätzen aus.

Hinweis:

Dieser Endpunkt ist Teil der CICD-Instanz-Scanausführungsservice- API und wird unter dem Namespace sn_cicd verwendet.

URL-Format

URL mit Versionsnummer: /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

Unterstützte Anforderungsparameter

Tabelle : 79. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
Suite_Sys_ID	Die sys_id der auszuführenden Suite. Befindet sich in der Tabelle „Suite“ [scan_check_suite]. Datentyp: Zeichenfolge

Tabelle : 80. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 81. Anforderungstextparameter (XML oder JSON)

Name	Beschreibung
update_set_sys_ids	Erforderlich. Eine Liste der sys_ids der zu scannenden Update Sets. Befindet sich in der Update-Satz-Tabelle [sys_update_set]. Das Array darf kein leeres Array sein. Datentyp: Array update_set_sys_ids: ["String", "String", "String"]

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

Tabelle : 84. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
401	Die Anmeldeinformationen des Anwenders sind falsch.
403	Unzulässig. Der Benutzer ist kein Administrator und verfügt nicht über die Rolle sn_cicd.sys_ci_automation.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

Parameter des Antworttexts (JSON oder XML)

Element	Beschreibung
Fehler	Fehlermeldung. Datentyp: Zeichenfolge
Links	Alle Links und sys_ids, die der Antwort zugeordnet sind. Datentyp: Objekt "links": { "progress": {Object} }
links.fortschritt	Beschreibt die Fortschrittslinkinformationen. Datentyp: Objekt "progress": { "id": "String", "url": "String" }
links.progress.id	Eindeutiger Bezeichner des Fortschrittsdetails. Verwenden Sie diesen Wert, wenn Sie den Endpunkt /sn_cicd/instance_scan/result/{progress_id}aufrufen.
links.fortschritt.url	URL zum Abrufen der Fortschrittsdetails. Datentyp: Zeichenfolge
status	Numerischer Ausführungsstatus. Verwendet mit status_label. 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. Werte: Abgebrochen Fehlgeschlagen Ausstehend Wird ausgeführt Erfolgreich Datentyp: Zeichenfolge
status_message	Zusätzliche Informationen dazu, warum der Vorgang fehlgeschlagen ist. Leer, wenn der Vorgang erfolgreich ist. Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel werden alle aktiven Prüfungen in einer Suite für ein Update Set 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

URL mit Versionsnummer: /api/sn_cicd/{api_version}/plugin/{plugin_id}/activate

Standard-URL: /api/sn_cicd/plugin/{plugin_id}/activate

Unterstützte Anforderungsparameter

Tabelle : 85. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
plugin_id	Eindeutiger Bezeichner des Plugins. Sie finden diesen Bezeichner auf der Seite „Plugins“ auf der Karte des gewünschten Plugins. mit dem Namen „ID“ identifiziert. 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 HTTP-Antwortcodesder REST-API.

Tabelle : 90. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
401	Die Anmeldeinformationen des Anwenders sind falsch.
403	Unzulässig. Der Benutzer ist kein Administrator und 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.

Parameter des Antworttexts (JSON oder XML)

Name	Beschreibung
Fehler	Fehlermeldung. Datentyp: Zeichenfolge
Links	Alle Links und sys_ids, die der Antwort zugeordnet sind. Datentyp: Objekt "links": { "progress": {Object} }
links.fortschritt	Beschreibt die Fortschrittslinkinformationen. Datentyp: Objekt "progress": { "id": "String", "url": "String" }
links.progress.id	Eindeutiger Bezeichner zum Abrufen der Fortschrittsdetails für den Vorgang. Verwenden Sie diesen Wert, wenn Sie den Endpunkt /sn_cicd/progress/{progress_id}aufrufen. Datentyp: Zeichenfolge
links.fortschritt.url	URL zum Abrufen der Fortschrittsdetails. Datentyp: Zeichenfolge
links.ergebnisse	Ergebnisinformationen. Datentyp: Objekt "results": { "id": "String", "url": "String" }
links.results.id	Eindeutiger Bezeichner der Ergebnisinformationen. Verwenden Sie diesen Wert, wenn Sie den zugeordneten Ergebnissedpunkt aufrufen. Datentyp: Zeichenfolge
links.Ergebnisse.URL	URL zum Abrufen der Ergebnisse der Endpunktausführung, z. B. Ergebnisse. Datentyp: Zeichenfolge
percent_complete	Prozentsatz der Anforderung, die abgeschlossen ist. Datentyp: Zahl
status	Numerischer Ausführungsstatus. Verwendet mit status_label. 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. Werte: Abgebrochen Fehlgeschlagen Ausstehend Wird ausgeführt Erfolgreich Datentyp: Zeichenfolge
status_message	Beschreibung des aktuellen Status. 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

URL mit Versionsnummer: /api/sn_cicd/{api_version}plugin/{plugin_id}/rollback

Standard-URL: /api/sn_cicd/plugin/{plugin_id}/rollback

Unterstützte Anforderungsparameter

Tabelle : 91. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
plugin_id	Eindeutiger Bezeichner des Plugins. Sie finden diesen Bezeichner auf der Seite „Plugins“ auf der Karte des gewünschten Plugins. mit dem Namen „ID“ identifiziert. 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 HTTP-Antwortcodesder REST-API.

Tabelle : 96. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
401	Die Anmeldeinformationen des Anwenders sind falsch.
403	Unzulässig. Der Benutzer ist kein Administrator und 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.

Parameter des Antworttexts (JSON oder XML)

Name	Beschreibung
Fehler	Fehlermeldung. Datentyp: Zeichenfolge
Links	Alle Links und sys_ids, die der Antwort zugeordnet sind. Datentyp: Objekt "links": { "progress": {Object} }
links.fortschritt	Beschreibt die Fortschrittslinkinformationen. Datentyp: Objekt "progress": { "id": "String", "url": "String" }
links.progress.id	Eindeutiger Bezeichner zum Abrufen der Fortschrittsdetails für den Vorgang. Verwenden Sie diesen Wert, wenn Sie den Endpunkt /sn_cicd/progress/{progress_id}aufrufen. Datentyp: Zeichenfolge
links.fortschritt.url	URL zum Abrufen der Fortschrittsdetails. Datentyp: Zeichenfolge
percent_complete	Prozentsatz der Anforderung, die abgeschlossen ist. Datentyp: Zahl
status	Numerischer Ausführungsstatus. Verwendet mit status_label. 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. Werte: Abgebrochen Fehlgeschlagen Ausstehend Wird ausgeführt Erfolgreich Datentyp: Zeichenfolge
status_message	Beschreibung des aktuellen Status. 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 – POST /sn_cicd/sc/apply_changes

Startet die Anwendung von Changes von einer Remote-Quellcodeverwaltung auf eine angegebene lokale Anwendung oder Anwendungsanpassung.

URL-Format

URL mit Versionsnummer: /api/sn_cicd/{api_version}/sc/apply_changes

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

Unterstützte Anforderungsparameter

Tabelle : 97. Pfadparameter

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

Tabelle : 98. Abfrageparameter

Name	Beschreibung
auto_upgrade_base_app	Gilt nur, wenn Changes für die App-Anpassung angewendet werden und der aktuelle Commit im Git-Repository auf einer Version basiert, die später ist als die der Basisanwendung, die derzeit in der lokalen Instanz installiert ist. Kennzeichnung, die angibt, ob das System die Basisanwendung automatisch auf eine spätere Version aktualisieren soll. Datentyp: Boolesch Standardwert: true
branch_name	Name der Verzweigung im Quellcodeverwaltungssystem, von der die Anwendung bezogen werden soll. Datentyp: Zeichenfolge Standard: Im Quellcodeverwaltungssystem angegebene Standardverzweigung.
scope	Erforderlich, wenn sys_id nicht angegeben ist. Der Bereichsname der Anwendung, für die die Änderungen angewendet werden sollen, z. B. x_aah_custom_app. Sie finden diesen Wert im Feld scope in der Tabelle „Anwenderdefinierte Anwendung“ [sys_app] oder „Store-Anwendung“ [sys_store_app] für die App-Anpassung. Datentyp: Zeichenfolge
sys_id	Erforderlich, wenn scope nicht angegeben ist. Die sys_id der Anwendung, für die die Änderungen angewendet werden sollen. Sie finden diesen Wert im Feld Sys ID in der Tabelle „Anwenderdefinierte Anwendung“ [sys_app] oder „Store-Anwendung“ [sys_store_app] für die App-Anpassung. 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 HTTP-Antwortcodesder REST-API.

Tabelle : 102. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
401	Die Anmeldeinformationen des Anwenders sind falsch.
403	Unzulässig. Der Benutzer ist kein Administrator und 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.

Parameter des Antworttexts (JSON oder XML)

Name	Beschreibung
Fehler	Fehlermeldung. Datentyp: Zeichenfolge
Links	Alle Links und sys_ids, die der Antwort zugeordnet sind. Datentyp: Objekt "links": { "progress": {Object} }
links.fortschritt	Beschreibt die Fortschrittslinkinformationen. Datentyp: Objekt "progress": { "id": "String", "url": "String" }
links.progress.id	Eindeutiger Bezeichner zum Abrufen der Fortschrittsdetails für den Vorgang. Verwenden Sie diesen Wert, wenn Sie den Endpunkt /sn_cicd/progress/{progress_id}aufrufen. Datentyp: Zeichenfolge
links.fortschritt.url	URL zum Abrufen der Fortschrittsdetails. Datentyp: Zeichenfolge
percent_complete	Prozentsatz der Anforderung, die abgeschlossen ist. Datentyp: Zahl
status	Numerischer Ausführungsstatus. Verwendet mit status_label. 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. Werte: Abgebrochen Fehlgeschlagen Ausstehend Wird ausgeführt Erfolgreich Datentyp: Zeichenfolge
status_message	Zusätzliche Informationen dazu, warum der Vorgang fehlgeschlagen ist. Leer, 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}

Startet die Anwendung eines zuvor generierten „Stash“ von Changes von einer Remote-Quellcodeverwaltung auf eine angegebene lokale Anwendung oder Anwendungsanpassung.

Dieser Endpunkt arbeitet mit den Endpunkten POST/api/sn_cicd/sc/apply_changes und CI/CD – GET /sn_cicd/progress/{progress_id} zusammen. Wenn der POST-Endpunkt /api/sn_cicd/sc/apply_changes aufgerufen wird, werden alle nicht gespeicherten oder nicht committeten Änderungen in App Engine Studio auf der zugeordneten Instanz als Stashin der Datenbank gespeichert.

Um zu ermitteln, ob bei der ersten Anwendung der Changes ein Stash erstellt wurde, rufen Sie den Endpunkt GET /sn_cicd/progress/{progress_id} auf. Wenn ein Stash erstellt wurde, werden die sys_id (stash_id) und die URL des Stash zurückgegeben. Um die Stash-Änderungen auf die zugeordnete Anwendung anzuwenden, rufen Sie diesen Endpunkt „ apply_stash “ mit der vom Fortschrittsendpunkt zurückgegebenen stash_id auf.

URL-Format

URL mit Versionsnummer: /api/sn_cicd/{api_version}/sc/apply_stash/{stash_id}

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

Unterstützte Anforderungsparameter

Tabelle : 103. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
stash_id	Eindeutiger Bezeichner des anzuwendenden Stashes. Dieser Wert wird im Parameter links.stash.id im entsprechenden Endpunktaufruf CI/CD – GET /sn_cicd/progress/{progress_id} zurückgegeben. 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
Content-Type	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 HTTP-Antwortcodesder REST-API.

Tabelle : 108. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
401	Die Anmeldeinformationen des Anwenders sind falsch.
403	Unzulässig. Der Benutzer ist kein Administrator und 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.

Parameter des Antworttexts (JSON oder XML)

Name	Beschreibung
Fehler	Fehlermeldung. Datentyp: Zeichenfolge
Links	Alle Links und sys_ids, die der Antwort zugeordnet sind. Datentyp: Objekt "links": { "progress": {Object} }
links.fortschritt	Beschreibt die Fortschrittslinkinformationen. Datentyp: Objekt "progress": { "id": "String", "url": "String" }
links.progress.id	Eindeutiger Bezeichner zum Abrufen der Fortschrittsdetails für den Vorgang. Verwenden Sie diesen Wert, wenn Sie den Endpunkt /sn_cicd/progress/{progress_id}aufrufen. Datentyp: Zeichenfolge
links.fortschritt.url	URL zum Abrufen der Fortschrittsdetails. Datentyp: Zeichenfolge
percent_complete	Prozentsatz der Anforderung, die abgeschlossen ist. Datentyp: Zahl
status	Numerischer Ausführungsstatus. Verwendet mit status_label. 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. Werte: Abgebrochen Fehlgeschlagen Ausstehend Wird ausgeführt Erfolgreich Datentyp: Zeichenfolge
status_message	Beschreibung des aktuellen Status. Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Codebeispiel zeigt, wie der Endpunkt „ apply_stash“ für stash_id fc2224e4e0429110f8771827f8fd3634 aufgerufen wird.

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, wurde also 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: POST /sn_cicd/sc/import

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

Verwenden Sie diesen Endpunkt, um eine Anwendung aus der Quellcodeverwaltung in der aufrufenden Instanz zu importieren, um dann Kontinuierliche Integration und kontinuierliche Bereitstellung (CICD) -Endpunkte wie z. B. /sn_cicd/sc/apply_changeszu verwenden, um die Anwendung in übergeordneten Umgebungen bereitzustellen.

Hinweis:

Bevor dieser Endpunkt verwendet werden kann, muss ein Git-Repository verfügbar sein, das von einer anderen Instanz mithilfe von Link zur Quellcodeverwaltung eingerichtet wurde.

URL-Format

URL mit Versionsnummer: /api/sn_cicd/{api_version}/sc/import

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

Unterstützte Anforderungsparameter

Tabelle : 109. Pfadparameter

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

Tabelle : 110. Abfrageparameter

Name	Beschreibung
auto_upgrade_base_app	Gilt nur, wenn die importierte Anwendung eine App-Anpassung ist und der aktuelle Commit im Git-Repository auf einer Version basiert, die später ist als die der Basisanwendung, die derzeit in der lokalen Instanz installiert ist. Kennzeichnung, die angibt, ob das System die Basisanwendung automatisch auf eine spätere Version aktualisieren soll. Gültige Werte: „wahr“: Basisanwendung automatisch aktualisieren. „falsch“: Basisanwendung nicht automatisch aktualisieren. 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 auf das Git-Repository zugreifen können. Datentyp: Zeichenfolge Standard: Sys_id wird 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 der Parameter repo_url ein https- oder ein ssh-Repository ist. Standardmäßig ist diese Eigenschaft leer.
mid_server_sys_id	Sys_id des MID-Servers, der für Quellcodeverwaltungsvorgä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 HTTP-Antwortcodesder REST-API.

Tabelle : 114. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
401	Die Anmeldeinformationen des Anwenders sind falsch.
403	Unzulässig. Der Benutzer ist kein Administrator und 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.

Parameter des Antworttexts (JSON oder XML)

Name	Beschreibung
Fehler	Fehlermeldung. Datentyp: Zeichenfolge
Links	Alle Links und sys_ids, die der Antwort zugeordnet sind. Datentyp: Objekt "links": { "progress": {Object} }
links.fortschritt	Beschreibt die Fortschrittslinkinformationen. Datentyp: Objekt "progress": { "id": "String", "url": "String" }
links.progress.id	Eindeutiger Bezeichner zum Abrufen der Fortschrittsdetails für den Vorgang. Verwenden Sie diesen Wert, wenn Sie den Endpunkt /sn_cicd/progress/{progress_id}aufrufen. Datentyp: Zeichenfolge
links.fortschritt.url	URL zum Abrufen der Fortschrittsdetails. Datentyp: Zeichenfolge
percent_complete	Prozentsatz der Anforderung, die abgeschlossen ist. Datentyp: Zahl
status	Numerischer Ausführungsstatus. Verwendet mit status_label. 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. Werte: Abgebrochen Fehlgeschlagen Ausstehend Wird ausgeführt Erfolgreich Datentyp: Zeichenfolge
status_message	Beschreibung des aktuellen Status. Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Beispiel zeigt, wie Sie die Anwendung importieren, die sich unter https://code.devsnc.com/home-user/ncRegrApp1.git in main_branch befindet.

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: POST /sn_cicd/testsuite/run

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

Hinweis:

Wenn die von Ihnen ausgeführte Suite UI-Tests enthält, muss entweder ein geplanter Client-Test Runner geöffnet sein oder Sie müssen in der Lage sein, die Ausführung des Headless-Test Runners zu konfigurieren. Weitere Informationen finden Sie unter Monitorloser Browser für Automated Test Framework.

URL-Format

URL mit Versionsnummer: /api/sn_cicd/{api_version}/testsuite/run

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

Unterstützte Anforderungsparameter

Tabelle : 115. Pfadparameter

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

Tabelle : 116. Abfrageparameter

Name	Beschreibung
browser_name	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 Runner finden Sie unter Geplante Client-TestRunner. Datentyp: Zeichenfolge Gültige Werte: (muss in Kleinbuchstaben angegeben werden) Beliebig Chrome Firefox Edge Dh Safari Standard: beliebig
browser_version	Startwert der Version des in browser_name angegebenen Browsers für die Ausführung des Tests. Wenn Sie beispielsweise „9“ eingeben, werden alle 9.xxx-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: true: Führt die Test-Suite als Leistungstest aus. false: Führt die Test-Suite mit dem Standardverhalten eines standardmäßigen 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 dem die Test-Suite ausgeführt werden soll. Wenn Sie beispielsweise „8“ eingeben, werden alle 8.xxx-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: true: Führt die Test-Suite mit Cloud Runner aus. false: Führt die Test-Suite mit dem manuellen Test Runner aus. Standardwert: false
test_suite_sys_id	Erforderlich, wenn test_suite_name nicht angegeben ist. Die sys_id der auszuführenden Test-Suite. Dieser Wert befindet sich in der Tabelle „Test“ [sys_atf_test_suite]. Datentyp: Zeichenfolge
test_suite_name	Erforderlich, wenn test_suite_sys_id nicht angegeben ist. Der Name der auszuführenden Test-Suite. Dieser Wert befindet sich in der Tabelle „Test“ [sys_atf_test_suite]. Datentyp: Zeichenfolge

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

Tabelle : 120. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
401	Die Anmeldeinformationen des Anwenders sind falsch.
403	Unzulässig. Der Benutzer ist kein Administrator und 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.

Parameter des Antworttexts (JSON oder XML)

Name	Beschreibung
Fehler	Fehlermeldung. Datentyp: Zeichenfolge
Links	Alle Links und sys_ids, die der Antwort zugeordnet sind. Datentyp: Objekt "links": { "progress": {Object} }
links.fortschritt	Beschreibt die Fortschrittslinkinformationen. Datentyp: Objekt "progress": { "id": "String", "url": "String" }
links.progress.id	Eindeutiger Bezeichner zum Abrufen der Fortschrittsdetails für den Vorgang. Verwenden Sie diesen Wert, wenn Sie den Endpunkt /sn_cicd/progress/{progress_id}aufrufen. Datentyp: Zeichenfolge
links.fortschritt.url	URL zum Abrufen der Fortschrittsdetails. Datentyp: Zeichenfolge
links.ergebnisse	Ergebnisinformationen. Datentyp: Objekt "results": { "id": "String", "url": "String" }
links.results.id	Eindeutiger Bezeichner der Ergebnisinformationen. Verwenden Sie diesen Wert, wenn Sie den zugeordneten Ergebnissedpunkt aufrufen. Datentyp: Zeichenfolge
links.Ergebnisse.URL	URL zum Abrufen der Ergebnisse der Endpunktausführung, z. B. Ergebnisse. Datentyp: Zeichenfolge
percent_complete	Prozentsatz der Anforderung, die abgeschlossen ist. Datentyp: Zahl
status	Numerischer Ausführungsstatus. Verwendet mit status_label. 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. Werte: Abgebrochen Fehlgeschlagen Ausstehend Wird ausgeführt Erfolgreich Datentyp: Zeichenfolge
status_message	Beschreibung des aktuellen Status. 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"
  }
}