CdmChangesetsApi

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 30 Minuten Lesedauer

    • CdmChangesetsApi bietet Endpunkte, mit denen Sie Changesets verwalten können.

    Mit diesen Endpunkten können Sie:
    • Erstellen Sie neue Changesets.
    • Changesets bereitstellen
    • Rufen Sie Listen oder einzelne Changesets ab.
    • Ruft die Knotenänderungen in einem Changeset ab.
    • Rufen Sie eine Liste der Anwendungen oder bereitstellbaren Elemente ab, die von einem Changeset betroffen sind.
    • Löschen Sie Changesets.
    • Geben Sie eine Liste der gemeinsam genutzten Komponenten zurück, die einem angegebenen Changeset zugeordnet sind.

    Die Endpunkte zum Erstellen von Changesets verwenden eine asynchrone Warteschlangenimplementierung. Bei dieser Art der Implementierung rufen Sie zuerst den Endpunkt der Changeset-Anforderung auf. Dieser Endpunkt stellt Ihre Anforderung in die Warteschlange und gibt einen Commit-Bezeichner zurück. Anschließend verwenden Sie diesen Commit-Bezeichner, um den entsprechenden Statusendpunkt aufzurufen und den Status der Erstellungsanforderung zu erhalten.

    Sie müssen eine der folgenden Rollen innehaben, um auf diese API zugreifen zu können:
    • Scripted REST CDM-Ansicht ACL (sn_cdm.cdm.viewer)
    • Scripted REST CDM-Editor-ACL (sn_cdm.cdm_editor)

    Darüber hinaus muss das Plugin Configuration Data Management (CDM) aktiviert sein, damit diese API in einer -Instanz verfügbar ist.

    Weitere Informationen zu Changesets finden Sie unter Changesets und Versionskontrolle in CDM.

    CdmChangesetsApi – DELETE /sn_cdm/changesets

    Löscht ein angegebenes Changeset.

    Der Aufrufer muss über die Rolle „CDM-Editor“ verfügen, um auf diesen Endpunkt zugreifen zu können.

    URL-Format

    Versionierte URL: /api/sn_cdm/{api_version}/changesets

    Standard-URL: /api/sn_cdm/changesets

    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
    changesetNumber Erforderlich.
    Eindeutiger Bezeichner des zugeordneten Changesets, z. B. „Chset-10“. Befindet sich in der Tabelle „CDMChangeset“ [sn_cdm_changeset].

    Datentyp: Zeichenfolge
    Tabelle : 3. Anforderungstextparameter
    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ützt nur 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.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts

    Name Beschreibung
    Keine

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie ein Changeset entfernt wird.

    curl "http://instance.servicenow.com/api/sn_cdm/changesets?changesetNumber=Chset-760" \ 
