Kontinuierliche Integration und kontinuierliche Bereitstellung (CICD) Update-Satz-API

Die CICD-Update-Satz Die API bietet Methoden zum Erstellen, Abrufen, Vorschauen, Commit und Zurücksetzen eines Update-Satzes.

Diese API ist den Aktionen zugeordnet, die Sie ausführen können System-Update-Sätze Und erfordert die sn_cicd.sys_ci_automation-Rolle und REST API für kontinuierliche Integration und kontinuierliche Bereitstellung (CICD)Plugin (com.Glide.continuousDelivery), um darauf zuzugreifen.

CICD-Update-Satz – POST /api/sn_cicd/Update_Set/Retrieve

Ruft einen Update-Satz mit einer bestimmten sys_ID ab und ermöglicht es Ihnen, den vorhandenen abgerufenen Update-Satz aus der Instanz zu entfernen.

URL-Format

Versionierte URL: /api/sn_cicd/{api_Version}/Update_Set/Retrieve

Standard-URL: /api/sn_cicd/Update_Set/Retrieve

Hinweis:

Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 1. Pfad-Parameter

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

Tabelle : 2. Abfrageparameter

Name	Beschreibung
update_set_id	Erforderlich. SYS_ID des Update-Satzes in der Quellinstanz, aus der der Update-Satz abgerufen wurde. Tabelle: Update-Sätze [sys_Update_Set] Datentyp: Zeichenfolge
Update_Source_ID	SYS_ID des Remote-Instanzdatensatzes. Tabelle: Remote-Instanzen [sys_update_set_source] Datentyp: Zeichenfolge
update_source_instance_id	Instanz-ID der Remote-Instanz. Tabelle: Remote-Instanzen [sys_update_set_source] Datentyp: Zeichenfolge
auto_Preview	Kennzeichnung, die angibt, ob der Update-Satz nach dem Abruf automatisch in der Vorschau angezeigt werden soll. Gültige Werte: Wahr: Vorschau des Update-Satzes beim Abruf anzeigen. Falsch: Zeigen Sie beim Abrufen keine Vorschau des Update-Satzes an. Datentyp: Boolescher Wert Standard: Falsch
Cleanup_Retrieved	Kennzeichnung, die angibt, ob der vorhandene abgerufene Update-Satz aus der Instanz entfernt werden soll. Gültige Werte: Wahr: Entfernen Sie den Update-Satz. Falsch: Entfernen Sie den Update-Satz nicht Datentyp: Boolescher Wert Standard: Falsch

Tabelle : 3. Anforderungstext-Parameter (XML oder JSON)

Name	Beschreibung
Keine

Header

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

Tabelle : 4. Anforderungskopfzeilen.

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

Statuscodes

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

Tabelle : 5. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt.
401	Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
403	Unzulässig. Der Anwender hat keine Zugriffsrechte für den angegebenen Datensatz.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Fehler	Fehlermeldung mit Details zum Fehler. Datentyp: Zeichenfolge
Links	Informationen zu Links und sys_IDs, die dem Update-Satz zugeordnet sind. Datentyp: Objekt "links": { "progress": {Object} }
links.progress	Fortschrittsinformationen zum Vorgang, der für den Update-Satz ausgeführt wird. Datentyp: Objekt "progress": { "id": "String", "url": "String" }
links.progress.id	SYS_ID mit Fortschrittsdetails für den Vorgang. Sie können diesen Wert beim Aufrufen des Endpunkts verwenden CI/CD – GET /sn_cicd/Progress/{Progress_ID}. Datentyp: Zeichenfolge
links.progress.url	URL, die zum Abrufen der Fortschrittsdetails zum Vorgang verwendet werden soll, der für den Update-Satz ausgeführt wird. Datentyp: Zeichenfolge
percent_complete	Prozentsatz der abgeschlossenen Anforderung. Datentyp: Zahl
Status	Zahl, die den Ausführungsstatus der Aktion darstellt, die für den Update-Satz ausgeführt wird. Entspricht status_labelDeskriptor. Mögliche Werte: 0: Ausstehend 1: Wird Ausgeführt 2: Erfolgreich 3: Fehlgeschlagen 4: Abgebrochen Datentyp: Zeichenfolge
status_detail	Detaillierte Nachricht zum Ausführungsstatus, falls verfügbar. Entspricht dem Feld „Detailed_message“ in der Tabelle „Ausführungstracker“ [sys_Execution_Tracker]. Datentyp: Zeichenfolge
status_label	Ausführungsstatus der Update-Satz-Aktion. Entspricht statusNummer. Mögliche Werte: Abgebrochen Fehlgeschlagen Ausstehend Wird ausgeführt Erfolgreich Datentyp: Zeichenfolge
status_message	Zusätzliche Beschreibung des aktuellen Status der Aktion, falls verfügbar. Datentyp: Zeichenfolge

