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

Die CICD-Update Set- API bietet Methoden zum Erstellen, Abrufen, Anzeigen, Committen und Zurücksetzen eines Update Sets.

Diese API ist mit den Aktionen verknüpft, die Sie für System-Update-Sätze ausführen können, und erfordert für den Zugriff die Rolle sn_cicd.sys_ci_automation und das Plugin REST API für kontinuierliche Integration und kontinuierliche Bereitstellung (CICD) (com.glide.continualdelivery).

CICD-Update-Satz: POST /api/sn_cicd/update_set/retrieve

Ruft einen Update-Satz mit einer bestimmten sys_id ab und ermöglicht Ihnen, das vorhandene abgerufene Update Set aus der Instanz zu entfernen.

URL-Format

URL mit Versionsnummer: /api/sn_cicd/{api_version}/update_set/retrieve

Standard-URL: /api/sn_cicd/update_set/retrieve

Hinweis:

Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

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

Tabelle : 2. Abfrageparameter

Name	Beschreibung
update_set_id	Erforderlich. Sys_id des Update-Satzes auf der Quellinstanz, von der der Update-Satz abgerufen wurde. Tabelle: Update-Sätze [sys_update_set] Datentyp: Zeichenfolge
update_source_id	Sys_id des Datensatzes der Remote-Instanz. 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 das Update Set nach dem Abrufen automatisch in der Vorschau angezeigt werden soll. Gültige Werte: „wahr“: Vorschau des Update Set nach Abruf anzeigen. „falsch“: Zeigt das Update Set nach dem Abrufen nicht in der Vorschau an. Datentyp: Boolesch Standardwert: false
cleanup_retriected	Kennzeichnung, die angibt, ob das vorhandene abgerufene Update Set aus der Instanz entfernt werden soll. Gültige Werte: wahr: Update-Satz entfernen. „falsch“: Das Update Set wird nicht entfernt Datentyp: Boolesch Standardwert: false

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

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

Tabelle : 5. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Nicht autorisiert. Die Anmeldeinformationen 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. Der Antworttext enthält Informationen zum Fehler.

Parameter des Antworttexts (JSON oder XML)

Name	Beschreibung
Fehler	Fehlermeldung mit Details zum Fehler. Datentyp: Zeichenfolge
Links	Informationen zu allen Links und sys_ids, die dem Update Set zugeordnet sind. Datentyp: Objekt "links": { "progress": {Object} }
links.fortschritt	Fortschrittsinformationen zum Vorgang, der für das Update Set ausgeführt wurde. Datentyp: Objekt "progress": { "id": "String", "url": "String" }
links.progress.id	Sys_id, die Details zum Fortschritt des Vorgangs enthält. Sie können diesen Wert verwenden, wenn Sie den Endpunkt CI/CD – GET /sn_cicd/progress/{progress_id}aufrufen. Datentyp: Zeichenfolge
links.fortschritt.url	URL zum Abrufen der Fortschrittsdetails zum Vorgang, der für das Update Set ausgeführt wird. Datentyp: Zeichenfolge
percent_complete	Prozentsatz der Anforderung, die abgeschlossen ist. Datentyp: Zahl
status	Zahl, die den Ausführungsstatus der für den Update-Satz ausgeführten Aktion darstellt. Entspricht dem Deskriptor status_label. Mögliche Werte: 0: Ausstehend 1: Wird ausgeführt 2: Erfolgreich 3: Fehlgeschlagen 4: Abgebrochen Datentyp: Zeichenfolge
status_detail	Detaillierte Meldung zum Ausführungsstatus, falls verfügbar. Entspricht dem Feld „detaillierte_Nachricht“ in der Tabelle „Ausführungstracker“ [sys_execution_tracker]. Datentyp: Zeichenfolge
status_label	Ausführungsstatus der Update-Satz-Aktion. Entspricht der Nummer status. 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 ein bestimmtes Update Set mit einer bestimmten sys_id und Instanz-ID abgerufen.

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 und Ausführungsfortschritt des Update Set 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/commitMultiple