--request DELETE \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    Bei erfolgreicher Löschung des Changesets wird keine andere Antwort als der HTTP-Statuscode zurückgegeben.

    None - results defined by the HTTP status code

    CdmChangesetsApi – GET /sn_cdm/changesets

    Ruft alle Changesets ab, die einer Configuration Data Management (CDM)-Anwendung oder einem angegebenen Changeset-Datensatz zugeordnet sind.

    URL-Format

    Versionierte URL: /api/sn_cdm/{api_version}/changesets

    Standard-URL: /api/sn_cdm/changesets

    Unterstützte Anforderungsparameter

    Tabelle : 7. 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 : 8. Abfrageparameter
    Name Beschreibung
    appName Erforderlich. Name der CDM-Anwendung, deren Changesets zurückgegeben werden sollen. Dies muss eine aktive Anwendung sein. Befindet sich in der CDM-Anwendungstabelle [sn_cdm_application].

    Datentyp: Zeichenfolge
    Nummer Changeset-Nummer. Befindet sich in der Tabelle „CDMChangeset“ [sn_cdm_changeset].

    Wenn Sie diesen Wert übergeben, wird nur das angegebene Changeset zurückgegeben. Es muss sich um ein Changeset handeln, das der im Parameter appName angegebenen CDM-Anwendung zugeordnet ist.

    Datentyp: Zeichenfolge

    Standard: Keine – gibt alle Changesets zurück, die der CDM-Anwendung zugeordnet sind, oder die durch den Parameter state angegebenen Changesets.
    Status Status der zurückzugebenden Changesets. Geben Sie nur die Changesets zurück, die der angegebenen CDM-Anwendung für den angegebenen Status zugeordnet sind.

    Gültige Werte:

    • Blockiert
    • Überprüfung auf Konflikte
    • Commit fehlgeschlagen
    • Commit wird ausgeführt
    • Committet
    • Offen

    Datentyp: Zeichenfolge

    Standard: Alle Changesets für alle Status zurückgeben
    Tabelle : 9. Anforderungstextparameter
    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 : 10. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 11. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

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

    Tabelle : 12. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts

    Name Beschreibung
    auto_validate Kennzeichnung, die angibt, ob die beim Commit erstellten Changesets validiert werden.
    Gültige Werte:
    • true: Validiert die Changesets.
    • false: Changesets nicht validieren.

    Datentyp: Boolesch
    cdm_application Details der CDM-Anwendung, die dem Changeset zugeordnet ist.

    Datentyp: Objekt

    "cdm_application": {
  "link": "String",
  "value": "String"
}
    cdm_application.link Abfrage, die zum Aufrufen des Tabellen -REST-Endpunkts verwendet werden soll, um die zugeordnete CDM-Anwendung abzurufen.

    Datentyp: Zeichenfolge
    cdm_application.value Sys_id der zugeordneten CDM-Anwendung. Befindet sich in der CDM-Anwendungstabelle [sn_cdm_application].

    Datentyp: Zeichenfolge
    commited_at Datum und Uhrzeit der letzten Übermittlung des Changesets.

    Datentyp: Zeichenfolge

    Format: JJJJ-mm-TT hh:mm:ss
    commited_by Details zum Benutzer, der das Changeset bestätigt hat.

    Datentyp: Objekt

    "committed_by": {
  "link": "String",
  "value": "String"
}
    commited_by.link Aufruf, um den Datensatz des Benutzers abzurufen, der das Changeset mithilfe der REST- Tabellen -API festgeschrieben hat.

    Datentyp: Zeichenfolge
    commited_by.value Sys_id des Benutzers, der das Changeset bestätigt hat.

    Datentyp: Zeichenfolge
    Beschreibung Kurze Beschreibung des Zwecks des Changesets.

    Datentyp: Zeichenfolge
    Fehler Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    Fehler.Detail Zusätzliche Informationen zum Fehler.

    Datentyp: Zeichenfolge
    Fehler.Nachricht Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde.

    Datentyp: Zeichenfolge
    last_conflict_detection_time Zeit seit der Ausführung der letzten Konflikterkennung. Die Konflikterkennung wird durchgeführt, wenn ein Changeset festgeschrieben wird.

    Datentyp: Zahl

    Einheit: Millisekunden
    last_updated Datum und Uhrzeit der Änderung der zugehörigen Konfigurationsdaten durch dieses Changeset.

    Format: JJJJ-mm-TT hh:mm:ss

    Datentyp: Zeichenfolge
    Nummer Eindeutige Changeset-Nummer.

    Datentyp: Zeichenfolge
    publish_option
    Veröffentlichungsoption für die zugeordneten konfigurierten Snapshots.
    Gültige Werte:
    • veröffentlichen_none: Keine Snapshots veröffentlichen.
    • veröffentlichen_valid: Veröffentlichen Sie nur die Snapshots, die die Validierung nach dem Commit bestehen.

    Weitere Informationen zum Veröffentlichen von Snapshots finden Sie unter Snapshots veröffentlichen oder Veröffentlichung aufheben.

    Datentyp: Zeichenfolge

    Standard: veröffentlichen_none
    Status Aktueller Status des Changesets.

    Mögliche Werte:

    • Blockiert
    • Überprüfung auf Konflikte
    • Commit fehlgeschlagen
    • Commit wird ausgeführt
    • Committet
    • Offen

    Datentyp: Zeichenfolge
    sys_created_by Benutzername des Benutzers, der das Changeset erstellt hat. Beispiel: able.tuter.

    Datentyp: Zeichenfolge
    sys_created_on Datum und Uhrzeit der Erstellung des Changesets.

    Format: JJJJ-mm-TT hh:mm:ss

    Datentyp: Zeichenfolge
    sys_id Sys_id des Changesets. Befindet sich in der Tabelle „CDMChangeset“ [sn_cdm_changeset].

    Datentyp: Zeichenfolge
    sys_updated_by Benutzername des Benutzers, der das Changeset zuletzt aktualisiert hat. Beispiel: able.tuter.

    Datentyp: Zeichenfolge
    sys_updated_on Datum und Uhrzeit der letzten Aktualisierung des Changesets.

    Format: JJJJ-mm-TT hh:mm:ss

    Datentyp: Zeichenfolge
    Titel Titel des Changesets.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Dieses Codebeispiel zeigt, wie ein bestimmtes Changeset abgerufen wird.

    curl "http://instance.servicenow.com/api/sn_cdm/changesets?appName=testApp&changesetNumber=Chset-946&state=committed" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    Ergebnisse zurückgeben:

    { 
  "result": [ 
    { 
      "description": "Auto generated for deletion of CDM Deployable Dep-12022-06-29 13:09:46", 
      "cdm_application": { 
        "value": "62b517a953b70110a1d3ddeeff7b128c", 
        "link": "http://instance.servicenow.com/api/now/table/sn_cdm_application/62b517a953b70110a1d3ddeeff7b128c" 
      }, 
      "sys_updated_on": "2022-06-29 13:09:47", 
      "title": "Auto generated for deletion of CDM Deployable Dep-12022-06-29 13:09:46", 
      "number": "Chset-946", 
      "sys_id": "955d6c0f53141110a1d3ddeeff7b1233", 
      "sys_updated_by": "admin", 
      "committed_at": "2022-06-29 13:09:46", 
      "sys_created_on": "2022-06-29 13:09:46", 
      "committed_by": { 
        "value": "6816f79cc0a8016401c5a33be04be441", 
        "link": "http://instance.servicenow.com/api/now/table/sys_user/6816f79cc0a8016401c5a33be04be441" 
      }, 
      "state": "committed", 
      "auto_validate": true, 
      "publish_option": "publish_none", 
      "last_conflict_detection_time": "1656508187450", 
      "sys_created_by": "admin", 
      "last_updated": "2022-06-29 13:09:46" 
    } 
  ] 
}

    CdmChangesetsApi – GET /sn_cdm/changesets/activity

    Ruft die Knotenänderungen in einem angegebenen Changeset ab.

    URL-Format

    Versionierte URL: /api/sn_cdm/{api_version}/changesets/activity

    Standard-URL: /api/sn_cdm/changesets/activity

    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
    Tabelle : 14. Abfrageparameter
    Name Beschreibung
    changesetNumber Erforderlich.
    Eindeutiger Bezeichner des zugeordneten Changesets, z. B. „Chset-10“. Befindet sich in der Tabelle „CDMChangeset“ [sn_cdm_changeset].

    Datentyp: Zeichenfolge
    returnFields Liste der Felder, die als Teil der Antwort zurückgegeben werden sollen. Übergeben Sie die Datensatzspaltennamen wie sys_id, sys_updated_by oder state.

    Datentyp: Array

    Standard: Alle Felder, wie vom Endpunkt bestimmt
    Tabelle : 15. Anforderungstextparameter
    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ützt nur 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.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts

    Name Beschreibung
    changeset_id Details des angeforderten Changesets.

    Datentyp: Objekt

    "changeset_id": {
  "link": "String",
  "value": "String"
}
    changeset_id.link Abfrage, die zum Aufrufen des Tabellen -REST-Endpunkts verwendet werden soll, um das zugeordnete Changeset abzurufen.

    Datentyp: Zeichenfolge
    changeset_id.value Sys_id des zugeordneten Changesets. Befindet sich in der Tabelle „CDM-Änderungssatz“ [sn_cdm_changeset].

    Datentyp: Zeichenfolge
    Konflikt Kennzeichnung, die angibt, ob im zugeordneten Changeset ein Konflikt vorliegt.
    Gültige Werte:
    • true: Konflikt erkannt.
    • false: Kein Konflikt gefunden.

    Datentyp: Boolesch
    erstellt Datum und Uhrzeit der Erstellung des Knotens.

    Format: JJJJ-mm-TT hh:mm:ss

    Datentyp: Zeichenfolge
    created_by Benutzername des Benutzers, der den Knoten erstellt. Beispiel: able.tuter.

    Datentyp: Zeichenfolge
    Fehler Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    Fehler.Detail Zusätzliche Informationen zum Fehler.

    Datentyp: Zeichenfolge
    Fehler.Nachricht Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde.

    Datentyp: Zeichenfolge
    name_path Knotenpfadname.

    Datentyp: Zeichenfolge
    new_name Aktueller Name des Knotens.

    Datentyp: Zeichenfolge
    new_value Aktueller Wert des Knotens. Für Blattknoten und Array-Literale.

    Datentyp: Zeichenfolge
    old_name Vorheriger Name des Knotens.

    Datentyp: Zeichenfolge
    old_value Vorheriger Wert des Knotens. Für Blattknoten und Array-Literale.

    Datentyp: Zeichenfolge
    aktualisiert Datum und Uhrzeit der letzten Aktualisierung des Knotens.

    Format: JJJJ-mm-TT hh:mm:ss

    Datentyp: Zeichenfolge
    update_by Benutzername des Benutzers, der den Knoten zuletzt aktualisiert hat. Beispiel: able.tuter.

    Datentyp: Zeichenfolge
    sicher Kennzeichnung, die angibt, ob der zugeordnete Blattknoten gesichert wurde.
    Gültige Werte:
    • true: Knoten wurde gesichert.
    • false: Knoten wurde nicht gesichert.

    Datentyp: Boolesch
    type
    Knotentyp
    Mögliche Werte:
    • sn_cdm_node_collection
    • sn_cdm_node_component
    • sn_cdm_node_folder
    • sn_cdm_node_cdi
    • sn_cdm_node_variable

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Dieses Codebeispiel zeigt, wie die Knotenänderungen für ein bestimmtes Changeset abgerufen werden.

    curl "http://instance.servicenow.com/api/sn_cdm/changesets/activity?changesetNumber=Chset-783" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    Ergebnisse zurückgeben:

    { 
  "result": [ 
    { 
      "sys_id": "ed5d6c0f53141110a1d3ddeeff7b1233", 
      "changeset_id": "955d6c0f53141110a1d3ddeeff7b1233", 
      "new_value": null, 
      "new_state": "Deleted", 
      "new_name": "Dep-1", 
      "new_type": "Deployable", 
      "new_encrypted": false, 
      "updated_on": "2022-06-29 13:09:46", 
      "updated_by": "admin", 
      "resolution_method": "", 
      "conflict": null, 
      "path": "deployables/Dep-1", 
      "created_by": null, 
      "created_on": null, 
      "old_value": null, 
      "old_state": "Superseded", 
      "old_name": "Dep-1", 
      "old_type": "Deployable", 
      "old_encrypted": false 
    } 
] 
}

    CdmChangesetsApi – GET /sn_cdm/changesets/commit-status/{commit_id}

    Gibt den aktuellen Status der angegebenen Changeset-Commit-Anforderung zurück.

    URL-Format

    Versionierte URL: /api/sn_cdm/{api_version}/changesets/commit-status/{commit_id}

    Standard-URL: /api/sn_cdm/changesets/commit-status/{commit_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
    commit_id Sys_id für die Commit-Anforderung, deren Status zurückgegeben werden soll. Dieser Wert wird vom Endpunkt CdmChangesetsApi – POST /sn_cdm/changesets/{changeset_id}/commit zurückgegeben.
    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ützt nur 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.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts

    Name Beschreibung
    Commit_id sys_id des Commit-Anforderungsdatensatzes. Identisch mit dem, der an den Endpunkt übergeben wurde.

    Datentyp: Zeichenfolge
    Fehler Beschreibung der Fehler, die beim Upload aufgetreten sind.

    Datentyp: Zeichenfolge
    Ausgabe Beschreibung der hochgeladenen Daten oder, wenn während des Uploads ein Fehler aufgetreten ist, eine Fehlermeldung, die den aufgetretenen Fehler beschreibt.

    Datentyp: Objekt

    "output": {
  "auto_validate": "String",
  "cdm_application": "String",
  "committed_at": "String",
  "committed_by": "String",
  "description": "String",
  "last_conflict_detection_time": "String",
  "number": "String",
  "publish_option": "String",
  "snapshot_description": "String",
  "snapshot_name": "String",
  "state": "String",
  "sys_created_by": "String",
  "sys_id": "String",
  "title": "String"
}
    Ausgabe.auto_validieren Gibt an, ob die Validierung nach dem Commit aufgerufen werden soll.

    Datentyp: Zeichenfolge
    Ausgabe.cdm_application Name der Anwendung, unter der der Upload durchgeführt wurde.

    Datentyp: Zeichenfolge
    Ausgabe.committed_at Datum und Uhrzeit, zu der der hochgeladene Inhalt bestätigt wurde.

    Datentyp: Zeichenfolge
    Ausgabe.committed_by Sys_id des Datensatzes der Entität, die den Commit ausgeführt hat.

    Datentyp: Zeichenfolge
    Ausgabe.Beschreibung Derzeit nicht verwendet.

    Datentyp: Zeichenfolge
    Ausgabe.last_conflict_detection_time Datum und Uhrzeit des Aufrufs der Konflikterkennung.

    Datentyp: Zeichenfolge
    Ausgabe.Nummer Eindeutige Nummer des Changesets.

    Datentyp: Zeichenfolge
    Ausgabe.veröffentlichen_option
    Veröffentlichungsoption für die zugeordneten konfigurierten Snapshots.
    Gültige Werte:
    • veröffentlichen_none: Keine Snapshots veröffentlichen.
    • veröffentlichen_valid: Veröffentlichen Sie nur die Snapshots, die die Validierung nach dem Commit bestehen.

    Weitere Informationen zum Veröffentlichen von Snapshots finden Sie unter Snapshots veröffentlichen oder Veröffentlichung aufheben.

    Datentyp: Zeichenfolge

    Standard: veröffentlichen_none
    Ausgabe.snapshot_description Beschreibung des zugeordneten Snapshots.

    Datentyp: Zeichenfolge
    Ausgabe.snapshot_name Name des zugeordneten Snapshots.

    Datentyp: Zeichenfolge
    Ausgabe.Status Status des Upload-Inhalts.
    Mögliche Werte:
    • committet
    • abgeschlossen
    • Fehler
    • in_progress
    • neu
    • Bereit

    Datentyp: Zeichenfolge
    Ausgabe.sys_created_by Sys_id der Entität, die den Datensatz erstellt hat.

    Datentyp: Zeichenfolge
    Ausgabe.sys_id Sys_id des Datensatzes, der das Changeset enthält.

    Datentyp: Zeichenfolge
    Ausgabe.Titel Titel des Changesets, das als Teil des Uploads erstellt wurde.

    Datentyp: Zeichenfolge
    processing_state Aktueller Verarbeitungsstatus der Commit-Anforderung.
    Mögliche Werte:
    • NOT_PROCREED
    • VERARBEITET

    Datentyp: Zeichenfolge
    request_id Anforderungs-ID Identisch mit dem, der an den Endpunkt und commit_idübergeben wurde.

    Datentyp: Zeichenfolge
    Status Aktueller Status des angegebenen Commits. Wert aus der Statusspalte in der Tabelle „CDM-Anforderungswarteschlange“ [sn_cdm_request_queue].
    Mögliche Werte:
    • abgeschlossen
    • Fehler
    • in_progress
    • neu
    • Bereit

    Datentyp: Zeichenfolge
    type Typ der Anforderung.
    Mögliche Werte:
    • Commit
    • export
    • „upload_and_commit“

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie dieser Endpunkt aufgerufen wird, um den Status des angegebenen Commits zu erhalten.

    curl "http://instance.servicenow.com/api/sn_cdm/changesets/commit-status/bf506e69537c3010a1d3ddeeff7b12c0"\ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    Im Folgenden finden Sie Beispiele für eine Erfolgs- und Fehlerantwort.

    
// Successful response 

{ 
  "result": { 
    "type": "commit", 
    "state": "completed", 
    "output": { 
      "sys_id": "4a4407e953124110da35ddeeff7b1235", 
      "number": "Chset-1207", 
      "title": "admin064407e953124110da35ddeeff7b1235", 
      "description": "A description of my changeset provided during creation", 
      "committed_at": "2022-03-17 22:19:33", 
      "committed_by": "6816f79cc0a8016401c5a33be04be441", 
      "sys_created_by": "admin", 
      "state": "committed", 
      "publish_option": "publish_none", 
      "auto_validate": false, 
      "snapshot_name": null, 
      "snapshot_description": null, 
      "cdm_application": "DemoApp", 
      "last_conflict_detection_time": null 
    }, 
    "processing_state": "PROCESSED", 
    "commit_id": "9cd583e953124110da35ddeeff7b128a" 
  } 
} 

 

// Example of an error response 

{ 
  "result": { 
    "state": "error", 
    "errors": "Invalid requestId '9cd583e953124110da35ddeeff7b128'", 
    "commit_id": "9cd583e953124110da35ddeeff7b128" 
  } 
}

    CdmChangesetsApi – GET /sn_cdm/changesets/impacted-deployables

    Gibt die Liste der bereitstellbaren Elemente zurück, die einem angegebenen Changeset zugeordnet sind.

    Für den Zugriff auf diesen Endpunkt ist die Rolle „CDM-Betrachter“ erforderlich.

    URL-Format

    Versionierte URL: /api/sn_cdm/{api_version}/changesets/impacted-deployables

    Standard-URL: /api/sn_cdm/changesets/impacted-deployables

    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
    changesetNumber Erforderlich.
    Eindeutiger Bezeichner des zugeordneten Changesets, z. B. „Chset-10“. Befindet sich in der Tabelle „CDMChangeset“ [sn_cdm_changeset].

    Datentyp: Zeichenfolge
    returnFields Liste der Felder, die als Teil der Antwort zurückgegeben werden sollen. Übergeben Sie die Datensatzspaltennamen wie sys_id, sys_updated_by oder state.

    Datentyp: Array

    Standard: Alle Felder, wie vom Endpunkt bestimmt
    Tabelle : 27. Anforderungstextparameter
    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 : 28. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur 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.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts

    Name Beschreibung
    cdi_count Anzahl der Konfigurationsdatenelemente (CDIs), die in der zugeordneten CDM-Anwendung enthalten sind.

    Datentyp: Ganzzahl
    cdi_usage Prozentsatz der vom bereitstellbaren Element verwendeten CDIs.

    Datentyp: Ganzzahl
    cdm_app CDM-Anwendungsobjekt, das dem bereitstellbaren Element zugeordnet ist.

    Datentyp: Objekt

    "cdm_app": {
  "link": "String",
  "value": "String"
}
    cdm_app.link Rufen Sie auf, um mithilfe der REST- Tabellen -API auf den CDM-Anwendungsdatensatz zuzugreifen.

    Datentyp: Zeichenfolge
    cdm_app.value Sys_id des zugeordneten CDM-Anwendungsdatensatzes. Befindet sich in der CDM-Anwendungstabelle [sn_cdm_application].

    Datentyp: Zeichenfolge
    cdm_ci Anwendungsserviceobjekt, das dem bereitstellbaren Element zugeordnet ist.

    Datentyp: Objekt

    "cdm_ci": {
  "link": "String",
  "value": "String"
}
    cdm_ci.link Rufen Sie auf, um mithilfe der REST- Tabellen -API auf den Anwendungsservice-Datensatz zuzugreifen.

    Datentyp: Zeichenfolge
    cdm_ci.value Sys_id des zugeordneten Anwendungsservice-Datensatzes. Befindet sich in der Tabelle „Konfigurationselement“ [cmdb_ci].

    Datentyp: Zeichenfolge
    Beschreibung Beschreibung des generierten bereitstellbaren CDM.

    Datentyp: Zeichenfolge
    umgebungstyp Umgebungstyp des bereitstellbaren Elements
    Mögliche Werte:
    • Entwicklung
    • Produktion
    • Test

    Datentyp: Zeichenfolge
    Fehler Wird nur zurückgegeben, wenn während der Verarbeitung ein Fehler aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    Fehler.Detail Zusätzliche Informationen zum Fehler.

    Datentyp: Zeichenfolge
    Fehler.Nachricht Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde.

    Datentyp: Zeichenfolge
    Name Name des bereitstellbaren CDM.

    Datentyp: Zeichenfolge
    Knoten Details zum bereitstellbaren Knoten.

    Datentyp: Objekt

    "node": {
  "link": "String",
  "value": "String"
}
    node.link Rufen Sie auf, um mithilfe der REST- Tabellen -API auf den Datensatz des bereitstellbaren Knotens zuzugreifen.

    Datentyp: Zeichenfolge
    node.value Sys_id des Datensatzes des bereitstellbaren Knotens. Befindet sich in der Tabelle „Bereitstellbares CDM“ [sn_cdm_deployable].

    Datentyp: Zeichenfolge
    snapshot_version_counter Anzahl der für das bereitstellbare Element erstellten Snapshots.

    Datentyp: Ganzzahl
    Status Aktueller Status des bereitstellbaren Elements.
    Mögliche Werte:
    • aktiv
    • gelöscht

    Datentyp: Zeichenfolge
    sys_created_by Benutzername des Benutzers, der das bereitstellbare CDM erstellt hat. Beispiel: able.tuter.

    Datentyp: Zeichenfolge
    sys_created_on Datum und Uhrzeit der Erstellung des bereitstellbaren CDM-Elements.

    Format: JJJJ-mm-TT hh:mm:ss

    Datentyp: Zeichenfolge
    sys_id Sys_id des erstellten bereitstellbaren Elements. Befindet sich in der Tabelle „Bereitstellbares CDM“ [sn_cdm_deployable].

    Datentyp: Zeichenfolge
    sys_updated_by Benutzername des Benutzers, der das bereitstellbare CDM zuletzt aktualisiert hat. Beispiel: able.tuter.

    Datentyp: Zeichenfolge
    sys_updated_on Datum und Uhrzeit der letzten Aktualisierung des bereitstellbaren CDM.

    Format: JJJJ-mm-TT hh:mm:ss

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie die betroffenen bereitstellbaren Elemente für ein angegebenes Changeset abgerufen werden.

    curl "http://instance.servicenow.com/api/sn_cdm/changesets/impacted-deployables?changesetNumber=Chset-783" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    Ergebnisse zurückgeben:

    { 
  "result": [ 
    { 
      "cmdb_ci": { 
        "value": "75c5d7a953b70110a1d3ddeeff7b12a2", 
        "link": "http://instance.servicenow.com/api/now/table/cmdb_ci_service_auto/75c5d7a953b70110a1d3ddeeff7b12a2" 
      }, 
      "cdi_count": "2", 
      "snapshot_version_counter": "3", 
      "description": null, 
      "sys_updated_on": "2022-06-29 16:19:05", 
      "environment_type": "Development", 
      "node": { 
        "value": "a1c517a953b70110a1d3ddeeff7b129b", 
        "link": "http://instance.servicenow.com/api/now/table/sn_cdm_node/a1c517a953b70110a1d3ddeeff7b129b" 
      }, 
      "sys_id": "6dc517a953b70110a1d3ddeeff7b129b", 
      "sys_updated_by": "admin", 
      "cdm_app": { 
        "value": "62b517a953b70110a1d3ddeeff7b128c", 
        "link": "http://instance.servicenow.com/api/now/table/sn_cdm_application/62b517a953b70110a1d3ddeeff7b128c" 
      }, 
      "sys_created_on": "2022-05-31 13:03:23", 
      "cdi_usage": "0.02", 
      "name": "Development_1", 
      "state": "active", 
      "sys_created_by": "admin" 
    } 
  ] 
}

    CdmChangesetsApi – GET /sn_cdm/changesets/impacted-shared-components

    Gibt eine Liste der gemeinsam genutzten Komponenten zurück, die einem angegebenen Changeset zugeordnet sind.

    Für den Zugriff auf diesen Endpunkt ist die Rolle „CDM-Betrachter“ erforderlich.

    URL-Format

    Versionierte URL: /api/sn_cdm/{api_version}/changesets/impacted-shared-components

    Standard-URL: /api/sn_cdm/changesets/impacted-shared-components

    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
    Tabelle : 32. Abfrageparameter
    Name Beschreibung
    changesetNumber Erforderlich.
    Eindeutiger Bezeichner des zugeordneten Changesets, z. B. „Chset-10“. Befindet sich in der Tabelle „CDMChangeset“ [sn_cdm_changeset].

    Datentyp: Zeichenfolge
    returnFields Liste der Felder, die als Teil der Antwort zurückgegeben werden sollen. Übergeben Sie die Datensatzspaltennamen wie sys_id, sys_updated_by oder state.

    Datentyp: Array

    Standard: Alle Felder, wie vom Endpunkt bestimmt
    Tabelle : 33. Anforderungstextparameter
    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ützt nur 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.
    400 Ungültige Anforderung. Das übergebene Changeset ist nicht vorhanden.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts

    Name Beschreibung
    cdm_shared__library Sys_id der gemeinsam genutzten Bibliothek, unter der sich die Komponente befindet.

    Datentyp: Zeichenfolge
    Beschreibung Beschreibung der gemeinsam genutzten CDM-Komponente.

    Datentyp: Zeichenfolge
    Fehler Wird nur zurückgegeben, wenn während der Verarbeitung ein Fehler aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    Fehler.Detail Details zum aufgetretenen Fehler.

    Datentyp: Zeichenfolge
    Fehler.Nachricht Meldung, die eine Übersicht über den Fehler bietet.

    Datentyp: Zeichenfolge
    Name Name der gemeinsam genutzten CDM-Komponente.

    Datentyp: Zeichenfolge
    Knoten Sys_id des gemeinsam genutzten Komponentenknotens. Befindet sich in der Tabelle „CDM-Knoten“ [sn_cdm_node].

    Datentyp: Zeichenfolge
    node_main Sys_id der main_id des Knotendatensatzes der gemeinsam genutzten Komponente. Befindet sich in der Tabelle „CDM-Hauptknoten“ [sn_cdm_node_main].

    Datentyp: Zeichenfolge
    Status Aktueller Status der gemeinsam genutzten Komponente.
    Mögliche Werte:
    • aktiv
    • gelöscht

    Datentyp: Zeichenfolge
    sys_created_by Benutzername des Benutzers, der die gemeinsam genutzte CDM-Komponente erstellt. Beispiel: able.tuter.

    Datentyp: Zeichenfolge
    sys_created_on Datum und Uhrzeit der Erstellung der gemeinsam genutzten CDM-Komponente.

    Format: JJJJ-mm-TT hh:mm:ss

    Datentyp: Zeichenfolge
    sys_id Sys_id der gemeinsam genutzten Komponente. Befindet sich in der Tabelle „Gemeinsam genutzte CDM-Komponente“ [sn_cdm_shared_component].

    Datentyp: Zeichenfolge
    sys_updated_by Benutzername des Benutzers, der die gemeinsam genutzte CDM-Komponente zuletzt aktualisiert hat. Beispiel: able.tuter.

    Datentyp: Zeichenfolge
    sys_updated_on Datum und Uhrzeit der letzten Aktualisierung der gemeinsam genutzten CDM-Komponente.

    Format: JJJJ-mm-TT hh:mm:ss

    Datentyp: Zeichenfolge
    version_counter Anzahl der für die gemeinsam genutzte Komponente erstellten Versionen.

    Datentyp: Ganzzahl

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie die betroffenen gemeinsam genutzten Komponenten für das Changeset = „Chset-20“ abgerufen werden.

    curl "https://instance.servicenow.com/sn_cdm/changesets/impacted-shared-components?changesetNumber=Chset-20" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    Antwort:

    {
  "result": [
    {
      "version_counter": "1",
      "description": null,
      "cdm_shared_library": "acb905e097b3991052687b890353afcd",
      "sys_updated_on": "2022-12-12 20:28:49",
      "node": "3cb945e097b3991052687b890353af0d",
      "sys_id": "34b945e097b3991052687b890353af20",
      "sys_updated_by": "john.jones",
      "node_main": "74b945e097b3991052687b890353af0d",
      "sys_created_on": "2022-12-12 20:28:39",
      "name": "logonService-V2.1",
      "state": "active",
      "sys_created_by": "john.jones"
    },
    {
      "version_counter": "1",
      "description": null,
      "cdm_shared_library": "acb905e097b3991052687b890353afcd",
      "sys_updated_on": "2022-12-12 20:28:49",
      "node": "b0b945e097b3991052687b890353af11",
      "sys_id": "30b945e097b3991052687b890353af21",
      "sys_updated_by": "john.jones",
      "node_main": "f8b945e097b3991052687b890353af10",
      "sys_created_on": "2022-12-12 20:28:39",
      "name": "logonService-V2.2",
      "state": "active",
      "sys_created_by": "john.jones"
    },
    {
      "version_counter": "1",
      "description": null,
      "cdm_shared_library": "acb905e097b3991052687b890353afcd",
      "sys_updated_on": "2022-12-12 20:28:49",
      "node": "6cb905e097b3991052687b890353afd3",
      "sys_id": "b4b945e097b3991052687b890353af21",
      "sys_updated_by": "john.jones",
      "node_main": "a4b905e097b3991052687b890353afd3",
      "sys_created_on": "2022-12-12 20:28:39",
      "name": "paymentService-V1.0",
      "state": "active",
      "sys_created_by": "john.jones"
    },
    {
      "version_counter": "1",
      "description": null,
      "cdm_shared_library": "acb905e097b3991052687b890353afcd",
      "sys_updated_on": "2022-12-12 20:28:49",
      "node": "e0b905e097b3991052687b890353aff1",
      "sys_id": "3cb945e097b3991052687b890353af21",
      "sys_updated_by": "john.jones",
      "node_main": "2cb905e097b3991052687b890353aff0",
      "sys_created_on": "2022-12-12 20:28:39",
      "name": "paymentService-V1.1",
      "state": "active",
      "sys_created_by": "john.jones"
    }
  ]
}

    CdmChangesetsApi – GET /sn_cdm/changesets/{changeset_id}/impacted-deployables

    Gibt die Liste der bereitstellbaren Elemente zurück, die einem angegebenen Changeset zugeordnet sind.

    URL-Format

    Versionierte URL: /api/sn_cdm/{api_version}/changesets/{changeset_id}/impacted-deployables

    Standard-URL: /api/sn_cdm/changesets/{changeset_id}/impacted-deployables

    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
    changeset_id Sys_id des zu verarbeitenden Changeset-Datensatzes. Befindet sich in der Tabelle „CDM-Änderungssatz“ [sn_cdm_changeset].

    Datentyp: Zeichenfolge
    Tabelle : 38. Abfrageparameter
    Name Beschreibung
    Keine
    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ützt nur 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.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts

    Name Beschreibung
    changeset_id Sys_id des letzten Changesets, das dem bereitstellbaren Knoten zugeordnet ist.

    Datentyp: Zeichenfolge
    Konflikt

    Kennzeichnung, die angibt, ob das zugeordnete bereitstellbare Element in Konflikt steht.

    Gültige Werte:
    • 0: Kein Konflikt.
    • 1: Konflikt – Weitere Informationen finden Sie im Rückgabeergebnis conflict_type.

    Datentyp: Zahl
    konflikttyp Typ des bereitstellbaren Konflikts.
    Mögliche Werte:
    • beschädigter_Knoten
    • delete_node
    • „duplicated_node“.
    • unvollständig_gelöscht_übergeordnet
    • unvollständig_gelöscht_ref
    • incomplete_renamed_ref
    • ungültig_include
    • verwaiste_descendant
    • related_conflict
    • unlinked_include
    • unnamed_include
    • update_node

    Datentyp: Zeichenfolge
    Beschreibung Beschreibung des bereitstellbaren Knotens.

    Datentyp: Zeichenfolge
    effektiv_von Zeitstempel, der angibt, wann der Knoten gültig ist. Dieser Wert ist null, bis Sie ein Changeset festlegen, in dem der Knoten erstellt wurde.

    Datentyp: Zahl
    effektiv_zu Zeitstempel, ab dem der Knoten nicht mehr gültig ist. Wenn dieser Wert nullist, bleibt der Knoten solange aktiv, bis er durch eine neue Version ersetzt wird.

    Datentyp: Zahl
    Fehler Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    Fehler.Detail Zusätzliche Informationen zum Fehler.

    Datentyp: Zeichenfolge
    Fehler.Nachricht Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde.

    Datentyp: Zeichenfolge
    level Tiefe des Knotens ausgehend von der Anwendungsebene, die 0 ist.

    Datentyp: Zahl
    linked_to ID des Referenzknotens in einer Sammlung und Komponente.

    Das folgende Knotenfragment zeigt beispielsweise eine Verknüpfung zwischen der Sammlung collA und der Komponente CompA. In diesem Beispiel ist der Wert linkedTo1:

    { 
components : {compA:{} //MainId: 1}, 

Collections : { collA : {  
   compA :{} //Include, linkedTo: 1 
    } 
  } 
}

    Datentyp: Zeichenfolge
    main_id Eindeutiger Identifier des bereitstellbaren Knotens. Dieser Wert wird beim Erstellen des Knotens generiert und zum Identifizieren des bereitstellbaren Knotens verwendet.

    Datentyp: Zahl
    main_id_encoded Codierter Wert der mainId -Rückgabeergebnisse unter Verwendung der 57-Zeichenfolgen-Darstellung.

    Datentyp: Zeichenfolge
    Name Name des bereitstellbaren Elements.

    Datentyp: Zeichenfolge
    node_classifier Knotenklassifizierung, z. B. Entwicklung, Produktion oder Test.

    Im Format:

    • /application/deployables/env: Development
    • /application/deployables/env:Production
    • /application/deployables/env:Test

    Datentyp: Zeichenfolge
    position Position des bereitstellbaren Knotens. Gilt nur für Arrays.

    Beispiel für das Array:

    node1:{
  arrayNode: [{}, "literal1", "literal2", []] }

    {} ist Position 1000,

    „literal1“ ist Position 2000,

    „literal2“ ist Position 3000,

    [] ist Position 4000

    Datentyp: Zahl
    previous_version Sys_id der vorherigen Version des zugeordneten bereitstellbaren Knotens.

    Datentyp: Zeichenfolge
    eingeschränkt_zu Liste der sys_ids der Benutzer, die auf den zugeordneten bereitstellbaren Knoten zugreifen dürfen. Diese Informationen stammen aus der Tabelle „CDM – eingeschränkte Gruppen“ [sn_cdm_restricted_groups]. Dieser Wert ist null, wenn alle Gruppen auf das bereitstellbare Element zugreifen können.

    Datentyp: Zeichenfolge
    Secure_value Sicherer Wert der CDI oder Variablen. Wird nur für Blattknoten und Array-Literale zurückgegeben. Dies ist identisch mit dem Rückgabeergebnis value, ist jedoch verschlüsselt.

    Datentyp: Zeichenfolge
    status Status des bereitstellbaren Knotens oder Status einer fehlgeschlagenen Anforderung.
    Mögliche Werte:
    • gelöscht
    • Fehler (wird übergeben, wenn der Endpunktaufruf fehlschlägt.)
    • neu
    • ersetzt
    • aktualisiert
    • gültig

    Datentyp: Zeichenfolge
    system_folder

    Kennzeichnung, die angibt, ob der zugeordnete Ordner ein Systemordner ist.

    Gültige Werte:
    • 0: Kein Systemordner.
    • 1: Systemordner.

    Datentyp: Zahl
    sys_id Sys_id des betroffenen bereitstellbaren Elements.

    Datentyp: Zeichenfolge
    type Knotentyp, z. B. sn_cdm_node_deployable. Mit diesem Wert können Sie bestimmen, ob der Knoten eine Komponente, ein Konfigurationsdatenelement (CDI) oder ein bereitstellbares Element ist. Dieser Wert wird generiert, wenn der Knoten erstellt wird.

    Datentyp: Zeichenfolge
    Wert Wert der CDI oder Variablen. Wird nur für Blattknoten und Array-Literale zurückgegeben. Wenn diese Informationen verschlüsselt sind, werden sie im Rückgabeergebnis secure_value zurückgegeben.

    Wenn dieser Knoten beispielsweise der CDI -Knoten A:{cdi1: 1}ist, lautet das Rückgabeergebnis value1. Wenn es sich um einen Array-Knoten wie node1: {arrayNode: [{}, "literal1", "literal2", []]}handelt, lautet das Rückgabeergebnis value von [].

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie die bereitstellbaren Elemente angefordert werden, die dem Changeset zugeordnet sind, dessen sys_id bf506e69537c3010a1d3ddeeff7b12c0 lautet.

    curl "http://instance.servicenow.com/api/sn_cdm/changesets/bf506e69537c3010a1d3ddeeff7b12c0/impacted-deployables"\ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    Das Folgende zeigt sowohl eine erfolgreiche als auch eine Fehlerantwort für diesen Endpunkt.

    // Successful response
{
  "result": [
    {
      "sys_id": "833527a953924110da35ddeeff7b12c1",
      "type": "sn_cdm_node_deployable",
      "main_id": "150",
      "main_id_encoded": "&M",
      "node_path": "!&@!&D!&M",
      "level": 2,
      "status": "valid",
      "node_classifier": "/application/deployables/env:Development",
      "position": null,
      "restricted_to": null,
      "changeset_id": "cb3527a953924110da35ddeeff7b12c0",
      "previous_version": "e8946f6953924110da35ddeeff7b1264",
      "effective_from": "1647563806950",
      "effective_to": null,
      "name": "Development_1",
      "description": "dev deployable decription",
      "value": null,
      "secure_value": null,
      "system_folder": "0",
      "linked_to": null,
      "conflict": "0",
      "conflict_type": null
    },
    {
      "sys_id": "a245e7a953924110da35ddeeff7b1223",
      "type": "sn_cdm_node_deployable",
      "main_id": "153",
      "main_id_encoded": "&P",
      "node_path": "!&@!&D!&P",
      "level": 2,
      "status": "valid",
      "node_classifier": "/application/deployables/env:Test",
      "position": null,
      "restricted_to": null,
      "changeset_id": "ea45e7a953924110da35ddeeff7b1222",
      "previous_version": "9505ef6953924110da35ddeeff7b121a",
      "effective_from": "1647563821422",
      "effective_to": null,
      "name": "Test_1",
      "description": "test deployable decription",
      "value": null,
      "secure_value": null,
      "system_folder": "0",
      "linked_to": null,
      "conflict": "0",
      "conflict_type": null
    }
  ]
} 

// Example of an error response
{
  "error": {
    "message": "Error: Unexpected error occurred in create request.Error:Application not found",
    "detail": ""
  },
  "status": "failure"
}

    CdmChangesetsApi – POST /sn_cdm/changesets/{changeset_id}/commit

    Übernimmt das angegebene Changeset. Nach dem Committen wird das Changeset in den CDM-Tabellen innerhalb der zugeordneten Instanz beibehalten.

    Das System aktualisiert die Anwendung, um die Änderungen an den Konfigurationsdaten im Changeset beizubehalten. Der Status des Changesetsändert sich in Festgelegt. Das System generiert dann einen Snapshot jedes bereitstellbaren Elements, das vom Changeset betroffen ist.

    Dieser Endpunkt gibt die ID der Commit-Anforderung zurück. Verwenden Sie diese ID, um den Endpunkt CdmChangesetsApi – GET /sn_cdm/changesets/commit-status/{commit_id} aufzurufen und den aktuellen Status des Changeset-Commits abzurufen.

    URL-Format

    Versionierte URL: /api/sn_cdm/{api_version}/changesets/{changeset_id}/commit

    Standard-URL: /api/sn_cdm/changesets/{changeset_id}/commit

    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
    changeset_id Sys_id des zu verarbeitenden Changeset-Datensatzes. Befindet sich in der Tabelle „CDM-Änderungssatz“ [sn_cdm_changeset].

    Datentyp: Zeichenfolge
    Tabelle : 44. Abfrageparameter
    Name Beschreibung
    autoValidieren Kennzeichnung, die angibt, ob die beim Commit erstellten Snapshots validiert werden, d. h. alle zugehörigen Richtlinien werden für den Snapshot ausgeführt.
    Gültige Werte:
    • true: Validiert die Snapshots.
    • false: Snapshots nicht validieren.

    Standardwert: false
    veröffentlichenOption Veröffentlichungsoption für die zugehörigen Konfigurations-Snapshots.
    Gültige Werte:
    • veröffentlichen_none: Keine Snapshots veröffentlichen.
    • veröffentlichen_valid: Veröffentlichen Sie nur die Snapshots, die die Validierung nach dem Commit bestehen.
    Hinweis:
    Diese Option ist nur verfügbar, wenn der Wert für den Parameter autoCommit „ true“ ist.

    Weitere Informationen zum Veröffentlichen von Snapshots finden Sie unter Snapshots veröffentlichen oder Veröffentlichung aufheben.

    Datentyp: Zeichenfolge

    Standard: veröffentlichen_none
    Tabelle : 45. Anforderungstextparameter
    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ützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur 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 Ungültige Anforderung. Fehler:<Error message>

    Überprüfen Sie, ob der von Ihnen übergebene Parameter changeset_id korrekt war.

    Stellen Sie sicher, dass Sie über die erforderlichen Rollen für den Zugriff auf diesen Endpunkt verfügen.
    500 Interner Serverfehler: Ungültiger boolescher Wert.

    Wenn Sie den Parameter autoValidate übergeben haben, stellen Sie sicher, dass es sich um einen booleschen Wert handelt.

    Parameter des Antwort-Haupttexts

    Name Beschreibung
    commit_id Sys_id der Commit-Anforderung.

    Verwenden Sie diese ID beim Aufruf des Endpunkts CdmChangesetsApi – GET /sn_cdm/changesets/commit-status/{commit_id}, um den Status der Commit-Anforderung zu überprüfen.

    Datentyp: Zeichenfolge
    Fehler Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    Fehler.Detail Zusätzliche Informationen zum Fehler.

    Datentyp: Zeichenfolge
    Fehler.Nachricht Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde.

    Datentyp: Zeichenfolge
    status Status des Commits. Wird nur zurückgegeben, wenn ein Fehler auftritt.

    Mögliche Werte: Fehler

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie dieser Endpunkt aufgerufen wird, um einen Changeset-Datensatz festzuschreiben.

    curl "http://instance.servicenow.com/api/sn_cdm/changesets/29e24001533030104bacddeeff7b120c/commit?publishOption=publish_valid"\ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \
--user 'username':'password'

    Das Folgende zeigt die Antwort für eine erfolgreiche Changeset-Commit-Anforderung.

    // Successful response
{ 
  "result": { 
    "commit_id": "64b5f79f5379301096edddeeff7b12eb" 
  } 
}

// Example of an error response
{
  "error": {
    "message": "Error: Unexpected error occurred in commit request.Error:Failed to insert request in queue",
    "detail": ""
  },
  "status": "failure"
}

    CdmChangesetsApi – POST /sn_cdm/changesets/create

    Erstellt ein neues Changeset im Status „Offen“ für eine angegebene CDM-Anwendung oder gemeinsam genutzte Bibliothek.

    Für den Zugriff auf diesen Endpunkt ist die Rolle „CDM-Editor“ erforderlich.

    URL-Format

    Versionierte URL: /api/sn_cdm/{api_version}/changesets/create/

    Standard-URL: /api/sn_cdm/changesets/create/

    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
    appName Erforderlich. Name der CDM-Anwendung oder gemeinsam genutzten Bibliothek, die diesem Changeset zugeordnet werden soll. Dies muss eine aktive Anwendung oder gemeinsam genutzte Bibliothek sein.

    Datentyp: Zeichenfolge
    Beschreibung Changeset-Beschreibung. Geben Sie etwas ein, damit andere den Zweck des Changesets verstehen können.

    Datentyp: Zeichenfolge

    Standard: Keine
    returnFields Kommagetrennte Liste von Feldern in der Tabelle „CDM-Änderungssatz“ [sn_cdm_changeset], die als Teil der Antwort zurückgegeben werden sollen.

    Datentyp: Zeichenfolge
    Tabelle : 51. Anforderungstextparameter
    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ützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur 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.
    400 Ungültige Anforderung. Fehler:<Error message>

    Stellen Sie sicher, dass die angegebene CDM-Anwendung oder gemeinsam genutzte Bibliothek vorhanden ist und sich im aktiven Status befindet.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts

    Name Beschreibung
    auto_validate

    Kennzeichnung, die angibt, ob die automatische Validierung durchgeführt wurde.

    Mögliche Werte:
    • true: Automatische Validierung wurde durchgeführt.
    • false: Die automatische Validierung wurde nicht durchgeführt.

    Datentyp: Boolesch
    cdm_application Details zur CDM-Anwendung, die dem Changeset zugeordnet ist.

    Datentyp: Objekt

    "cdm_application": { 
  "link": "String",
  "value": "String"
}
    Beispiel: {"value": "<sysId> ", "link": "http://localhost:8081/api/now/table/*'}"
    cdm_application.link URL der zugeordneten CDM-Anwendung.

    Datentyp: Zeichenfolge
    cdm_application.value Sys_id der zugeordneten CDM-Anwendung.

    Datentyp: Zeichenfolge
    commited_at Datum und Uhrzeit, zu der das Changeset an das zugehörige Repository übergeben wurde.

    Datentyp: Zeichenfolge
    commited_by Sys_id der Entität, die das Changeset erstellt hat.

    Datentyp: Zeichenfolge
    Beschreibung Beschreibung des Changesets, wie beim Aufruf des Endpunkts übergeben.

    Datentyp: Zeichenfolge
    Fehler Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    Fehler.Detail Zusätzliche Informationen zum Fehler.

    Datentyp: Zeichenfolge
    Fehler.Nachricht Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde.

    Datentyp: Zeichenfolge
    last_conflict_detection_time Zeitpunkt der letzten Ausführung der Konflikterkennung.

    Datentyp: Zahl

    Einheit: Millisekunden
    Nummer Eindeutiger Bezeichner für das neue Changeset.

    Datentyp: Zeichenfolge
    publish_option
    Veröffentlichungsoption für die zugeordneten konfigurierten Snapshots.
    Gültige Werte:
    • veröffentlichen_none: Keine Snapshots veröffentlichen.
    • veröffentlichen_valid: Veröffentlichen Sie nur die Snapshots, die die Validierung nach dem Commit bestehen.

    Weitere Informationen zum Veröffentlichen von Snapshots finden Sie unter Snapshots veröffentlichen oder Veröffentlichung aufheben.

    Datentyp: Zeichenfolge

    Standard: veröffentlichen_none
    snapshot_description Beschreibung des Snapshots, der dem Changeset zugeordnet ist.

    Datentyp: Zeichenfolge
    Status Status der Changeset-Erstellung.
    Mögliche Werte:
    • Blockiert
    • Überprüfung auf Konflikte
    • Commit fehlgeschlagen
    • Commit wird ausgeführt
    • Committet
    • Offen

    Datentyp: Zeichenfolge
    status Status der Changeset-Erstellung. Wird nur zurückgegeben, wenn ein Fehler auftritt.

    Mögliche Werte: Fehler

    Datentyp: Zeichenfolge
    sys_created_by Sys_id der Entität, die den Changeset-Datensatz erstellt hat.

    Datentyp: Zeichenfolge
    sys_id Sys_id des neuen Changesets.

    Datentyp: Zeichenfolge
    Titel Titel des Changesets, das der Anwendung zugeordnet ist. In der Regel automatisch vom System generiert.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie ein Changeset erstellt wird, das der Anwendung App Service1 CDM zugeordnet ist.

    curl "http://instance.servicenow.com/api/sn_cdm/changesets/create?appName=App%20Service1&description=Sample%20Description \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \
--user 'username':'password'

    Das Folgende zeigt die Antwort für eine erfolgreiche Erstellung des Changesets.

    // Example of a successful response
{   
"result": { 
    "sys_id": "42748779c370301054c1582e1340ddcd",
    "number": "Chset-8",
    "title": "admin2021-06-18 10:06:46",
    "description": null,
    "committed_at": "",
    "committed_by": null,
    "sys_created_by": "admin",
    "state": "open",
    "publish_option": "publish_none",
    "auto_validate": false,
    "snapshot_name": null,
    "snapshot_description": null,
    "cdm_application": "App%20Service1" 
  } 
}

// Example of an error response
{
  "error": {
    "message": "Error: Unexpected error occurred in create request.Error:Application not found",
    "detail": ""
  },
  "status": "failure"
}

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie ein Changeset für die gemeinsame Bibliothek „javalib“ erstellt wird.

    curl "http://instance.servicenow.com/api/sn_cdm/changesets/create?sharedLibraryName=javalib&description=description of changeset" \ 
--request POST \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    Antwort:

    CdmChangesetsApi – PUT /sn_cdm/changesets/commit

    Aktualisiert ein angegebenes Changeset und schreibt es fest.

    Das System aktualisiert die Anwendung, um die Änderungen an den Konfigurationsdaten im Changeset beizubehalten. Der Status des Changesetsändert sich in Festgelegt. Das System generiert dann einen Snapshot jedes bereitstellbaren Elements, das vom Changeset betroffen ist.

    Dieser Endpunkt gibt die ID der Commit-Anforderung zurück. Verwenden Sie diese ID, um den Endpunkt CdmChangesetsApi – GET /sn_cdm/changesets/commit-status/{commit_id} aufzurufen und den aktuellen Status des Changeset-Commits abzurufen.

    URL-Format

    Versionierte URL: /api/sn_cdm/{api_version}/changesets/{changeset_id}/commit

    Standard-URL: /api/sn_cdm/changesets/{changeset_id}/commit

    Unterstützte Anforderungsparameter

    Tabelle : 55. 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 : 56. Abfrageparameter
    Name Beschreibung
    autoValidieren Kennzeichnung, die angibt, ob die während des Commits erstellten Snapshots validiert werden, d. h. alle zugehörigen Richtlinien werden für den Snapshot ausgeführt.
    Gültige Werte:
    • true: Validiert die Snapshots.
    • false: Snapshots nicht validieren.

    Datentyp: Boolesch

    Standardwert: false
    changesetNumber Erforderlich.
    Eindeutiger Bezeichner des zugeordneten Changesets, z. B. „Chset-10“. Befindet sich in der Tabelle „CDMChangeset“ [sn_cdm_changeset].

    Datentyp: Zeichenfolge
    veröffentlichenOption
    Veröffentlichungsoption für die zugeordneten konfigurierten Snapshots.
    Gültige Werte:
    • veröffentlichen_none: Keine Snapshots veröffentlichen.
    • veröffentlichen_valid: Veröffentlichen Sie nur die Snapshots, die die Validierung nach dem Commit bestehen.

    Weitere Informationen zum Veröffentlichen von Snapshots finden Sie unter Snapshots veröffentlichen oder Veröffentlichung aufheben.

    Datentyp: Zeichenfolge

    Standard: veröffentlichen_none
    Tabelle : 57. Anforderungstextparameter
    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 : 58. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 59. 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 : 60. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung. Fehler:<Error message>

    Überprüfen Sie, ob der von Ihnen übergebene Parameter changeset_id korrekt war.

    Stellen Sie sicher, dass Sie über die erforderlichen Rollen für den Zugriff auf diesen Endpunkt verfügen.
    500 Interner Serverfehler: Ungültiger boolescher Wert.

    Wenn Sie den Parameter autoValidate übergeben haben, stellen Sie sicher, dass es sich um einen booleschen Wert handelt.

    Parameter des Antwort-Haupttexts

    Name Beschreibung
    commit_id Sys_id der Commit-Anforderung.

    Verwenden Sie diese ID beim Aufruf des Endpunkts CdmChangesetsApi – GET /sn_cdm/changesets/commit-status/{commit_id}, um den Status der Commit-Anforderung zu überprüfen.

    Datentyp: Zeichenfolge
    Fehler Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    Fehler.Detail Zusätzliche Informationen zum Fehler.

    Datentyp: Zeichenfolge
    Fehler.Nachricht Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde.

    Datentyp: Zeichenfolge
    status Status des Commits. Wird nur zurückgegeben, wenn ein Fehler auftritt.

    Mögliche Werte: Fehler

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie dieser Endpunkt zum Aktualisieren eines Changesets verwendet wird.

    curl "http://instance.servicenow.com/api/sn_cdm/changesets/commit?changesetNumber=Chset-146" \ 
--request PUT \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    Ergebnisse zurückgeben:

    { 
  "result": { 
    "commit_id": "cca8190f53141110a1d3ddeeff7b129e" 
  } 
}