Curl-Anforderung

Das folgende Beispiel ruft einen bestimmten Update-Satz mit einer bestimmten sys_ID und Instanz-ID ab.

curl 
"https://instance.servicenow.com/api/sn_cicd/update_set/retrieve?update_set_id=2ce715950d619e10f87785462179bd67&update_source_id=e66613a49d011210f877036c70ae59f7" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'

Antworttext. Zeigt Details zum aktuellen Status des Update-Satzes und zum Ausführungsfortschritt an.

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

CICD-Update-Satz – POST /api/sn_cicd/Update_Set/commit Multiple

Commits mehrerer Update-Sätze in einer einzelnen Anforderung gemäß der angegebenen Reihenfolge.

URL-Format

Versionierte URL: /api/sn_cicd/{api_Version}/Update_Set/commit Multiple

Standard-URL: /api/sn_cicd/Update_Set/commit Multiple

Hinweis:

Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 6. Pfad-Parameter

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

Tabelle : 7. Abfrageparameter

Name	Beschreibung
remote_update_set_ids	Erforderlich. Liste der sys_IDs, die allen zu bestätigenden Update-Sätzen zugeordnet sind. SYS_IDs werden in der in der Anforderung angegebenen Reihenfolge bestätigt. Hinweis: Sie können verwenden CI/CD – GET /sn_cicd/Progress/{Progress_ID}Endpunkt zum Abrufen der Remote-Update-Satz-ID. Datentyp: Zeichenfolge Tabelle: Abgerufene Update-Sätze [sys_remote_update_set]

Tabelle : 8. Anforderungstext-Parameter (XML oder JSON)

Name

Beschreibung

Force_commit

Kennzeichnung, die angibt, ob das Commit des Update-Satzes erzwungen werden soll. Diese Funktion ist nützlich, wenn einige in der Eingabe angegebene Remote-Update-Sätze bereits in einem früheren Vorgang bestätigt wurden. Diese Funktion stellt auch sicher, dass die Commit-Reihenfolge in der Reihenfolge befolgt wird, in der die Update-Sätze angegeben werden. Gültige Werte: Wahr: Commits des Update-Satzes erzwingen. Falsch: Erzwingt das Commit des Update-Satzes nicht. Wenn der Commit nicht erzwungen wird, schlägt der Commit fehl, wenn die Commit-Reihenfolge nicht befolgt wird. Datentyp: Zeichenfolge Standard: Falsch

Header

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

Tabelle : 9. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json
Inhaltstyp	Datenformat des Anforderungstexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json

Tabelle : 10. Antwort-Header

Header	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json

Statuscodes

Tabelle : 11. Statuscodes

Name	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt.
401	Die Anwenderanmeldeinformationen sind falsch.
403	Unzulässig. Der Anwender ist kein Administrator oder hat keine sn_cicd.sys_ci_automation-Rolle.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
409	Konflikt. Das angeforderte Element ist nicht eindeutig.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Fehler	Fehlermeldung mit Details zum Fehler. Datentyp: Zeichenfolge
Links	Informationen zu Links und sys_IDs, die dem Update-Satz zugeordnet sind. Datentyp: Objekt "links": { "progress": {Object} }
links.progress	Fortschrittsinformationen zum Vorgang, der für den Update-Satz ausgeführt wird. Datentyp: Objekt "progress": { "id": "String", "url": "String" }
links.progress.id	SYS_ID mit Fortschrittsdetails für den Vorgang. Sie können diesen Wert beim Aufrufen des Endpunkts verwenden CI/CD – GET /sn_cicd/Progress/{Progress_ID}. Datentyp: Zeichenfolge
links.progress.url	URL, die zum Abrufen der Fortschrittsdetails zum Vorgang verwendet werden soll, der für den Update-Satz ausgeführt wird. Datentyp: Zeichenfolge
percent_complete	Prozentsatz der abgeschlossenen Anforderung. Datentyp: Zahl
Status	Zahl, die den Ausführungsstatus der Aktion darstellt, die für den Update-Satz ausgeführt wird. Entspricht status_labelDeskriptor. Mögliche Werte: 0: Ausstehend 1: Wird Ausgeführt 2: Erfolgreich 3: Fehlgeschlagen 4: Abgebrochen Datentyp: Zeichenfolge
status_detail	Detaillierte Nachricht zum Ausführungsstatus, falls verfügbar. Entspricht dem Feld „Detailed_message“ in der Tabelle „Ausführungstracker“ [sys_Execution_Tracker]. Datentyp: Zeichenfolge
status_label	Ausführungsstatus der Update-Satz-Aktion. Entspricht statusNummer. Mögliche Werte: Abgebrochen Fehlgeschlagen Ausstehend Wird ausgeführt Erfolgreich Datentyp: Zeichenfolge
status_message	Zusätzliche Beschreibung des aktuellen Status der Aktion, falls verfügbar. Datentyp: Zeichenfolge