Legt mehrere Update-Sätze in einer einzigen Anforderung entsprechend der angegebenen Reihenfolge fest.

URL-Format

URL mit Versionsnummer: /api/sn_cicd/{api_version}/update_set/commitMultiple

Standard-URL: /api/sn_cicd/update_set/commitMultiple

Hinweis:

Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

Unterstützte Anforderungsparameter

Tabelle : 6. 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 : 7. Abfrageparameter

Name	Beschreibung
remote_update_set_ids	Erforderlich. Liste der sys_ids, die den zu bestätigenden Update-Sätzen zugeordnet sind. Sys_ids werden in der in der Anforderung angegebenen Reihenfolge committet. Hinweis: Mit dem Endpunkt CI/CD – GET /sn_cicd/progress/{progress_id} können Sie die ID des Remote-Update-Satzes abrufen. Datentyp: Zeichenfolge Tabelle: Abgerufene Update-Sätze [sys_remote_update_set]

Tabelle : 8. Anforderungstextparameter (XML oder JSON)

Name

Beschreibung

„force_commit“

Kennzeichnung, die angibt, ob das Committen des Update Set 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 eingehalten wird, in der die Update Sets bereitgestellt werden. Gültige Werte: „wahr“: Erzwingt das Commit für den Update-Satz. „falsch“: Erzwingt keinen Commit für den Update-Satz. Wenn der Commit nicht erzwungen wird, schlägt der Commit fehl, wenn die Commit-Reihenfolge nicht eingehalten wird. Datentyp: Zeichenfolge Standardwert: false

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 : 9. 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 : 10. Antwortkopfzeilen

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

Statuscodes

Tabelle : 11. Statuscodes

Name	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
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.
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 mit Details zum Fehler. Datentyp: Zeichenfolge
Links	Informationen zu allen Links und sys_ids, die dem Update Set zugeordnet sind. Datentyp: Objekt "links": { "progress": {Object} }
links.fortschritt	Fortschrittsinformationen zum Vorgang, der für das Update Set ausgeführt wurde. Datentyp: Objekt "progress": { "id": "String", "url": "String" }
links.progress.id	Sys_id, die Details zum Fortschritt des Vorgangs enthält. Sie können diesen Wert verwenden, wenn Sie den Endpunkt CI/CD – GET /sn_cicd/progress/{progress_id}aufrufen. Datentyp: Zeichenfolge
links.fortschritt.url	URL zum Abrufen der Fortschrittsdetails zum Vorgang, der für das Update Set ausgeführt wird. Datentyp: Zeichenfolge
percent_complete	Prozentsatz der Anforderung, die abgeschlossen ist. Datentyp: Zahl
status	Zahl, die den Ausführungsstatus der für den Update-Satz ausgeführten Aktion darstellt. Entspricht dem Deskriptor status_label. Mögliche Werte: 0: Ausstehend 1: Wird ausgeführt 2: Erfolgreich 3: Fehlgeschlagen 4: Abgebrochen Datentyp: Zeichenfolge
status_detail	Detaillierte Meldung zum Ausführungsstatus, falls verfügbar. Entspricht dem Feld „detaillierte_Nachricht“ in der Tabelle „Ausführungstracker“ [sys_execution_tracker]. Datentyp: Zeichenfolge
status_label	Ausführungsstatus der Update-Satz-Aktion. Entspricht der Nummer status. 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 festgelegt 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 die Vorschau eines Update-Satzes an, um den Vorgang auf Konflikte zu prüfen und Informationen zum Fortschritt des Update-Satz-Vorgangs abzurufen

Hinweis:

Wenn das Update Set, das Sie in der Vorschau anzeigen möchten, in der -Instanz nicht vorhanden ist, müssen Sie es zuerst mit dem -Endpunkt CICD-Update-Satz: POST /api/sn_cicd/update_set/retrieve oder manuell in der Anwenderoberfläche abrufen, um das Update Set abzurufen.

URL-Format

