---
sourceDocument: Xanadu-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/xanadu/api-reference
Release :
- xanadu
ft:locale :
- de-DE
ft:publication_title :
- Xanadu-API-Referenz
ft:clusterId :
- crapiref
bundleId :
- crapiref
workflow :
- Creator
---
# CdmChangesetsApi
# CdmChangesetsApi {#ariaid-title1}
* Freigeben Version: Xanadu
*
* Aktualisiert 1. August 2024
*
*  30 Minuten Lesedauer
CdmChangesetsApi stellt Endpunkte bereit, mit denen Sie Changesets verwalten können.
Mit diesen Endpunkten können Sie:
* Erstellen Sie neue Changesets.
* Stellen Sie Changesets bereit.
* Ruft Listen oder einzelne Changesets ab.
* Ruft die Knotenänderungen in einem Changeset ab.
* Rufen Sie eine Liste von Anwendungen oder bereitstellbaren Elementen ab, die von einem Changeset betroffen sind.
* Löschen Sie Changesets.
* Geben Sie eine Liste gemeinsam genutzter Komponenten zurück, die einem angegebenen Changeset zugeordnet sind.
Die Endpunkte zum Erstellen von Changesets verwenden eine asynchrone Implementierung in Warteschlangen. Bei dieser Art von Implementierung rufen Sie zuerst den Endpunkt der Anforderung zum Erstellen des Changesets 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 aufweisen, um auf diese API zugreifen zu können:
* Scripted REST CDM View ACL (sn_cdm.cdm.viewer)
* Scripted REST CDM Editor ACL (sn_cdm.cdm_editor)
Außerdem muss das Plugin Konfigurationsdaten-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](https://www.servicenow.com/docs/access?context=cdm-changesets-version-control&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US).
## CdmChangesetsApi: /sn_cdm/changesets LÖSCHEN {#ariaid-title2}
Löscht ein angegebenes Changeset.
Der Anrufer muss über die Rolle „CDM-Editor" verfügen, um auf diesen Endpunkt zugreifen zu können.
### URL-Format
URL mit Versionsnummer: /api/sn_cdm/{api_version}/changesets
Standard-URL: /api/sn_cdm/changesets
### Unterstützte Anforderungsparameter
{#chngsets-DELETE-chgnsets__entry__2}{#chngsets-DELETE-chgnsets__version-RESTAPI}
| 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 : 1. Pfadparameter]
{#chngsets-DELETE-chgnsets__entry__6}{#chngsets-DELETE-chgnsets__changesetNumber-changeset-entry}
| 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 : 2. Abfrageparameter]
{#chngsets-DELETE-chgnsets__entry__10}
| Name | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 3. Anforderungstextparameter]
### 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](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#chngsets-DELETE-chgnsets__entry__14}{#chngsets-DELETE-chgnsets__accept-JSON-only-entry-RESTAPI}
| Kopfzeile | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
[Tabelle : 4. Anforderungskopfzeilen]
{#chngsets-DELETE-chgnsets__entry__18}
| Kopfzeile | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 5. Antwortkopfzeilen]
### 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](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#chngsets-DELETE-chgnsets__entry__22}{#chngsets-DELETE-chgnsets__entry-200-status-code}{#chngsets-DELETE-chgnsets__entry-400-status-code}{#chngsets-DELETE-chgnsets__entry-500-status-code}
| 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. |
[Tabelle : 6. Statuscodes]
### Parameter des Antwort-Haupttexts
{#chngsets-DELETE-chgnsets__entry__30}
| Name | Beschreibung |
|-|-|
| Keine | |
[ ]
### cURL-Anforderung
Das folgende Codebeispiel zeigt, wie Sie ein Changeset entfernen.
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 außer dem HTTP-Statuscode keine Antwort zurückgegeben.
None - results defined by the HTTP status code
## CdmChangesetsApi: GET /sn_cdm/changesets {#ariaid-title3}
Ruft alle Changesets ab, die einer Anwendung Konfigurationsdaten-Management (CDM) oder einem angegebenen Changeset-Datensatz zugeordnet sind.
### URL-Format
URL mit Versionsnummer: /api/sn_cdm/{api_version}/changesets
Standard-URL: /api/sn_cdm/changesets
### Unterstützte Anforderungsparameter
{#chngsets-GET-changesets__entry__2}{#chngsets-GET-changesets__version-RESTAPI}
| 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. Pfadparameter]
{#chngsets-GET-changesets__entry__6}
| Name | Beschreibung |
|-|-|
| appName | Erforderlich. Name der CDM-Anwendung, deren Changesets Sie zurückgeben möchten. Dies muss eine aktive Anwendung sein. Befindet sich in der Tabelle „CDM-Anwendung" \[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 CDM-Anwendung zugeordnet ist, die im Parameter appName angegeben ist. Datentyp: Zeichenfolge Standard: Keine - Gibt alle Changesets zurück, die der CDM-Anwendung zugeordnet sind oder die durch den Parameter state angegeben wurden. |
| Staat | 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: Gibt alle Changesets für alle Status zurück |
[Tabelle : 8. Abfrageparameter]
{#chngsets-GET-changesets__entry__14}
| Name | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 9. Anforderungstextparameter]
### 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](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#chngsets-GET-changesets__entry__18}{#chngsets-GET-changesets__accept-JSON-only-entry-RESTAPI}
| Kopfzeile | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
[Tabelle : 10. Anforderungskopfzeilen]
{#chngsets-GET-changesets__entry__22}
| Kopfzeile | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 11. Antwortkopfzeilen]
### 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](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#chngsets-GET-changesets__entry__26}{#chngsets-GET-changesets__entry-200-status-code}{#chngsets-GET-changesets__entry-400-status-code}{#chngsets-GET-changesets__entry-500-status-code}
| 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. |
[Tabelle : 12. Statuscodes]
### Parameter des Antwort-Haupttexts
{#chngsets-GET-changesets__entry__34}{#chngsets-GET-changesets__cdm_apps-autoValidate-row}{#chngsets-GET-changesets__committed_at-changeset-entry}{#chngsets-GET-changesets__sys_created_by-changeset-entry}{#chngsets-GET-changesets__sys_created_on-changeset-entry}{#chngsets-GET-changesets__sys_id-changeset-entry}{#chngsets-GET-changesets__sys_updated_by-changeset-entry}{#chngsets-GET-changesets__sys_updated_on-changeset-entry}
| Name | Beschreibung |
|-|-|
| auto_validate | Kennzeichnung, die angibt, ob die beim Commit erstellten Changesets validiert wurden. Gültige Werte: * „wahr": Validiert die Changesets. * „falsch": Validieren Sie die Changesets nicht. 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 REST-Endpunkts der Tabelle zum Abrufen der zugehörigen CDM-Anwendung verwendet wird. Datentyp: Zeichenfolge |
| cdm_application.value | Sys_id der zugeordneten CDM-Anwendung. Befindet sich in der Tabelle „CDM-Anwendung" \[sn_cdm_application\]. Datentyp: Zeichenfolge |
| commit_at | Zeitpunkt (Datum und Uhrzeit), zu dem das Changeset zuletzt committet wurde. Datentyp: Zeichenfolge Format: JJJJ-mm-TT hh:mm:ss |
| commit_by | Details zum Benutzer, der das Changeset committet hat. Datentyp: Objekt "committed_by": { "link": "String", "value": "String" } |
| commit_by.link | Rufen Sie auf, um den Datensatz des Anwenders abzurufen, der das Changeset mithilfe der REST- Tabellen -API committet hat. Datentyp: Zeichenfolge |
| commit_by.value | Sys_id des Anwenders, der das Changeset committet 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 |
| Fehlernachricht | Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde. Datentyp: Zeichenfolge |
| last_conflict_detection_time | Zeit seit Ausführung der letzten Konflikterkennung. Die Konflikterkennung wird immer dann durchgeführt, wenn ein Changeset committet wird. Datentyp: Zahl Einheit: Millisekunden |
| last_updated | Datum und Uhrzeit, zu der durch dieses Changeset eine Änderung an den zugehörigen Konfigurationsdaten vorgenommen wurde. Format: JJJJ-mm-TT hh:mm:ss Datentyp: Zeichenfolge |
| Nummer | Eindeutige Nummer des Changesets. 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: Es werden nur die Snapshots veröffentlicht, die nach dem Commit validiert wurden. Weitere Informationen zum Veröffentlichen von Snapshots finden Sie unter Snapshots [veröffentlichen oder Veröffentlichung aufheben](https://www.servicenow.com/docs/access?context=cdm-snapshot-publish&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US). Datentyp: Zeichenfolge Standard: Publisher_none |
| Staat | 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 | Anwendername des Anwenders, 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 | Anwendername des Anwenders, 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 {#ariaid-title4}
Ruft die Knotenänderungen innerhalb eines angegebenen Changesets ab.
### URL-Format
URL mit Versionsnummer: /api/sn_cdm/{api_version}/changesets/activity
Standard-URL: /api/sn_cdm/changesets/activity
### Unterstützte Anforderungsparameter
{#chngsets-GET-activity__entry__2}{#chngsets-GET-activity__version-RESTAPI}
| 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 : 13. Pfadparameter]
{#chngsets-GET-activity__entry__6}{#chngsets-GET-activity__changesetNumber-changeset-entry}{#chngsets-GET-activity__cdm_apps-returnFields-entry}
| 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 : 14. Abfrageparameter]
{#chngsets-GET-activity__entry__12}
| Name | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 15. Anforderungstextparameter]
### 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](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#chngsets-GET-activity__entry__16}{#chngsets-GET-activity__accept-JSON-only-entry-RESTAPI}
| Kopfzeile | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
[Tabelle : 16. Anforderungskopfzeilen]
{#chngsets-GET-activity__entry__20}
| Kopfzeile | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 17. Antwortkopfzeilen]
### 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](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#chngsets-GET-activity__entry__24}{#chngsets-GET-activity__entry-200-status-code}{#chngsets-GET-activity__entry-400-status-code}{#chngsets-GET-activity__entry-500-status-code}
| 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. |
[Tabelle : 18. Statuscodes]
### Parameter des Antwort-Haupttexts
{#chngsets-GET-activity__entry__32}
| Name | Beschreibung |
|-|-|
| changeset_id | Details des angeforderten Changesets. Datentyp: Objekt "changeset_id": { "link": "String", "value": "String" } |
| changeset_id.link | Abfrage, die zum Aufrufen des REST-Endpunkts der Tabelle zum Abrufen des zugeordneten Changesets verwendet wird. 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. * „falsch": Kein Konflikt gefunden. Datentyp: Boolesch |
| erstellt | Datum und Uhrzeit der Erstellung des Knotens. Format: JJJJ-mm-TT hh:mm:ss Datentyp: Zeichenfolge |
| created_by | Anwendername des Anwenders, 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 |
| Fehlernachricht | 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-Text. Datentyp: Zeichenfolge |
| „old_name" | Vorheriger Name des Knotens. Datentyp: Zeichenfolge |
| old_value | Vorheriger Wert des Knotens. Für Blattknoten und Array-Text. Datentyp: Zeichenfolge |
| aktualisiert | Datum und Uhrzeit der letzten Aktualisierung des Knotens. Format: JJJJ-mm-TT hh:mm:ss Datentyp: Zeichenfolge |
| update_by | Anwendername des Anwenders, der den Knoten zuletzt aktualisiert hat. Beispiel: able.tuter. Datentyp: Zeichenfolge |
| sicher | Kennzeichnung, die angibt, ob der zugeordnete Endknoten gesichert wurde. Gültige Werte: * „wahr": Knoten wurde gesichert. * „falsch": 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 {#chngsets-GET-activity__ul_mlj_vdm_c5b} 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} {#ariaid-title5}
Gibt den aktuellen Status der angegebenen Commit-Anforderung des Changesets zurück.
### URL-Format
URL mit Versionsangabe: /api/sn_cdm/{api_version}/changesets/commit-status/{commit_id}
Standard-URL: /api/sn_cdm/changesets/commit-status/{commit_id}
### Unterstützte Anforderungsparameter
{#chngsets-GET-commit-status__entry__2}{#chngsets-GET-commit-status__version-RESTAPI}
| 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](https://servicenow-prod.fluidtopics.net/sXNMwpFS50AllbxCwbkGzQ#chngsets-POST-commit "Legt das angegebene Changeset fest. Nach dem Committen wird das Changeset in den CDM-Tabellen innerhalb der zugeordneten Instanz beibehalten.") zurückgegeben. |
[Tabelle : 19. Pfadparameter]
{#chngsets-GET-commit-status__entry__8}
| Name | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 20. Abfrageparameter]
{#chngsets-GET-commit-status__entry__12}
| Name | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 21. Anforderungstextparameter (XML oder JSON)]
### 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](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#chngsets-GET-commit-status__entry__16}{#chngsets-GET-commit-status__accept-JSON-only-entry-RESTAPI}
| Kopfzeile | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
[Tabelle : 22. Anforderungskopfzeilen]
{#chngsets-GET-commit-status__entry__20}
| Kopfzeile | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 23. Antwortkopfzeilen]
### 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](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#chngsets-GET-commit-status__entry__24}{#chngsets-GET-commit-status__entry-200-status-code}{#chngsets-GET-commit-status__entry-400-status-code}{#chngsets-GET-commit-status__entry-500-status-code}
| 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. |
[Tabelle : 24. Statuscodes]
### Parameter des Antwort-Haupttexts
{#chngsets-GET-commit-status__entry__32}{#chngsets-GET-commit-status__cdm_apps-request_id-row}{#chngsets-GET-commit-status__cdm_apps-export_id-row}{#chngsets-GET-commit-status__cdm_apps-state-row}
| Name | Beschreibung |
|-|-|
| Übergeben \[_id | sys_id des Commit-Anforderungsdatensatzes. Identisch mit dem an den Endpunkt übergebenen. Datentyp: Zeichenfolge |
| Fehler | Beschreibung der Fehler, die beim Hochladen 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" } |
| „output.auto_validate" | Gibt an, ob die Validierung nach dem Commit aufgerufen werden soll. Datentyp: Zeichenfolge |
| „output.cdm_application" | Name der Anwendung, unter der der Upload durchgeführt wurde. Datentyp: Zeichenfolge |
| „output.committed_at" | Zeitpunkt (Datum und Uhrzeit), zu dem der hochgeladene Inhalt bestätigt wurde. Datentyp: Zeichenfolge |
| „output.committed_by" | Sys_id des Datensatzes der Entität, die den Commit durchgeführt hat. Datentyp: Zeichenfolge |
| Ausgabe.Beschreibung | Derzeit nicht verwendet. Datentyp: Zeichenfolge |
| „output.last_conflict_detection_time" | Aufruf der Datum-/Uhrzeit-Konflikterkennung. Datentyp: Zeichenfolge |
| Ausgabe.Nummer | Eindeutige Nummer des Changesets. Datentyp: Zeichenfolge |
| „output.publish_option" | Veröffentlichungsoption für die zugeordneten konfigurierten Snapshots. Gültige Werte: * veröffentlichen_none: Keine Snapshots veröffentlichen. * veröffentlichen_valid: Es werden nur die Snapshots veröffentlicht, die nach dem Commit validiert wurden. Weitere Informationen zum Veröffentlichen von Snapshots finden Sie unter Snapshots [veröffentlichen oder Veröffentlichung aufheben](https://www.servicenow.com/docs/access?context=cdm-snapshot-publish&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US). Datentyp: Zeichenfolge Standard: Publisher_none |
| „output.snapshot_description" | Beschreibung des zugeordneten Snapshots. Datentyp: Zeichenfolge |
| „output.snapshot_name" | Name des zugeordneten Snapshots. Datentyp: Zeichenfolge |
| Ausgabe.Status | Status des Upload-Inhalts. Mögliche Werte: * committet * abgeschlossen * Fehler * in_progress * neu * Bereit {#chngsets-GET-commit-status__ul_qhn_w4p_psb} Datentyp: Zeichenfolge |
| „output.sys_created_by" | Sys_id der Entität, die den Datensatz erstellt hat. Datentyp: Zeichenfolge |
| „output.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 |
| Verarbeitungsstatus | Aktueller Verarbeitungsstatus der Commit-Anforderung. Mögliche Werte: * NOT_PROCREED * VERARBEITET {#chngsets-GET-commit-status__ul_gmt_2pp_psb} Datentyp: Zeichenfolge |
| request_id | Anforderungs-ID Identisch mit dem, der an den Endpunkt und commit_idübergeben wurde. Datentyp: Zeichenfolge |
| Staat | 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 abzurufen.
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 {#ariaid-title6}
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
URL mit Versionsnummer: /api/sn_cdm/{api_version}/changesets/impacted-deployables
Standard-URL: /api/sn_cdm/changesets/impacted-deployables
### Unterstützte Anforderungsparameter
{#chngsets-GET-impact-deploys__entry__2}{#chngsets-GET-impact-deploys__version-RESTAPI}
| 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 : 25. Pfadparameter]
{#chngsets-GET-impact-deploys__entry__6}{#chngsets-GET-impact-deploys__changesetNumber-changeset-entry}{#chngsets-GET-impact-deploys__cdm_apps-returnFields-entry}
| 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 : 26. Abfrageparameter]
{#chngsets-GET-impact-deploys__entry__12}
| Name | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 27. Anforderungstextparameter]
### 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](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#chngsets-GET-impact-deploys__entry__16}{#chngsets-GET-impact-deploys__accept-JSON-only-entry-RESTAPI}
| Kopfzeile | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
[Tabelle : 28. Anforderungskopfzeilen]
{#chngsets-GET-impact-deploys__entry__20}
| Kopfzeile | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 29. Antwortkopfzeilen]
### 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](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#chngsets-GET-impact-deploys__entry__24}{#chngsets-GET-impact-deploys__entry-200-status-code}{#chngsets-GET-impact-deploys__entry-400-status-code}{#chngsets-GET-impact-deploys__entry-500-status-code}
| 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. |
[Tabelle : 30. Statuscodes]
### Parameter des Antwort-Haupttexts
{#chngsets-GET-impact-deploys__id_lcm_5dn_qtb__entry__2}{#chngsets-GET-impact-deploys__cdm_app_link-app-entry}{#chngsets-GET-impact-deploys__cdm_app_value-app-entry}{#chngsets-GET-impact-deploys__cdm_apps-error-entry}{#chngsets-GET-impact-deploys__cdm_dep-sys_created_by-row}{#chngsets-GET-impact-deploys__cdm_deps-sys_created_on-row}{#chngsets-GET-impact-deploys__cdm_dep-sys_updated_by-row}{#chngsets-GET-impact-deploys__cdm_dep-sys_updated_on-row}
| Name | Beschreibung |
|-|-|
| cdi_count | Anzahl der Configuration Data Items (CDIs), die in der zugehörigen 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 mit der REST- Tabellen -API auf den CDM-Anwendungsdatensatz zuzugreifen. Datentyp: Zeichenfolge |
| cdm_app.value | Sys_id des zugeordneten CDM-Anwendungsdatensatzes. Befindet sich in der Tabelle „CDM-Anwendung" \[sn_cdm_application\]. Datentyp: Zeichenfolge |
| cdm_ci | Anwendungsservice-Objekt, das dem bereitstellbaren Element zugeordnet ist. Datentyp: Objekt "cdm_ci": { "link": "String", "value": "String" } |
| cdm_ci.link | Rufen Sie auf, um mit der REST- Tabellen -API auf den Anwendungsservice-Datensatz zuzugreifen. Datentyp: Zeichenfolge |
| cdm_ci.wert | Sys_id des zugeordneten Anwendungsservice-Datensatzes. Befindet sich in der Tabelle „Configuration Item" \[cmdb_ci\]. Datentyp: Zeichenfolge |
| Beschreibung | Beschreibung des generierten bereitstellbaren CDM-Elements. Datentyp: Zeichenfolge |
| environment_type | 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 |
| Fehlernachricht | Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde. Datentyp: Zeichenfolge |
| name | Name des bereitstellbaren CDM-Elements. Datentyp: Zeichenfolge |
| Knoten | Details zum bereitstellbaren Knoten. Datentyp: Objekt "node": { "link": "String", "value": "String" } |
| node.link | Rufen Sie auf, um mit der REST- Tabellen -API auf den Datensatz des bereitstellbaren Knotens zuzugreifen. Datentyp: Zeichenfolge |
| node.value | Sys_id des bereitstellbaren Knotendatensatzes. Befindet sich in der Tabelle „CDM -- Bereitstellbar" \[sn_cdm_deployable\]. Datentyp: Zeichenfolge |
| Snapshot_Version_Zähler | Anzahl der für das bereitstellbare Element erstellten Snapshots. Datentyp: Ganzzahl |
| Staat | Aktueller Status des bereitstellbaren Elements. Mögliche Werte: * aktiv * gelöscht Datentyp: Zeichenfolge |
| sys_created_by | Anwendername des Anwenders, der das CDM-Bereitstellungselement 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 „CDM -- Bereitstellbar" \[sn_cdm_deployable\]. Datentyp: Zeichenfolge |
| sys_updated_by | Anwendername des Anwenders, der das CDM-Bereitstellungselement zuletzt aktualisiert hat. Beispiel: able.tuter. Datentyp: Zeichenfolge |
| sys_updated_on | Datum und Uhrzeit der letzten Aktualisierung des bereitstellbaren CDM-Elements. Format: JJJJ-mm-TT hh:mm:ss Datentyp: Zeichenfolge |
[ ]
{#chngsets-GET-impact-deploys__id_lcm_5dn_qtb}
### 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 {#ariaid-title7}
Gibt eine Liste gemeinsam genutzter Komponenten zurück, die einem angegebenen Changeset zugeordnet sind.
Für den Zugriff auf diesen Endpunkt ist die Rolle „CDM-Betrachter" erforderlich.
### URL-Format
URL mit Versionsangabe: /api/sn_cdm/{api_version}/changesets/impacted-shared-components
Standard-URL: /api/sn_cdm/changesets/impacted-shared-components
### Unterstützte Anforderungsparameter
{#chngsets-GET-impact_shared_comp__entry__2}{#chngsets-GET-impact_shared_comp__version-RESTAPI}
| 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. Pfadparameter]
{#chngsets-GET-impact_shared_comp__entry__6}{#chngsets-GET-impact_shared_comp__changesetNumber-changeset-entry}{#chngsets-GET-impact_shared_comp__cdm_apps-returnFields-entry}
| 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 : 32. Abfrageparameter]
{#chngsets-GET-impact_shared_comp__entry__12}
| Name | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 33. Anforderungstextparameter]
### 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](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#chngsets-GET-impact_shared_comp__entry__16}{#chngsets-GET-impact_shared_comp__accept-JSON-only-entry-RESTAPI}
| Kopfzeile | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
[Tabelle : 34. Anforderungskopfzeilen]
{#chngsets-GET-impact_shared_comp__entry__20}
| Kopfzeile | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 35. Antwortkopfzeilen]
### 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](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#chngsets-GET-impact_shared_comp__entry__24}{#chngsets-GET-impact_shared_comp__entry-200-status-code}{#chngsets-GET-impact_shared_comp__entry-500-status-code}
| 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. |
[Tabelle : 36. Statuscodes]
### Parameter des Antwort-Haupttexts
{#chngsets-GET-impact_shared_comp__entry__32}{#chngsets-GET-impact_shared_comp__cdm_apps-error-entry}{#chngsets-GET-impact_shared_comp__cdm_apps-error_detail-entry}{#chngsets-GET-impact_shared_comp__cdm_apps-error_message-entry}{#chngsets-GET-impact_shared_comp__cdm_dep-sys_created_by-row}{#chngsets-GET-impact_shared_comp__cdm_deps-sys_created_on-row}{#chngsets-GET-impact_shared_comp__cdm_dep-sys_updated_by-row}{#chngsets-GET-impact_shared_comp__cdm_dep-sys_updated_on-row}
| Name | Beschreibung |
|-|-|
| cdm_shared__library | Sys_id der gemeinsamen 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 |
| Fehlernachricht | Meldung, die eine Übersicht über den Fehler bietet. Datentyp: Zeichenfolge |
| name | Name der gemeinsam genutzten CDM-Komponente. Datentyp: Zeichenfolge |
| Knoten | Sys_id des Knotens der gemeinsam genutzten Komponente. 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 |
| Staat | Aktueller Status der gemeinsam genutzten Komponente. Mögliche Werte: * aktiv * gelöscht Datentyp: Zeichenfolge |
| sys_created_by | Anwendername des Anwenders, 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 | Anwendername des Anwenders, 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 {#ariaid-title8}
Gibt die Liste der bereitstellbaren Elemente zurück, die einem angegebenen Changeset zugeordnet sind.
### URL-Format
URL mit Versionsnummer: /api/sn_cdm/{api_version}/changesets/{changeset_id}/impacted-deployables
Standard-URL: /api/sn_cdm/changesets/{changeset_id}/impacted-deployables
### Unterstützte Anforderungsparameter
{#chngsets-GET-impacted-deployables__entry__2}{#chngsets-GET-impacted-deployables__version-RESTAPI}
| 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 : 37. Pfadparameter]
{#chngsets-GET-impacted-deployables__entry__8}
| Name | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 38. Abfrageparameter]
{#chngsets-GET-impacted-deployables__entry__12}
| Name | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 39. Anforderungstextparameter (XML oder JSON)]
### 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](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#chngsets-GET-impacted-deployables__entry__16}{#chngsets-GET-impacted-deployables__accept-JSON-only-entry-RESTAPI}
| Kopfzeile | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
[Tabelle : 40. Anforderungskopfzeilen]
{#chngsets-GET-impacted-deployables__entry__20}
| Kopfzeile | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 41. Antwortkopfzeilen]
### 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](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#chngsets-GET-impacted-deployables__entry__24}{#chngsets-GET-impacted-deployables__entry-200-status-code}{#chngsets-GET-impacted-deployables__entry-400-status-code}{#chngsets-GET-impacted-deployables__entry-500-status-code}
| 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. |
[Tabelle : 42. Statuscodes]
### Parameter des Antwort-Haupttexts
{#chngsets-GET-impacted-deployables__entry__32}
| 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: In Konflikt. Weitere Informationen finden Sie im Rückgabeergebnis conflict_type. {#chngsets-GET-impacted-deployables__ul_enr_rxd_btb} 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 * unvollständig_umbenannt_ref * ungültig_include * verwaiste_descendant * related_conflict * unlinked_include * unrennamed_include * update_node {#chngsets-GET-impacted-deployables__ul_okw_dyd_btb} 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 committen, in dem der Knoten erstellt wurde. Datentyp: Zahl |
| effektiv_bis | Zeitstempel, wenn der Knoten nicht mehr gültig ist. Wenn dieser Wert nullist, bleibt der Knoten solange betroffen, 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 |
| Fehlernachricht | Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde. Datentyp: Zeichenfolge |
| level | Tiefe des Knotens ab der Anwendungsebene, die 0 ist. Datentyp: Zahl |
| linked_to | ID des Referenzknotens in einer Sammlung und Komponente Der folgende Knotenausschnitt zeigt beispielsweise einen Link 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 Bezeichner des bereitstellbaren Knotens. Dieser Wert wird generiert, wenn der Knoten erstellt wird, und verwendet, um den bereitstellbaren Knoten zu identifizieren. Datentyp: Zahl |
| main_id_encoded | Codierter Wert der mainId -Rückgabeergebnisse unter Verwendung der Radius-57-Zeichenfolgendarstellung. 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 {#chngsets-GET-impacted-deployables__ul_fg5_ghd_btb} 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 |
| Beschränken_auf | Liste der sys_ids der Anwender, die auf den zugeordneten bereitstellbaren Knoten zugreifen dürfen. Diese Informationen stammen aus der Tabelle der eingeschränkten CDM-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 Variable. Wird nur für Blattknoten und Array-Text zurückgegeben. Dies entspricht 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 {#chngsets-GET-impacted-deployables__ul_yjp_3gd_btb} Datentyp: Zeichenfolge |
| system_folder | Kennzeichnung, die angibt, ob der zugeordnete Ordner ein Systemordner ist. Gültige Werte: * 0: Kein Systemordner. * 1: Systemordner. {#chngsets-GET-impacted-deployables__ul_e3d_hwd_btb} 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 (Config Data Item, CDI) oder ein bereitstellbares Element ist. Dieser Wert wird generiert, wenn der Knoten erstellt wird. Datentyp: Zeichenfolge |
| Wert | Wert der CDI oder Variable. Wird nur für Blattknoten und Array-Text 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. Bei einem Array-Knoten wie `node1: {arrayNode: [{}, "literal1", "literal2", []]}`lautet das Rückgabeergebnis von valueLiteral1. Datentyp: Zeichenfolge |
[ ]
### cURL-Anforderung
Das folgende Beispiel zeigt, wie Sie die bereitstellbaren Elemente anfordern, 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'
Im Folgenden finden Sie eine erfolgreiche und eine fehlerhafte Antwort 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 {#ariaid-title9}
Legt das angegebene Changeset fest. 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 innerhalb des Changesets beizubehalten. Der Status des Changesets ändert sich in Committed. Das System generiert dann einen Snapshot von jedem bereitstellbaren Element, das von dem 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}](https://servicenow-prod.fluidtopics.net/sXNMwpFS50AllbxCwbkGzQ#chngsets-GET-commit-status "Gibt den aktuellen Status der angegebenen Commit-Anforderung des Changesets zurück.") aufzurufen und den aktuellen Status des Changeset-Commits zu erhalten.
### URL-Format
URL mit Versionsnummer: /api/sn_cdm/{api_version}/changesets/{changeset_id}/commit
Standard-URL: /api/sn_cdm/changesets/{changeset_id}/commit
### Unterstützte Anforderungsparameter
{#chngsets-POST-commit__entry__2}{#chngsets-POST-commit__version-RESTAPI}
| 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 : 43. Pfadparameter]
{#chngsets-POST-commit__entry__8}
| Name | Beschreibung |
|-|-|
| autoValidate | Kennzeichnung, die angibt, ob die beim Committen erstellten Snapshots validiert sind, was bedeutet, dass alle zugehörigen Richtlinien für den Snapshot ausgeführt werden. Gültige Werte: * „wahr": Validiert die Snapshots. * „falsch": Die Snapshots werden nicht validiert. {#chngsets-POST-commit__ul_aqt_zmb_psb} Standardwert: false |
| VeröffentlichenOption | Veröffentlichungsoption für die zugehörigen Konfigurations-Snapshots. Gültige Werte: * veröffentlichen_none: Es werden keine Snapshots veröffentlicht. * veröffentlichen_valid: Es werden nur die Snapshots veröffentlicht, die nach dem Commit validiert wurden. Hinweis: Diese Option ist nur verfügbar, wenn der Wert für den Parameter autoCommit wahr ist. Weitere Informationen zum Veröffentlichen von Snapshots finden Sie unter Snapshots [veröffentlichen oder Veröffentlichung aufheben](https://www.servicenow.com/docs/access?context=cdm-snapshot-publish&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US). Datentyp: Zeichenfolge Standard: Publisher_none |
[Tabelle : 44. Abfrageparameter]
{#chngsets-POST-commit__entry__14}
| Name | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 45. Anforderungstextparameter]
### 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](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#chngsets-POST-commit__entry__18}{#chngsets-POST-commit__accept-JSON-only-entry-RESTAPI}{#chngsets-POST-commit__content_type-JSON-only-entry-RESTAPI}
| Kopfzeile | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
[Tabelle : 46. Anforderungskopfzeilen]
{#chngsets-POST-commit__entry__24}
| Kopfzeile | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 47. Antwortkopfzeilen]
### 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](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#chngsets-POST-commit__entry__28}{#chngsets-POST-commit__entry-200-status-code}
| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Fehler:\ Stellen Sie sicher, dass 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, vergewissern Sie sich, dass es sich um einen booleschen Wert handelt. |
[Tabelle : 48. Statuscodes]
### Parameter des Antwort-Haupttexts
{#chngsets-POST-commit__id_bgt_byy_ztb__entry__2}
| Name | Beschreibung |
|-|-|
| commit_id | Sys_id der Commit-Anforderung. Verwenden Sie diese ID, wenn Sie den Endpunkt [CdmChangesetsApi -- GET /sn_cdm/changesets/commit-status/{commit_id}](https://servicenow-prod.fluidtopics.net/sXNMwpFS50AllbxCwbkGzQ#chngsets-GET-commit-status "Gibt den aktuellen Status der angegebenen Commit-Anforderung des Changesets zurück.") aufrufen, 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 |
| Fehlernachricht | 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 |
[ ]
{#chngsets-POST-commit__id_bgt_byy_ztb}
### cURL-Anforderung
Das folgende Beispiel zeigt, wie dieser Endpunkt aufgerufen wird, um einen Changeset-Datensatz zu committen.
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'
Im Folgenden finden Sie die Antwort auf eine erfolgreiche Commit-Anforderung für ein Changeset.
// 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 {#ariaid-title10}
Erstellt ein neues Changeset im Status „Geöffnet" für eine angegebene CDM-Anwendung oder gemeinsame Bibliothek.
Für den Zugriff auf diesen Endpunkt ist die Rolle „CDM-Editor" erforderlich.
### URL-Format
URL mit Versionsnummer: /api/sn_cdm/{api_version}/changesets/create/
Standard-URL: /api/sn_cdm/changesets/create/
### Unterstützte Anforderungsparameter
{#chngsets-POST-create__entry__2}{#chngsets-POST-create__version-RESTAPI}
| 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 : 49. Pfadparameter]
{#chngsets-POST-create__entry__6}{#chngsets-POST-create__appName-changesets-entry}
| Name | Beschreibung |
|-|-|
| appName | Erforderlich. Name der CDM-Anwendung oder gemeinsamen Bibliothek, die diesem Changeset zugeordnet werden soll. Dies muss eine aktive Anwendung oder gemeinsame Bibliothek sein. Datentyp: Zeichenfolge |
| Beschreibung | Beschreibung des Changesets. 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-Changeset" \[sn_cdm_changeset\], die als Teil der Antwort zurückgegeben werden sollen. Datentyp: Zeichenfolge |
[Tabelle : 50. Abfrageparameter]
{#chngsets-POST-create__entry__14}
| Name | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 51. Anforderungstextparameter]
### 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](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#chngsets-POST-create__entry__18}{#chngsets-POST-create__accept-JSON-only-entry-RESTAPI}{#chngsets-POST-create__content_type-JSON-only-entry-RESTAPI}
| Kopfzeile | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
[Tabelle : 52. Anforderungskopfzeilen]
{#chngsets-POST-create__entry__24}
| Kopfzeile | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 53. Antwortkopfzeilen]
### 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](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#chngsets-POST-create__entry__28}{#chngsets-POST-create__entry-200-status-code}{#chngsets-POST-create__entry-500-status-code}
| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Fehler:\ Stellen Sie sicher, dass die angegebene CDM-Anwendung oder gemeinsame Bibliothek vorhanden ist und sich im Status „Aktiv" befindet. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
[Tabelle : 54. Statuscodes]
### Parameter des Antwort-Haupttexts
{#chngsets-POST-create__entry__36}
| Name | Beschreibung |
|-|-|
| auto_validate | Kennzeichnung, die angibt, ob die automatische Validierung durchgeführt wurde. Mögliche Werte: * „wahr": Automatische Validierung wurde durchgeführt. * „falsch": Es wurde keine automatische Validierung durchgeführt. Datentyp: Boolesch |
| cdm_application | Details zu der CDM-Anwendung, die dem Changeset zugeordnet ist. Datentyp: Objekt "cdm_application": { "link": "String", "value": "String" } Beispiel: `{"value": "`\ ", "link": "http://localhost:8081/api/now/table/\*'}" |
| cdm_application.link | URL der zugehörigen CDM-Anwendung. Datentyp: Zeichenfolge |
| cdm_application.value | Sys_id der zugeordneten CDM-Anwendung. Datentyp: Zeichenfolge |
| commit_at | Zeitpunkt (Datum und Uhrzeit), zu dem das Changeset in das zugeordnete Repository committet wurde. Datentyp: Zeichenfolge |
| commit_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 |
| Fehlernachricht | 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: Es werden nur die Snapshots veröffentlicht, die nach dem Commit validiert wurden. Weitere Informationen zum Veröffentlichen von Snapshots finden Sie unter Snapshots [veröffentlichen oder Veröffentlichung aufheben](https://www.servicenow.com/docs/access?context=cdm-snapshot-publish&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US). Datentyp: Zeichenfolge Standard: Publisher_none |
| snapshot_description | Beschreibung des Snapshots, der dem Changeset zugeordnet ist. Datentyp: Zeichenfolge |
| Staat | 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. Wird normalerweise vom System automatisch generiert. Datentyp: Zeichenfolge |
[ ]
### cURL-Anforderung
Das folgende Beispiel zeigt, wie Sie ein Changeset erstellen, 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'
Im Folgenden finden Sie 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 {#ariaid-title11}
Aktualisiert ein angegebenes Changeset und legt es fest.
Das System aktualisiert die Anwendung, um die Änderungen an den Konfigurationsdaten innerhalb des Changesets beizubehalten. Der Status des Changesets ändert sich in Committed. Das System generiert dann einen Snapshot von jedem bereitstellbaren Element, das von dem 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}](https://servicenow-prod.fluidtopics.net/sXNMwpFS50AllbxCwbkGzQ#chngsets-GET-commit-status "Gibt den aktuellen Status der angegebenen Commit-Anforderung des Changesets zurück.") aufzurufen und den aktuellen Status des Changeset-Commits zu erhalten.
### URL-Format
URL mit Versionsnummer: /api/sn_cdm/{api_version}/changesets/{changeset_id}/commit
Standard-URL: /api/sn_cdm/changesets/{changeset_id}/commit
### Unterstützte Anforderungsparameter
{#chngsets-PUT-commit__entry__2}{#chngsets-PUT-commit__version-RESTAPI}
| 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 : 55. Pfadparameter]
{#chngsets-PUT-commit__entry__6}{#chngsets-PUT-commit__autoValidate-changeset-entry}{#chngsets-PUT-commit__changesetNumber-changeset-entry}
| Name | Beschreibung |
|-|-|
| autoValidate | Kennzeichnung, die angibt, ob die während des Commits erstellten Snapshots validiert wurden, was bedeutet, dass alle zugehörigen Richtlinien für den Snapshot ausgeführt werden. Gültige Werte: * „wahr": Validiert die Snapshots. * „falsch": Die Snapshots werden nicht validiert. 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: Es werden nur die Snapshots veröffentlicht, die nach dem Commit validiert wurden. Weitere Informationen zum Veröffentlichen von Snapshots finden Sie unter Snapshots [veröffentlichen oder Veröffentlichung aufheben](https://www.servicenow.com/docs/access?context=cdm-snapshot-publish&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US). Datentyp: Zeichenfolge Standard: Publisher_none |
[Tabelle : 56. Abfrageparameter]
{#chngsets-PUT-commit__entry__14}
| Name | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 57. Anforderungstextparameter]
### 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](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#chngsets-PUT-commit__entry__18}{#chngsets-PUT-commit__accept-JSON-only-entry-RESTAPI}{#chngsets-PUT-commit__content_type-JSON-only-entry-RESTAPI}
| Kopfzeile | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
[Tabelle : 58. Anforderungskopfzeilen]
{#chngsets-PUT-commit__entry__24}
| Kopfzeile | Beschreibung |
|-|-|
| Keine | |
[Tabelle : 59. Antwortkopfzeilen]
### 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](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#chngsets-PUT-commit__entry__28}{#chngsets-PUT-commit__entry-200-status-code}
| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Fehler:\ Stellen Sie sicher, dass 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, vergewissern Sie sich, dass es sich um einen booleschen Wert handelt. |
[Tabelle : 60. Statuscodes]
### Parameter des Antwort-Haupttexts
{#chngsets-PUT-commit__id_cjx_1yy_ztb__entry__2}
| Name | Beschreibung |
|-|-|
| commit_id | Sys_id der Commit-Anforderung. Verwenden Sie diese ID, wenn Sie den Endpunkt [CdmChangesetsApi -- GET /sn_cdm/changesets/commit-status/{commit_id}](https://servicenow-prod.fluidtopics.net/sXNMwpFS50AllbxCwbkGzQ#chngsets-GET-commit-status "Gibt den aktuellen Status der angegebenen Commit-Anforderung des Changesets zurück.") aufrufen, 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 |
| Fehlernachricht | 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 |
[ ]
{#chngsets-PUT-commit__id_cjx_1yy_ztb}
### 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"
}
}