Curl-Anforderung

Das folgende Beispiel zeigt, wie ein Update mit einer bestimmten sys_ID bestätigt wird

curl 
"https://instance.servicenow.com/api/sn_cicd/update_set/commitMultiple?remote_update_set_ids=0a9f45ab9d415e10f877036c70ae5968%2Cc2e89999c9e19e10f877184664aecd40" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"force_commit\":\"true\"}" \
--user 'username':'password'

Antworttext.

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

CICD-Update-Satz – POST /api/sn_cicd/Update_Set/preview/{remote_update_set_id}

Zeigt eine Vorschau eines Update-Satzes an, um nach Konflikten zu suchen und Fortschrittsinformationen zum Update-Satz-Vorgang abzurufen.

Hinweis:

Wenn der Update-Satz, den Sie in der Vorschau anzeigen möchten, in der Instanz nicht vorhanden ist, müssen Sie zuerst verwenden CICD-Update-Satz – POST /api/sn_cicd/Update_Set/RetrieveEndpunkt zum Abrufen des Update-Satzes oder manuell in der Anwenderoberfläche.

URL-Format

Versionierte URL: /api/sn_cicd/{api_Version}/Update_Set/preview/{remote_update_set_id}

Standard-URL: /api/sn_cicd/Update_Set/preview/{remote_update_set_id}

Hinweis:

Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 12. Pfad-Parameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
remote_update_set_id	SYS_ID des Update-Satzes, der in der Vorschau angezeigt werden soll. Tabelle: Abgerufene Update-Sätze [sys_remote_update_set] Datentyp: Zeichenfolge

Tabelle : 13. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 14. Anforderungstext-Parameter (XML oder JSON)

Name	Beschreibung
Keine

Header

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

Tabelle : 15. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json
Inhaltstyp	Datenformat des Anforderungstexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json

Tabelle : 16. Antwort-Header

Header	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json

Statuscodes

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

Tabelle : 17. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt.
401	Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
403	Unzulässig. Der Anwender hat keine Zugriffsrechte für den angegebenen Datensatz.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Fehler	Fehlermeldung mit Details zum Fehler. Datentyp: Zeichenfolge
Links	Informationen zu Links und sys_IDs, die dem Update-Satz zugeordnet sind. Datentyp: Objekt "links": { "progress": {Object} }
links.progress	Fortschrittsinformationen zum Vorgang, der für den Update-Satz ausgeführt wird. Datentyp: Objekt "progress": { "id": "String", "url": "String" }
links.progress.id	SYS_ID mit Fortschrittsdetails für den Vorgang. Sie können diesen Wert beim Aufrufen des Endpunkts verwenden CI/CD – GET /sn_cicd/Progress/{Progress_ID}. Datentyp: Zeichenfolge
links.progress.url	URL, die zum Abrufen der Fortschrittsdetails zum Vorgang verwendet werden soll, der für den Update-Satz ausgeführt wird. Datentyp: Zeichenfolge
percent_complete	Prozentsatz der abgeschlossenen Anforderung. Datentyp: Zahl
Status	Zahl, die den Ausführungsstatus der Aktion darstellt, die für den Update-Satz ausgeführt wird. Entspricht status_labelDeskriptor. Mögliche Werte: 0: Ausstehend 1: Wird Ausgeführt 2: Erfolgreich 3: Fehlgeschlagen 4: Abgebrochen Datentyp: Zeichenfolge
status_detail	Detaillierte Nachricht zum Ausführungsstatus, falls verfügbar. Entspricht dem Feld „Detailed_message“ in der Tabelle „Ausführungstracker“ [sys_Execution_Tracker]. Datentyp: Zeichenfolge
status_label	Ausführungsstatus der Update-Satz-Aktion. Entspricht statusNummer. Mögliche Werte: Abgebrochen Fehlgeschlagen Ausstehend Wird ausgeführt Erfolgreich Datentyp: Zeichenfolge
status_message	Zusätzliche Beschreibung des aktuellen Status der Aktion, falls verfügbar. Datentyp: Zeichenfolge