URL mit Versionsnummer: /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 im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

Unterstützte Anforderungsparameter

Tabelle : 12. 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
remote_update_set_id	Sys_id des in der Vorschau anzuzeigenden Update Sets. Tabelle: Abgerufene Update-Sätze [sys_remote_update_set] Datentyp: Zeichenfolge

Tabelle : 13. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 14. 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 : 15. 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 : 16. Antwortkopfzeilen

Kopfzeile	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Unterstützte Typen: application/json oder 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 HTTP-Antwortcodes der REST-API.

Tabelle : 17. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Nicht autorisiert. Die Anmeldeinformationen 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. Der Antworttext enthält Informationen zum Fehler.

Parameter des Antworttexts (JSON oder XML)

Name	Beschreibung
Fehler	Fehlermeldung mit Details zum Fehler. Datentyp: Zeichenfolge
Links	Informationen zu allen Links und sys_ids, die dem Update Set zugeordnet sind. Datentyp: Objekt "links": { "progress": {Object} }
links.fortschritt	Fortschrittsinformationen zum Vorgang, der für das Update Set ausgeführt wurde. Datentyp: Objekt "progress": { "id": "String", "url": "String" }
links.progress.id	Sys_id, die Details zum Fortschritt des Vorgangs enthält. Sie können diesen Wert verwenden, wenn Sie den Endpunkt CI/CD – GET /sn_cicd/progress/{progress_id}aufrufen. Datentyp: Zeichenfolge
links.fortschritt.url	URL zum Abrufen der Fortschrittsdetails zum Vorgang, der für das Update Set ausgeführt wird. Datentyp: Zeichenfolge
percent_complete	Prozentsatz der Anforderung, die abgeschlossen ist. Datentyp: Zahl
status	Zahl, die den Ausführungsstatus der für den Update-Satz ausgeführten Aktion darstellt. Entspricht dem Deskriptor status_label. Mögliche Werte: 0: Ausstehend 1: Wird ausgeführt 2: Erfolgreich 3: Fehlgeschlagen 4: Abgebrochen Datentyp: Zeichenfolge
status_detail	Detaillierte Meldung zum Ausführungsstatus, falls verfügbar. Entspricht dem Feld „detaillierte_Nachricht“ in der Tabelle „Ausführungstracker“ [sys_execution_tracker]. Datentyp: Zeichenfolge
status_label	Ausführungsstatus der Update-Satz-Aktion. Entspricht der Nummer status. Mögliche Werte: Abgebrochen Fehlgeschlagen Ausstehend Wird ausgeführt Erfolgreich Datentyp: Zeichenfolge
status_message	Zusätzliche Beschreibung des aktuellen Status der Aktion, falls verfügbar. Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Beispiel zeigt, wie die Vorschau eines Remote-Update Set anhand einer bestimmten ID angezeigt wird.

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 ein Update Set mit einer bestimmten sys_id ausgeführt wurde.

Weitere Informationen dazu, wie sich der Vorgang zum Zurücksetzen auf ein Update Set auswirkt, finden Sie unter Back out an update set.

URL-Format

URL mit Versionsnummer: /api/sn_cicd/{api_version}/update_set/back_out

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

Hinweis:

Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

Unterstützte Anforderungsparameter

Tabelle : 18. 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 : 19. Abfrageparameter

Name	Beschreibung
rollback_installs	Kennzeichnung, die angibt, ob die Batch-Installation, die während des Update-Satz-Commits durchgeführt wurde, zurückgesetzt werden soll. Mögliche Werte: „true“: Setzt die Installation zurück. false: Kein Rollback der Installation. Datentyp: Boolesch Standardwert: wahr
update_set_id	Erforderlich. Sys_id des Update Sets. Tabelle: Update-Sätze [sys_update_set] Datentyp: Zeichenfolge

Tabelle : 20. 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 : 21. 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 : 22. Antwortkopfzeilen

Kopfzeile	Beschreibung
Content-Type	Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder 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 HTTP-Antwortcodes der REST-API.

