CdmChangesetsApi
Die CdmChangesetsApi Stellt Endpunkte bereit, mit denen Sie Changesets verwalten können.
- Erstellen Sie neue Changesets.
- Changesets bereitstellen.
- Ruft Listen von oder einzelnen Changesets ab.
- Ruft die Knotenänderungen in einem Changeset ab.
- Ruft eine Liste der Anwendungen oder bereitstellbaren Elemente ab, die von einem Changeset betroffen sind.
- Löschen Sie Changesets.
- Gibt eine Liste der gemeinsam genutzten Komponenten zurück, die einem angegebenen Changeset zugeordnet sind.
Die Endpunkte „Changesets erstellen“ verwenden eine asynchrone Warteschlangenimplementierung. Bei dieser Art der Implementierung rufen Sie zuerst den Endpunkt der Anforderung zum Erstellen eines Changesets auf. Dieser Endpunkt stellt Ihre Anforderung in die Warteschlange und gibt einen Commit-Bezeichner zurück. Sie verwenden dann diesen Commit-Bezeichner, um den entsprechenden Statusendpunkt aufzurufen, um den Status der Erstellungsanforderung abzurufen.
- Geskriptete REST-CDM-ACL anzeigen (sn_cdm.cdm.Viewer)
- Geskriptete REST-CDM-Editor-ACL (sn_cdm.cdm_Editor)
Darüber hinaus die Konfigurationsdaten-Management Das Plugin (CDM) muss aktiviert sein, damit diese API in einer Instanz verfügbar ist.
Weitere Informationen zu Changesets finden Sie unter Changesets und Versionssteuerung in CDM .
CdmChangesetsApi: LÖSCHEN SIE /sn_cdm/changesets
Löscht ein angegebenes Changeset.
Der Anrufer muss über die Rolle „CDM-Editor“ verfügen, um auf diesen Endpunkt zuzugreifen.
URL-Format
Versionierte URL: /api/sn_cdm/{api_Version}/Changesets
Standard-URL: /api/sn_cdm/Changesets
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| changesetNumber | Erforderlich. Eindeutiger Bezeichner des zugeordneten Changesets, z. B. „Chset-10“. Datentyp: Zeichenfolge Tabelle: CDM-Änderungssatz [sn_cdm_changeset] |
| 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 .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| 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 REST API-HTTP-Antwortcodes .
| 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'
Für eine erfolgreiche Löschung des Changesets wird keine andere Antwort als der HTTP-Statuscode zurückgegeben.
None - results defined by the HTTP status code
CdmChangesetsApi: /sn_cdm/changesets ABRUFEN
Ruft alle Changesets ab, die einem zugeordnet sind Konfigurationsdaten-Management(CDM)-Anwendung oder ein angegebener Changeset-Datensatz.
URL-Format
Versionierte URL: /api/sn_cdm/{api_Version}/Changesets
Standard-URL: /api/sn_cdm/Changesets
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| appName | Erforderlich. Name der CDM-Anwendung, deren Changesets zurückgegeben werden sollen. Dies muss eine aktive Anwendung sein. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application] |
| Nummer | Changeset-Nummer. Wenn Sie diesen Wert übergeben, wird nur das angegebene Changeset zurückgegeben. Es muss ein Changeset sein, das der in angegebenen CDM-Anwendung zugeordnet ist appNameParameter. Datentyp: Zeichenfolge Standard: Keine: Gibt alle Changesets zurück, die der CDM-Anwendung zugeordnet sind oder die von angegeben werden stateParameter. Tabelle: CDMChangeset [sn_cdm_changeset] |
| Status | Status der zurückzugebenden Changesets. Gibt nur die Changesets zurück, die der angegebenen CDM-Anwendung für den angegebenen Status zugeordnet sind. Gültige Werte:
Datentyp: Zeichenfolge Standard: Alle Changesets für alle status zurückgeben |
| 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 .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| 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 REST API-HTTP-Antwortcodes .
| 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:
Datentyp: Boolesch |
| cdm_Application | Details der CDM-Anwendung, die dem Changeset zugeordnet ist. Datentyp: Objekt |
| cdm_Application.Link | Abfrage, die zum Aufrufen von verwendet werden soll Tabelle REST-Endpunkt zum Abrufen der zugehörigen CDM-Anwendung. Datentyp: Zeichenfolge |
| cdm_Application.value | SYS_ID der zugeordneten CDM-Anwendung. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application] |
| Committete_at | Datum und Uhrzeit der letzten Commits des Changesets. Datentyp: Zeichenfolge Format: JJJJ-mm-TT hh:mm:ss |
| Commit_by | Details zum Anwender, der das Changeset festgeschrieben hat. Datentyp: Objekt |
| Commit_by.Link | Rufen Sie an, um den Datensatz des Anwenders zu erhalten, der das Changeset mit dem REST festgeschrieben hat Tabelle API. Datentyp: Zeichenfolge |
| Commit_by.value | SYS_ID des Anwenders, der den Changeset festgeschrieben 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 | 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 Ausführung der letzten Konflikterkennung. Die Konflikterkennung wird immer dann durchgeführt, wenn ein Changeset bestätigt wird. Datentyp: Zahl Einheit: Millisekunden |
| last_updated | Datum und Uhrzeit, zu der eine Änderung an den zugehörigen Konfigurationsdaten über dieses Changeset vorgenommen wurde. Format: JJJJ-mm-TT hh:mm:ss Datentyp: Zeichenfolge |
| Nummer | Eindeutige Changeset-Nummer. Datentyp: Zeichenfolge |
| publish_option | Veröffentlichungsoption für die zugehörigen konfigurierten Snapshots. Gültige Werte:
Weitere Informationen zum Veröffentlichen von Snapshots finden Sie unter Veröffentlichen Sie einen Snapshot, oder heben Sie die Veröffentlichung auf . Datentyp: Zeichenfolge Standard: Publish_none |
| Status | Aktueller Status des Changesets. Mögliche Werte:
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. Datentyp: Zeichenfolge Format: JJJJ-mm-TT hh:mm:ss |
| sys_id | SYS_ID des Changesets. Datentyp: Zeichenfolge Tabelle: CDM-Änderungssatz [sn_cdm_changeset] |
| 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. Datentyp: Zeichenfolge Format: JJJJ-mm-TT hh:mm:ss |
| 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 innerhalb eines angegebenen Changesets ab.
URL-Format
Versionierte URL: /api/sn_cdm/{api_Version}/Changesets/Activity
Standard-URL: /api/sn_cdm/Changesets/activity
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| changesetNumber | Erforderlich. Eindeutiger Bezeichner des zugeordneten Changesets, z. B. „Chset-10“. Datentyp: Zeichenfolge Tabelle: CDM-Änderungssatz [sn_cdm_changeset] |
| returnFields | Liste der Felder, die als Teil der Antwort zurückgegeben werden sollen. Übergeben Sie die Namen der Datensatzspalte, z. B. sys_ID, sys_updated_by oder State. Datentyp: Array Standard: Alle Felder, wie vom Endpunkt bestimmt |
| 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 .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| 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 REST API-HTTP-Antwortcodes .
| 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 | Abfrage, die zum Aufrufen von verwendet werden soll Tabelle REST-Endpunkt zum Abrufen des zugeordneten Changesets. Datentyp: Zeichenfolge |
| changeset_ID.Wert | SYS_ID des zugeordneten Changesets. Datentyp: Zeichenfolge Tabelle: CDM-Änderungssatz [sn_cdm_changeset] |
| Konflikt | Kennzeichnung, die angibt, ob im zugehörigen Changeset ein Konflikt vorliegt. Gültige Werte:
Datentyp: Boolesch |
| erstellt | Datum und Uhrzeit der Erstellung des Knotens. Format: JJJJ-mm-TT hh:mm:ss Datentyp: Zeichenfolge |
| Erstellt_von | 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 | Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde. Datentyp: Zeichenfolge |
| Name_Pfad | 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 |
| Aktualisiert_von | Anwendername des Anwenders, der den Knoten zuletzt aktualisiert hat. Beispiel: Able.tuter. Datentyp: Zeichenfolge |
| Sicher | Kennzeichnung, die angibt, ob der zugehörige Blattknoten gesichert wurde. Gültige Werte:
Datentyp: Boolesch |
| type | Knotentyp. Mögliche Werte:
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
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Commit_ID | SYS_ID für die Commit-Anforderung, deren Status zurückgegeben werden soll. Dieser Wert wird von zurückgegeben CdmChangesetsApi – POST /sn_cdm/changesets/{changeset_ID}/commit Endpunkt. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| 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 .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| 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 REST API-HTTP-Antwortcodes .
| 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 Entspricht dem, der an den Endpunkt übergeben wurde. Datentyp: Zeichenfolge |
| Fehler | Beschreibung der Fehler, die während des Uploads 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 | 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 | Datum und Uhrzeit, zu der der hochgeladene Inhalt bestätigt wurde. Datentyp: Zeichenfolge |
| output.committed_by | SYS_ID des Datensatzes der Entität, die den Commit ausgeführt hat. Datentyp: Zeichenfolge |
| output.description | Derzeit nicht verwendet. Datentyp: Zeichenfolge |
| Output.Last_conflict_Detection_time | Aufruf der Konflikterkennung für Datum und Uhrzeit. Datentyp: Zeichenfolge |
| Ausgabe.Nummer | Eindeutige Nummer des Changesets. Datentyp: Zeichenfolge |
| Ausgabe.Publish_Option | Veröffentlichungsoption für die zugehörigen konfigurierten Snapshots. Gültige Werte:
Weitere Informationen zum Veröffentlichen von Snapshots finden Sie unter Veröffentlichen Sie einen Snapshot, oder heben Sie die Veröffentlichung auf . Datentyp: Zeichenfolge Standard: Publish_none |
| Ausgabe.Snapshot_description | Beschreibung des zugehörigen Snapshots. Datentyp: Zeichenfolge |
| Ausgabe.Snapshot_Name | Name des zugeordneten Snapshots. Datentyp: Zeichenfolge |
| Ausgabe.Status | Status des Upload-Inhalts. Mögliche Werte:
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:
Datentyp: Zeichenfolge |
| request_id | Anforderungs-ID. Entspricht dem, der an den Endpunkt und übergeben wurde commit_id. Datentyp: Zeichenfolge |
| Status | Aktueller Status des angegebenen Commits. Mögliche Werte:
Datentyp: Zeichenfolge Tabelle: Wert aus Statusspalte der Tabelle „CDM-Anforderungswarteschlange“ [sn_cdm_Request_Queue]. |
| type | Typ der Anforderung. Mögliche Werte:
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-proviyables
Gibt die Liste der bereitstellbaren Elemente zurück, die einem angegebenen Changeset zugeordnet sind.
Für den Zugriff auf diesen Endpunkt ist die CDM-Viewer-Rolle erforderlich.
URL-Format
Versionierte URL: /api/sn_cdm/{api_Version}/Changesets/Impact-provisionables
Standard-URL: /api/sn_cdm/Changesets/Impact-provisionables
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| changesetNumber | Erforderlich. Eindeutiger Bezeichner des zugeordneten Changesets, z. B. „Chset-10“. Datentyp: Zeichenfolge Tabelle: CDM-Änderungssatz [sn_cdm_changeset] |
| returnFields | Liste der Felder, die als Teil der Antwort zurückgegeben werden sollen. Übergeben Sie die Namen der Datensatzspalte, z. B. sys_ID, sys_updated_by oder State. Datentyp: Array Standard: Alle Felder, wie vom Endpunkt bestimmt |
| 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 .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| 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 REST API-HTTP-Antwortcodes .
| 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 (Configuration Data Items, CDIs), die in der zugehörigen CDM-Anwendung enthalten sind. Datentyp: Zahl (Ganzzahl) |
| cdi_usage | Prozentsatz der CDIs, die vom bereitstellbaren Element verwendet werden. Datentyp: Zahl (Ganzzahl) |
| cdm_App | CDM-Anwendungsobjekt, das dem bereitstellbaren Element zugeordnet ist. Datentyp: Objekt |
| cdm_App.Link | Aufruf zur Verwendung, um mit dem REST auf den CDM-Anwendungsdatensatz zuzugreifen Tabelle API. Datentyp: Zeichenfolge |
| cdm_App.value | SYS_ID des zugehörigen CDM-Anwendungsdatensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application] |
| cdm_ci | Anwendungsserviceobjekt, das dem bereitstellbaren Element zugeordnet ist. Datentyp: Objekt |
| cdm_ci.Link | Aufruf zur Verwendung, um mit dem REST auf den Anwendungsservice-Datensatz zuzugreifen Tabelle API. Datentyp: Zeichenfolge |
| cdm_ci.value | SYS_ID des zugehörigen Anwendungsservice-Datensatzes. Datentyp: Zeichenfolge Tabelle: Konfigurationselement [cmdb_ci] |
| Beschreibung | Beschreibung des generierten bereitstellbaren CDM. Datentyp: Zeichenfolge |
| Environment_type | Umgebungstyp des bereitstellbaren Elements. Mögliche Werte:
Datentyp: Zeichenfolge |
| Fehler | Wird nur zurückgegeben, wenn während der Verarbeitung ein Fehler aufgetreten ist. Datentyp: Objekt |
| error.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 |
| Knoten.Link | Aufruf zur Verwendung, um mit dem REST auf den Datensatz des bereitstellbaren Knotens zuzugreifen Tabelle API. Datentyp: Zeichenfolge |
| Knoten.Wert | SYS_ID des Datensatzes des bereitstellbaren Knotens. Datentyp: Zeichenfolge Tabelle: CDM bereitstellbar [sn_cdm_bereitstellbar] |
| Snapshot_Version_counter | Anzahl der Snapshots, die für das bereitstellbare Element erstellt wurden. Datentyp: Zahl (Ganzzahl) |
| Status | Aktueller Status des bereitstellbaren Elements. Mögliche Werte:
Datentyp: Zeichenfolge |
| sys_created_by | Anwendername des Anwenders, der das bereitstellbare CDM erstellt hat. Beispiel: Able.tuter. Datentyp: Zeichenfolge |
| sys_created_on | Datum und Uhrzeit der Erstellung des bereitstellbaren CDM-Elements. Datentyp: Zeichenfolge Format: JJJJ-mm-TT hh:mm:ss |
| sys_id | SYS_ID des erstellten bereitstellbaren Elements. Datentyp: Zeichenfolge Tabelle: CDM bereitstellbar [sn_cdm_bereitstellbar] |
| sys_updated_by | Anwendername des Anwenders, der das bereitstellbare CDM zuletzt aktualisiert hat. Beispiel: Able.tuter. Datentyp: Zeichenfolge |
| sys_updated_on | Datum und Uhrzeit der letzten Aktualisierung des bereitstellbaren CDM-Elements. Datentyp: Zeichenfolge Format: JJJJ-mm-TT hh:mm:ss |
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/Impact-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 CDM-Viewer-Rolle erforderlich.
URL-Format
Versionierte URL: /api/sn_cdm/{api_Version}/Changesets/Impact-Shared-components
Standard-URL: /api/sn_cdm/Changesets/Impact-Shared-components
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| changesetNumber | Erforderlich. |
| returnFields | Liste der Felder, die als Teil der Antwort zurückgegeben werden sollen. Übergeben Sie die Namen der Datensatzspalte, z. B. sys_ID, sys_updated_by oder State. Datentyp: Array Standard: Alle Felder, wie vom Endpunkt bestimmt |
| 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 .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| 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 REST API-HTTP-Antwortcodes .
| 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 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 | Details zum aufgetretenen Fehler. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Nachricht, die einen Überblick über den Fehler bietet. Datentyp: Zeichenfolge |
| name | Name der gemeinsam genutzten CDM-Komponente. Datentyp: Zeichenfolge |
| Knoten | SYS_ID des Knotens der gemeinsam genutzten Komponente. Datentyp: Zeichenfolge Tabelle: CDM-Knoten [sn_cdm_node] |
| Node_Main | SYS_ID der Main_ID des Knotendatensatzes der gemeinsam genutzten Komponente. Datentyp: Zeichenfolge Tabelle: CDM-Hauptknoten [sn_cdm_node_Main] |
| Status | Aktueller Status der gemeinsam genutzten Komponente. Mögliche Werte:
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. Datentyp: Zeichenfolge Tabelle: Gemeinsam genutzte CDM-Komponente [sn_cdm_Shared_component] |
| 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}/Impact-provisionables
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}/Impact-provisionables
Standard-URL: /api/sn_cdm/changesets/{changeset_ID}/Impact-provisionables
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| changeset_ID | SYS_ID des zu verarbeitenden Changeset-Datensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Änderungssatz [sn_cdm_changeset] |
| Name | Beschreibung |
|---|---|
| Keine |
| 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 .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| 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 REST API-HTTP-Antwortcodes .
| 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. Mögliche Werte:
Datentyp: Zahl |
| Conflict_type | Typ des Konflikts mit bereitstellbaren Elementen. Mögliche Werte:
Datentyp: Zeichenfolge |
| Beschreibung | Beschreibung des bereitstellbaren Knotens. Datentyp: Zeichenfolge |
| Effektiv_von | Zeitstempel, wenn der Knoten gültig ist. Dieser Wert ist Null Bis Sie ein Changeset bestätigen, in dem der Knoten erstellt wurde. Datentyp: Zahl |
| Effektiv_bis | Zeitstempel, wenn der Knoten nicht mehr gültig ist. Wenn dieser Wert ist Null , Der Knoten bleibt 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 | 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 ab Anwendungsebene, die 0 ist. Datentyp: Zahl |
| Linked_to | ID des Referenzknotens in einer Sammlung und Komponente. Das folgende Knotenausschnitt zeigt beispielsweise einen Link zwischen der Sammlungssammlung und der Komponentenkompa. Für dieses Beispiel die linkedToWert ist 1 : Datentyp: Zeichenfolge |
| Main_ID | Eindeutiger Bezeichner des bereitstellbaren Knotens. Dieser Wert wird generiert, wenn der Knoten erstellt und zur Identifizierung des bereitstellbaren Knotens verwendet wird. Datentyp: Zahl |
| Main_ID_encoded | Codierter Wert von mainIdErgebnisse mithilfe der Radix 57-Zeichenfolgendarstellung zurückgeben. Datentyp: Zeichenfolge |
| name | Name des bereitstellbaren Elements. Datentyp: Zeichenfolge |
| Node_Classifier | Knotenklassifizierung, z. B. Entwicklung, Produktion oder Test. Im Format:
Datentyp: Zeichenfolge |
| position | Position des bereitstellbaren Knotens. Gilt nur für Arrays. Beispiel: Für das Array:
{} ist Position 1000, „Literal1“ ist Position 2000, „Literal2“ ist Position 3000, [] ist Position 4000 Datentyp: Zahl |
| Vorherige_Version | SYS_ID der vorherigen Version des zugeordneten bereitstellbaren Knotens. Datentyp: Zeichenfolge |
| Restricted_to | Liste der sys_IDs der Anwender, die auf den zugehörigen bereitstellbaren Knoten zugreifen dürfen. Dieser Wert ist Null Wenn alle Gruppen auf das bereitstellbare Element zugreifen können. Datentyp: Zeichenfolge Tabelle: Eingeschränkte CDM-Gruppen [sn_cdm_Restricted_groups] |
| Secure_value | Sicherer Wert der CDI oder Variable. Wird nur für Blattknoten und Array-Literale zurückgegeben. Dies ist mit identisch valueErgebnis zurückgeben, aber verschlüsselt. Datentyp: Zeichenfolge |
| status | Status des bereitstellbaren Knotens oder Status einer fehlgeschlagenen Anforderung. Mögliche Werte:
Datentyp: Zeichenfolge |
| Systemordner | Kennzeichnung, die angibt, ob der zugeordnete Ordner ein Systemordner ist. Mögliche Werte:
Datentyp: Zahl |
| sys_id | SYS_ID des betroffenen bereitstellbaren Elements. Datentyp: Zeichenfolge |
| type | Knotentyp, z. B. sn_cdm_node_bereitstellbar. 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 Variable. Wird nur für Blattknoten und Array-Literale zurückgegeben. Wenn diese Informationen verschlüsselt sind, werden sie in zurückgegeben secure_valueErgebnis zurückgeben. Beispiel: Wenn dieser Knoten die CDI ist 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'
Folgendes 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
Commits des angegebenen Changesets. Nach dem Commit wird das Changeset in den CDM-Tabellen in der zugehörigen Instanz beibehalten.
Das System aktualisiert die Anwendung, um die Änderungen an den Konfigurationsdaten im Changeset beizubehalten. Der Changeset-Status ändert sich in Bestätigt . 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 anzurufen CdmChangesetsApi – GET /sn_cdm/changesets/commit-Status/{commit_ID} Endpunkt zum Abrufen des aktuellen Status des Changeset-Commits.
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
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| changeset_ID | SYS_ID des zu verarbeitenden Changeset-Datensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Änderungssatz [sn_cdm_changeset] |
| Name | Beschreibung |
|---|---|
| Automatisch validieren | Kennzeichnung, die angibt, ob die beim Commit erstellten Snapshots validiert werden, was bedeutet, dass alle zugehörigen Richtlinien für den Snapshot ausgeführt werden. Gültige Werte:
Standardwert: false |
| PublishOption | Veröffentlichungsoption für die zugehörigen Konfigurations-Snapshots. Gültige Werte:
Hinweis: Diese Option ist nur verfügbar, wenn der Wert für autoCommitParameter ist „wahr“. Weitere Informationen zum Veröffentlichen von Snapshots finden Sie unter Veröffentlichen Sie einen Snapshot, oder heben Sie die Veröffentlichung auf . Datentyp: Zeichenfolge Standard: Publish_none |
| 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 .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| 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 REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Fehler: <Error message> Validieren Sie, dass changeset_idDer von Ihnen übergebene Parameter war korrekt. 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 bestanden haben autoValidateParameter: 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, wenn Sie aufrufen CdmChangesetsApi – GET /sn_cdm/changesets/commit-Status/{commit_ID} Endpunkt zum Überprüfen des Status der Commit-Anforderung. Datentyp: Zeichenfolge |
| Fehler | Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler. Datentyp: Objekt |
| error.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 zu bestätigen.
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 wird die Antwort für eine erfolgreiche Changeset-Commit-Anforderung angezeigt.
// 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 gemeinsame 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
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| appName | Erforderlich. Name der CDM-Anwendung oder gemeinsamen Bibliothek, die diesem Changeset zugeordnet werden soll. Dies muss eine aktive Anwendung oder eine gemeinsame 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 |
| 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 .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| 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 REST API-HTTP-Antwortcodes .
| 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 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. |
Parameter des Antwort-Haupttexts
| Name | Beschreibung |
|---|---|
| auto_validate | Kennzeichnung, die angibt, ob die automatische Validierung durchgeführt wurde. Mögliche Werte:
Datentyp: Boolesch |
| cdm_Application | Details zur CDM-Anwendung, die dem Changeset zugeordnet ist. Datentyp: Objekt Beispiel: {"value": "<sysId>", "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 |
| Committete_at | Datum und Uhrzeit, zu der das Changeset für das zugehörige Repository festgelegt wurde. Datentyp: Zeichenfolge |
| Commit_by | SYS_ID der Entität, die das Changeset erstellt hat. Datentyp: Zeichenfolge |
| Beschreibung | Beschreibung des Changesets, wie übergeben, als der Endpunkt aufgerufen wurde. Datentyp: Zeichenfolge |
| Fehler | Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler. Datentyp: Objekt |
| error.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 zugehörigen konfigurierten Snapshots. Gültige Werte:
Weitere Informationen zum Veröffentlichen von Snapshots finden Sie unter Veröffentlichen Sie einen Snapshot, oder heben Sie die Veröffentlichung auf . Datentyp: Zeichenfolge Standard: Publish_none |
| snapshot_description | Beschreibung des Snapshots, der dem Changeset zugeordnet ist. Datentyp: Zeichenfolge |
| Status | Status der Changeset-Erstellung. Mögliche Werte:
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 CDM-Anwendung App Service1 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 wird die Antwort für eine erfolgreiche Erstellung des Changesets angezeigt.
// 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 Commits.
Das System aktualisiert die Anwendung, um die Änderungen an den Konfigurationsdaten im Changeset beizubehalten. Der Changeset-Status ändert sich in Bestätigt . 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 anzurufen CdmChangesetsApi – GET /sn_cdm/changesets/commit-Status/{commit_ID} Endpunkt zum Abrufen des aktuellen Status des Changeset-Commits.
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
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Automatisch validieren | Kennzeichnung, die angibt, ob die während des Commits erstellten Snapshots validiert werden, was bedeutet, dass alle zugehörigen Richtlinien für den Snapshot ausgeführt werden. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| changesetNumber | Erforderlich. Eindeutiger Bezeichner des zugeordneten Changesets, z. B. „Chset-10“. Datentyp: Zeichenfolge Tabelle: CDM-Änderungssatz [sn_cdm_changeset] |
| PublishOption | Veröffentlichungsoption für die zugehörigen konfigurierten Snapshots. Gültige Werte:
Weitere Informationen zum Veröffentlichen von Snapshots finden Sie unter Veröffentlichen Sie einen Snapshot, oder heben Sie die Veröffentlichung auf . Datentyp: Zeichenfolge Standard: Publish_none |
| 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 .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| 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 REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Fehler: <Error message> Validieren Sie, dass changeset_idDer von Ihnen übergebene Parameter war korrekt. 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 bestanden haben autoValidateParameter: 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, wenn Sie aufrufen CdmChangesetsApi – GET /sn_cdm/changesets/commit-Status/{commit_ID} Endpunkt zum Überprüfen des Status der Commit-Anforderung. Datentyp: Zeichenfolge |
| Fehler | Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler. Datentyp: Objekt |
| error.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"
}
}