Curl-Anforderung

Das folgende Beispiel zeigt, wie Sie eine Vorschau eines Remote-Update-Satzes mit einer bestimmten ID anzeigen.

curl 
curl "https://instance.servicenow.com/api/sn_cicd/update_set/preview/8f4608d39d89da10f877036c70ae5998" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'

Antworttext.

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

CICD-Update-Satz – POST /api/sn_cicd/Update_Set/back_out

Setzt einen Installationsvorgang zurück, der für einen Update-Satz mit einer bestimmten sys_ID ausgeführt wurde

Weitere Informationen darüber, wie sich der Zurücksetzvorgang auf einen Update-Satz auswirkt, finden Sie unter Back out an update set.

URL-Format

Versionierte URL: /api/sn_cicd/{api_Version}/Update_Set/back_out

Standard-URL: /api/sn_cicd/Update_Set/back_out

Hinweis:

Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 18. Pfad-Parameter

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

Tabelle : 19. Abfrageparameter

Name	Beschreibung
Rollback_Installs	Kennzeichnung, die angibt, ob ein Rollback für die Batch-Installation durchgeführt werden soll, die während des Update-Satzes ausgeführt wurde. Mögliche Werte: Wahr: Rollback der Installation durchführen. Falsch: Setzen Sie die Installation nicht zurück. Datentyp: Boolescher Wert Standard: Wahr
update_set_id	Erforderlich. SYS_ID des Update-Satzes. Tabelle: Update-Sätze [sys_Update_Set] Datentyp: Zeichenfolge

Tabelle : 20. Anforderungstext-Parameter (XML oder JSON)

Name	Beschreibung
Keine

Header

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

Tabelle : 21. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json
Inhaltstyp	Datenformat des Anforderungstexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json

Tabelle : 22. Antwort-Header

Header	Beschreibung
Inhaltstyp	Datenformat des Anforderungstexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json

Statuscodes

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

Tabelle : 23. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt.
401	Die Anwenderanmeldeinformationen sind falsch.
403	Unzulässig. Der Anwender ist kein Administrator oder hat keine sn_cicd.sys_ci_automation-Rolle.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
405	Ungültige Methode. Die Funktionalität ist inaktiv.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Fehler	Fehlermeldung mit Details zum Fehler. Datentyp: Zeichenfolge
Links	Informationen zu Links und sys_IDs, die dem Update-Satz zugeordnet sind. Datentyp: Objekt "links": { "progress": {Object} }
links.progress	Fortschrittsinformationen zum Vorgang, der für den Update-Satz ausgeführt wird. Datentyp: Objekt "progress": { "id": "String", "url": "String" }
links.progress.id	SYS_ID mit Fortschrittsdetails für den Vorgang. Sie können diesen Wert beim Aufrufen des Endpunkts verwenden CI/CD – GET /sn_cicd/Progress/{Progress_ID}. Datentyp: Zeichenfolge
links.progress.url	URL, die zum Abrufen der Fortschrittsdetails zum Vorgang verwendet werden soll, der für den Update-Satz ausgeführt wird. Datentyp: Zeichenfolge
percent_complete	Prozentsatz der abgeschlossenen Anforderung. Datentyp: Zahl
Status	Zahl, die den Ausführungsstatus der Aktion darstellt, die für den Update-Satz ausgeführt wird. Entspricht status_labelDeskriptor. Mögliche Werte: 0: Ausstehend 1: Wird Ausgeführt 2: Erfolgreich 3: Fehlgeschlagen 4: Abgebrochen Datentyp: Zeichenfolge
status_detail	Detaillierte Nachricht zum Ausführungsstatus, falls verfügbar. Entspricht dem Feld „Detailed_message“ in der Tabelle „Ausführungstracker“ [sys_Execution_Tracker]. Datentyp: Zeichenfolge
status_label	Ausführungsstatus der Update-Satz-Aktion. Entspricht statusNummer. Mögliche Werte: Abgebrochen Fehlgeschlagen Ausstehend Wird ausgeführt Erfolgreich Datentyp: Zeichenfolge
status_message	Zusätzliche Beschreibung des aktuellen Status der Aktion, falls verfügbar. Datentyp: Zeichenfolge