Tabelle : 23. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
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 mit Details zum Fehler. Datentyp: Zeichenfolge
Links	Informationen zu allen Links und sys_ids, die dem Update Set zugeordnet sind. Datentyp: Objekt "links": { "progress": {Object} }
links.fortschritt	Fortschrittsinformationen zum Vorgang, der für das Update Set ausgeführt wurde. Datentyp: Objekt "progress": { "id": "String", "url": "String" }
links.progress.id	Sys_id, die Details zum Fortschritt des Vorgangs enthält. Sie können diesen Wert verwenden, wenn Sie den Endpunkt CI/CD – GET /sn_cicd/progress/{progress_id}aufrufen. Datentyp: Zeichenfolge
links.fortschritt.url	URL zum Abrufen der Fortschrittsdetails zum Vorgang, der für das Update Set ausgeführt wird. Datentyp: Zeichenfolge
percent_complete	Prozentsatz der Anforderung, die abgeschlossen ist. Datentyp: Zahl
status	Zahl, die den Ausführungsstatus der für den Update-Satz ausgeführten Aktion darstellt. Entspricht dem Deskriptor status_label. Mögliche Werte: 0: Ausstehend 1: Wird ausgeführt 2: Erfolgreich 3: Fehlgeschlagen 4: Abgebrochen Datentyp: Zeichenfolge
status_detail	Detaillierte Meldung zum Ausführungsstatus, falls verfügbar. Entspricht dem Feld „detaillierte_Nachricht“ in der Tabelle „Ausführungstracker“ [sys_execution_tracker]. Datentyp: Zeichenfolge
status_label	Ausführungsstatus der Update-Satz-Aktion. Entspricht der Nummer status. 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 Rollback eines Installationsvorgangs für eine bestimmte Update-sys_id durchgeführt 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}

Legt ein Update Set mit einer bestimmten sys_id fest.

Wenn Sie einen Update-Satz in der Vorschau angezeigt und etwaige Probleme gelöst haben, können Sie mit diesem Endpunkt einen Commit für den Update-Satz ausführen. Durch das Festlegen eines Update Sets werden alle Änderungen an der Instanz übernommen und eine lokale Kopie des Update Sets erstellt, die für jede Änderung ein Update Set enthält. Weitere Informationen zum Bestätigen eines Update Set finden Sie unter Commit an update set.

URL-Format

URL mit Versionsnummer: /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 im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

Unterstützte Anforderungsparameter

Tabelle : 24. 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
remote_update_set_id	Sys_id des zu bestätigenden Update Sets. Hinweis: Mit dem Endpunkt CI/CD – GET /sn_cicd/progress/{progress_id} können Sie die ID des Remote-Update-Satzes abrufen. Tabelle: Abgerufene Update-Sätze [sys_remote_update_set] Datentyp: Zeichenfolge

Tabelle : 25. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 26. Anforderungstextparameter (XML oder JSON)

Name

Beschreibung

„force_commit“

Kennzeichnung, die angibt, ob das Committen des Update Set erzwungen werden soll. Gültige Werte: „wahr“: Erzwingt einen Commit für den Update-Satz, auch wenn Sie ihn noch nicht in der Vorschau angezeigt haben, um auf Konflikte zu prüfen. „falsch“: Erzwingt keinen Commit für den Update-Satz. Sie müssen eine Vorschau des Update Set anzeigen, bevor Sie mit dem Commit fortfahren. Datentyp: Zeichenfolge Standardwert: false

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 : 27. 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 : 28. Antwortkopfzeilen

Kopfzeile	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Unterstützte Typen: application/json oder 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 HTTP-Antwortcodes der REST-API.

Tabelle : 29. Statuscodes

Name	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Die Anmeldeinformationen des Anwenders 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.

Parameter des Antworttexts (JSON oder XML)