Curl-Anforderung

Das folgende Beispiel zeigt, wie ein Installationsvorgang für eine bestimmte Update-sys_ID zurückgesetzt wird

curl 
"https://instance.servicenow.com/api/sn_cicd/update_set/back_out?update_set_id=73dd24e39dcd1e10f877036c70ae59ae&rollback_installs=false" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'

Antwort:

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

CICD-Update-Satz – POST /api/sn_cicd/Update_Set/commit/{remote_update_set_id}

Commits für einen Update-Satz mit einer bestimmten sys_ID

Wenn Sie eine Vorschau eines Update-Satzes angezeigt und Probleme gelöst haben, können Sie den Update-Satz mit diesem Endpunkt bestätigen. Durch das Commit eines Update-Satzes werden alle Änderungen auf die Instanz angewendet und eine lokale Kopie des Update-Satzes erstellt, die einen Update-Datensatz für jeden Change enthält. Weitere Informationen zum Commit eines Update-Satzes finden Sie unter Commit an update set.

URL-Format

Versionierte URL: /api/sn_cicd/{api_Version}/Update_Set/commit/{remote_update_set_id}

Standard-URL: /api/sn_cicd/Update_Set/ commit/{remote_update_set_id}

Hinweis:

Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 24. Pfad-Parameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
remote_update_set_id	SYS_ID des zu bestätigenden Update-Satzes. Hinweis: Sie können verwenden CI/CD – GET /sn_cicd/Progress/{Progress_ID}Endpunkt zum Abrufen der Remote-Update-Satz-ID. Tabelle: Abgerufene Update-Sätze [sys_remote_update_set] Datentyp: Zeichenfolge

Tabelle : 25. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 26. Anforderungstext-Parameter (XML oder JSON)

Name

Beschreibung

Force_commit

Kennzeichnung, die angibt, ob das Commit des Update-Satzes erzwungen werden soll. Gültige Werte: Wahr: Commits des Update-Satzes erzwingen, auch wenn Sie ihn noch nicht in der Vorschau angezeigt haben, um nach Konflikten zu suchen. Falsch: Erzwingt das Commit des Update-Satzes nicht. Sie müssen eine Vorschau des Update-Satzes anzeigen, bevor Sie mit dem Commit fortfahren. Datentyp: Zeichenfolge Standard: Falsch

Header

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

Tabelle : 27. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json
Inhaltstyp	Datenformat des Anforderungstexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json

Tabelle : 28. Antwort-Header

Header	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json

Statuscodes

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

Tabelle : 29. Statuscodes

Name	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt.
401	Die Anwenderanmeldeinformationen sind falsch.
403	Unzulässig. Der Anwender hat keine Zugriffsrechte für den angegebenen Datensatz.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
409	Konflikt. Das angeforderte Element ist nicht eindeutig.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Fehler	Fehlermeldung mit Details zum Fehler. Datentyp: Zeichenfolge
Links	Informationen zu Links und sys_IDs, die dem Update-Satz zugeordnet sind. Datentyp: Objekt "links": { "progress": {Object} }
links.progress	Fortschrittsinformationen zum Vorgang, der für den Update-Satz ausgeführt wird. Datentyp: Objekt "progress": { "id": "String", "url": "String" }
links.progress.id	SYS_ID mit Fortschrittsdetails für den Vorgang. Sie können diesen Wert beim Aufrufen des Endpunkts verwenden CI/CD – GET /sn_cicd/Progress/{Progress_ID}. Datentyp: Zeichenfolge
links.progress.url	URL, die zum Abrufen der Fortschrittsdetails zum Vorgang verwendet werden soll, der für den Update-Satz ausgeführt wird. Datentyp: Zeichenfolge
percent_complete	Prozentsatz der abgeschlossenen Anforderung. Datentyp: Zahl
Status	Zahl, die den Ausführungsstatus der Aktion darstellt, die für den Update-Satz ausgeführt wird. Entspricht status_labelDeskriptor. Mögliche Werte: 0: Ausstehend 1: Wird Ausgeführt 2: Erfolgreich 3: Fehlgeschlagen 4: Abgebrochen Datentyp: Zeichenfolge
status_detail	Detaillierte Nachricht zum Ausführungsstatus, falls verfügbar. Entspricht dem Feld „Detailed_message“ in der Tabelle „Ausführungstracker“ [sys_Execution_Tracker]. Datentyp: Zeichenfolge
status_label	Ausführungsstatus der Update-Satz-Aktion. Entspricht statusNummer. Mögliche Werte: Abgebrochen Fehlgeschlagen Ausstehend Wird ausgeführt Erfolgreich Datentyp: Zeichenfolge
status_message	Zusätzliche Beschreibung des aktuellen Status der Aktion, falls verfügbar. Datentyp: Zeichenfolge

Curl-Anforderung

Im folgenden Beispiel wird der Update-Satz mit der zugehörigen sys_ID Commit ausgeführt

curl 
"https://instance.servicenow.com/api/sn_cicd/update_set/commit/4ee89999c9e19e10f877184664aecd42" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'

Antworttext.

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

CICD-Update-Satz – POST /api/sn_cicd/Update_Set/create

Erstellt einen neuen Update-Satz und fügt den neuen Datensatz in die Tabelle „Update-Sätze“ [sys_Update_Set] ein.

URL-Format

Versionierte URL: /api/sn_cicd/{api_Version}/Update_Set/create

Standard-URL: /api/sn_cicd/Update_Set/create

Hinweis:

Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 30. Pfad-Parameter

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

Tabelle : 31. Abfrageparameter

Name	Beschreibung
Beschreibung	Beschreibung des Update-Satzes. Datentyp: Zeichenfolge Standard: Null
scope	Erforderlich, wenn sys_idParameter wurde nicht übergeben. Der Bereichsname der Anwendung, in der der neue Update-Satz erstellt werden soll. Tabelle: Anwendungen [sys_scope] Datentyp: Zeichenfolge
sys_id	Erforderlich, wenn scopeParameter wurde nicht übergeben. SYS_ID der Anwendung, in der der neue Update-Satz erstellt werden soll. Tabelle: Anwendungen [sys_scope] Datentyp: Zeichenfolge
Update_Set_Name	Erforderlich. Name, der dem Update-Satz zugewiesen werden soll. Datentyp: Zeichenfolge

Tabelle : 32. Anforderungstext-Parameter (XML oder JSON)

Name	Beschreibung
Keine

Header

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

Tabelle : 33. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json
Inhaltstyp	Datenformat des Anforderungstexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json

Tabelle : 34. Antwort-Header

Header	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json

Statuscodes

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

201	Der Update-Satz wurde erfolgreich erstellt.
400	Ungültige Anforderung. Der Name des Update-Satzes ist null oder leer, oder sowohl die Eingabe-sys_ID als auch der Umfang sind null oder leer.
403	Unzulässig. Der Anwender ist kein Administrator oder hat keine sn_cicd.sys_ci_automation-Rolle.
409	Konflikt. Das angeforderte Element ist nicht eindeutig.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Fehler	Fehlermeldung mit Details zum Fehler. Datentyp: Zeichenfolge
Status	Zahl, die den Ausführungsstatus der Aktion darstellt, die für den Update-Satz ausgeführt wird. Entspricht status_labelDeskriptor. Mögliche Werte: 0: Ausstehend 1: Wird Ausgeführt 2: Erfolgreich 3: Fehlgeschlagen 4: Abgebrochen Datentyp: Zeichenfolge
status_detail	Detaillierte Nachricht zum Ausführungsstatus, falls verfügbar. Entspricht dem Feld „Detailed_message“ in der Tabelle „Ausführungstracker“ [sys_Execution_Tracker]. Datentyp: Zeichenfolge
status_label	Ausführungsstatus der Update-Satz-Aktion. Entspricht statusNummer. Mögliche Werte: Abgebrochen Fehlgeschlagen Ausstehend Wird ausgeführt Erfolgreich Datentyp: Zeichenfolge
status_message	Zusätzliche Beschreibung des aktuellen Status der Aktion, falls verfügbar. Datentyp: Zeichenfolge
update_set_id	SYS_ID des erstellten Update-Satzes. Tabelle: Update-Sätze [sys_Update_Set] Datentyp: Zeichenfolge

Curl-Anforderung

Das folgende Beispiel zeigt, wie ein neuer Update-Satz mit dem Namen erstellt wird Testupdatensatz Und der Bereich auf festgelegt sn_Test .

curl 
"https://instance.servicenow.com/api/sn_cicd/update_set/create?update_set_name=Testupdateset&scope=sn_test" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'

Antworttext.

{
  "result": {
    "status": "2",
    "status_label": "",
    "status_message": "Successfully created update set: Test update set 1",
    "status_detail": "",
    "error": "",
    "update_set_id": "a9a485d1c9a19e10f877184664aecd11"
  }
}