Name	Beschreibung
Fehler	Fehlermeldung mit Details zum Fehler. Datentyp: Zeichenfolge
Links	Informationen zu allen Links und sys_ids, die dem Update Set zugeordnet sind. Datentyp: Objekt "links": { "progress": {Object} }
links.fortschritt	Fortschrittsinformationen zum Vorgang, der für das Update Set ausgeführt wurde. Datentyp: Objekt "progress": { "id": "String", "url": "String" }
links.progress.id	Sys_id, die Details zum Fortschritt des Vorgangs enthält. Sie können diesen Wert verwenden, wenn Sie den Endpunkt CI/CD – GET /sn_cicd/progress/{progress_id}aufrufen. Datentyp: Zeichenfolge
links.fortschritt.url	URL zum Abrufen der Fortschrittsdetails zum Vorgang, der für das Update Set ausgeführt wird. Datentyp: Zeichenfolge
percent_complete	Prozentsatz der Anforderung, die abgeschlossen ist. Datentyp: Zahl
status	Zahl, die den Ausführungsstatus der für den Update-Satz ausgeführten Aktion darstellt. Entspricht dem Deskriptor status_label. Mögliche Werte: 0: Ausstehend 1: Wird ausgeführt 2: Erfolgreich 3: Fehlgeschlagen 4: Abgebrochen Datentyp: Zeichenfolge
status_detail	Detaillierte Meldung zum Ausführungsstatus, falls verfügbar. Entspricht dem Feld „detaillierte_Nachricht“ in der Tabelle „Ausführungstracker“ [sys_execution_tracker]. Datentyp: Zeichenfolge
status_label	Ausführungsstatus der Update-Satz-Aktion. Entspricht der Nummer status. 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 festgelegt.

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

URL mit Versionsnummer: /api/sn_cicd/{api_version}/update_set/create

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

Hinweis:

Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

Unterstützte Anforderungsparameter

Tabelle : 30. 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 : 31. Abfrageparameter

Name	Beschreibung
description	Beschreibung des Update Sets. Datentyp: Zeichenfolge Standard: null
scope	Erforderlich, wenn der Parameter sys_id nicht übergeben wird. Der Bereichsname der Anwendung, in der das neue Update Set erstellt werden soll. Tabelle: Anwendungen [sys_scope] Datentyp: Zeichenfolge
sys_id	Erforderlich, wenn der Parameter scope nicht übergeben wird. Sys_id der Anwendung, in der das neue Update Set erstellt werden soll. Tabelle: Anwendungen [sys_scope] Datentyp: Zeichenfolge
update_set_name	Erforderlich. Name für das Update Set. Datentyp: Zeichenfolge

Tabelle : 32. 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 : 33. 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 : 34. Antwortkopfzeilen

Kopfzeile	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Unterstützte Typen: application/json oder 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 HTTP-Antwortcodes der REST-API.

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 Bereich sind NULL oder leer.
403	Unzulässig. Der Benutzer ist kein Administrator und verfügt nicht über die Rolle sn_cicd.sys_ci_automation.
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 mit Details zum Fehler. Datentyp: Zeichenfolge
status	Zahl, die den Ausführungsstatus der für den Update-Satz ausgeführten Aktion darstellt. Entspricht dem Deskriptor status_label. Mögliche Werte: 0: Ausstehend 1: Wird ausgeführt 2: Erfolgreich 3: Fehlgeschlagen 4: Abgebrochen Datentyp: Zeichenfolge
status_detail	Detaillierte Meldung zum Ausführungsstatus, falls verfügbar. Entspricht dem Feld „detaillierte_Nachricht“ in der Tabelle „Ausführungstracker“ [sys_execution_tracker]. Datentyp: Zeichenfolge
status_label	Ausführungsstatus der Update-Satz-Aktion. Entspricht der Nummer status. 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 Sets. Tabelle: Update-Sätze [sys_update_set] Datentyp: Zeichenfolge

cURL-Anforderung

Im folgenden Beispiel wird veranschaulicht, wie Sie ein neues Update Set mit dem Namen Testupdateset erstellen, dessen Umfang auf sn_testfestgelegt ist.

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