CdmVersionApi
Die CdmVersionApi bietet Endpunkte, mit denen Sie Versionen (Snapshots) in Configuration Data Management (CDM) für gemeinsam genutzte Komponenten in gemeinsam genutzten Bibliotheken veröffentlichen, die Veröffentlichung aufheben und sie exportieren können.
Sie veröffentlichen einen Snapshot, damit er exportiert werden kann, sodass die Pipeline Kontinuierliche Integration und kontinuierliche Bereitstellung (CICD) auf die zugehörigen gemeinsam genutzten Komponenten und Bibliotheken zugreifen und sie verwenden kann. Exporter können nur für veröffentlichte Snapshots ausgeführt werden. Wenn Snapshots nicht mehr benötigt werden, können Sie die Veröffentlichung rückgängig machen, um die Verwirrung darüber zu verringern, ob der Snapshot noch funktionsfähig ist.
- Scripted REST CDM-Ansicht ACL (sn_cdm.cdm.viewer)
- Scripted REST CDM-Editor-ACL (sn_cdm.cdm_editor)
Darüber hinaus muss das Plugin Configuration Data Management (CDM) aktiviert sein, damit diese API in einer -Instanz verfügbar ist.
Weitere Informationen zu Snapshots finden Sie unter Snapshots anzeigen.
CdmVersionApi – GET /sn_cdm/versions/export
Gibt die Konfigurationsdaten für eine angegebene gemeinsam genutzte Komponente in einer angegebenen gemeinsam genutzten Bibliothek für eine angegebene veröffentlichte Version zurück.
Für den Zugriff auf diesen Endpunkt ist die Rolle „CDM-Editor“ erforderlich.
URL-Format
Versionierte URL: /api/sn_cdm/{api_version}/versions/export
Standard-URL: /api/sn_cdm/versions/export
Unterstützte Anforderungsparameter
| 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 |
| Name | Beschreibung |
|---|---|
| dataFormat | Erforderlich. Format der Konfigurationsdaten. Gültige Werte:
Datentyp: Zeichenfolge |
| entschlüsselnPasswort | Kennzeichnung, die angibt, ob codierte oder entschlüsselte Passwortwerte angezeigt werden sollen. Gültige Werte:
Standardwert: false |
| sharedComponentName | Erforderlich. Name der gemeinsam genutzten Komponente, deren Konfigurationsdaten exportiert werden sollen. Befindet sich in der Tabelle „Gemeinsam genutzte CDM-Komponente“ [sn_cdm_shared_component]. Datentyp: Zeichenfolge |
| sharedLibraryName | Erforderlich. Name der gemeinsam genutzten Bibliothek, die die Komponente enthält, deren Konfigurationsdaten Sie zurückgeben möchten. Befindet sich in der CDM-Anwendungstabelle [sn_cdm_application]. Für die angegebene Anwendung muss das Typfeld auf „shared_library“ festgelegt sein. Datentyp: Zeichenfolge |
| ersatzVariablen | Kennzeichnung, die angibt, ob die Variablen verfolgt werden sollen. Informationen zum Verfolgen der Variablen finden Sie unter Konfigurationsdaten validieren und korrigieren. Gültige Werte:
Standardwert: true |
| 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ützte Typen:
Standard: 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 HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Möglicherweise ist eines der folgenden Probleme aufgetreten:
|
| 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 |
|---|---|
| Ergebnis | Konfigurationsdaten im angegebenen Format. |
| Fehler | Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler. Datentyp: Objekt |
| Fehler.Detail | Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde. Datentyp: Zeichenfolge |
| status | Fehlerstatus der Anforderung. Mögliche Werte: Fehler Datentyp: Zeichenfolge |
cURL-Anforderung
Das folgende Codebeispiel zeigt, wie die Konfigurationsdaten der Komponente „jdk8“ unter der gemeinsam genutzten Bibliothek „JavaLib“ exportiert werden.
curl "http://instance.servicenow.com/api/sn_cdm/shared_libraries/components/exports?sharedLibraryName=JavaLib&componentName=jdk8
--request POST \
--header "Accept:application/json" \
--user 'username':'password'
Antwort:
{
"result": {
"sharedComponentA": { "cdi": "val" }
}
}
CdmVersionApi – PUT /sn_cdm/versions/publish
Veröffentlicht eine Version einer gemeinsam genutzten Komponente unter einer angegebenen gemeinsam genutzten Bibliothek.
Für den Zugriff auf diesen Endpunkt ist die Rolle „CDM-Editor“ erforderlich.
URL-Format
Versionierte URL: /api/sn_cdm/{api_version}/versions/publish
Standard-URL: /api/sn_cdm/versions/publish
Unterstützte Anforderungsparameter
| 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 |
| Name | Beschreibung |
|---|---|
| Name | Erforderlich. Name der Version der gemeinsam genutzten Komponente, die veröffentlicht werden soll. Befindet sich in der Tabelle „Gemeinsam genutzte CDM-Komponente“ [sn_cdm_shared_component]. Datentyp: Zeichenfolge |
| returnFields | Kommagetrennte Liste von Feldern in der Tabelle „CDM-Snapshot“ [sn_cdm_snapshot], die als Teil der Antwort zurückgegeben werden sollen. Datentyp: Zeichenfolge Standard: Gibt alle Nicht-Systemfelder zurück. |
| sharedComponentName | Erforderlich. Name der gemeinsam genutzten Komponente, die veröffentlicht werden soll. Befindet sich in der Tabelle „Gemeinsam genutzte CDM-Komponente“ [sn_cdm_shared_component]. Datentyp: Zeichenfolge |
| sharedLibraryName | Erforderlich. Name der gemeinsamen Bibliothek, in der sich die angegebene Komponente befindet. Befindet sich in der CDM-Anwendungstabelle [sn_cdm_application]. Das Typfeld im zugeordneten Datensatz muss auf „shared_library“ festgelegt werden. 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ützte Typen:
Standard: 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 HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Beim Veröffentlichen ist ein Fehler aufgetreten. Mögliche Probleme:
|
| 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_application_id | Details zur CDM-Anwendung, die dem Snapshot zugeordnet ist. Datentyp: Objekt |
| cdm_application_id.link | Rufen Sie auf, um mithilfe der REST- Tabellen -API auf den CDM-Anwendungsdatensatz zuzugreifen. Datentyp: Zeichenfolge |
| cdm_application_id.value | Sys_id des zugeordneten CDM-Anwendungsdatensatzes. Befindet sich in der CDM-Anwendungstabelle [sn_cdm_application]. Datentyp: Zeichenfolge |
| cdm_deployable_id | Details zum bereitstellbaren CDM, das dem Snapshot zugeordnet ist. Datentyp: Objekt |
| cdm_deployable_id.link | Ruft die Syntax zum Abfragen dieses bereitstellbaren Datensatzes mit der Tabellen -REST-API auf. Datentyp: Zeichenfolge |
| cdm_deployable_id.value | Sys_id des bereitstellbaren Datensatzes. Befindet sich in der Tabelle „Bereitstellbares CDM“ [sn_cdm_deployable]. Datentyp: Zeichenfolge |
| changeset_id | Details zum Changeset, das dem Snapshot zugeordnet ist. Datentyp: Objekt |
| changeset_id.link | Ruft die Syntax zum Abfragen dieses Changeset-Datensatzes mit der Tabellen -REST-API auf. Datentyp: Zeichenfolge |
| changeset_id.value | Eindeutiger Bezeichner des Changeset-Datensatzes. Befindet sich in der Tabelle „CDM-Änderungssatz“ [sn_cdm_changeset]. Datentyp: Zeichenfolge |
| Beschreibung | Kurze Beschreibung des Snapshots. Datentyp: Zeichenfolge |
| Fehler | Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler. Datentyp: Objekt |
| Fehler.Detail | Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde. Datentyp: Zeichenfolge |
| last_published | Datum und Uhrzeit der letzten Veröffentlichung des Snapshots. Datentyp: Zeichenfolge Format: jjjj-mm-tt hh:mm:ss |
| last_validated | Datum und Uhrzeit der letzten Validierung des Snapshots. Datentyp: Zeichenfolge Format: jjjj-mm-tt hh:mm:ss |
| Name | Name des Snapshots Datentyp: Zeichenfolge |
| Nummer | Eindeutige Nummer, die den Snapshot identifiziert. Dieser Wert stellt einen visuell lesbaren Bezeichner für die Zuordnung bereit. Datentyp: Zeichenfolge |
| Veröffentlicht | Kennzeichnung, die angibt, ob der Snapshot veröffentlicht wurde. Mögliche Werte:
Datentyp: Boolesch |
| sys_created_by | Name des Benutzers, der den Snapshot erstellt hat. Datentyp: Zeichenfolge |
| sys_created_on | Datum und Uhrzeit der Erstellung des Snapshots. Datentyp: Zeichenfolge Format: jjjj-mm-tt hh:mm:ss |
| sys_id | Sys_id des Snapshots. Befindet sich in der Tabelle „CDM-Snapshot“ [sn_cdm_snapshot]. Datentyp: Zeichenfolge |
| sys_updated_by | Name des Benutzers, der den Snapshot aktualisiert hat. Datentyp: Zeichenfolge |
| sys_updated_on | Datum und Uhrzeit der letzten Aktualisierung des Snapshots. Datentyp: Zeichenfolge Format: jjjj-mm-tt hh:mm:ss |
| Validierung | Aktueller Validierungsstatus des Snapshots. Mögliche Werte:
Datentyp: Zeichenfolge |
cURL-Anforderung
Dieses Codebeispiel zeigt, wie die gemeinsam genutzte Komponente „Development“ mit dem Versionsnamen „Development-v1.shc“ veröffentlicht wird.
curl "http://instance.servicenow.com/api/sn_cdm/versions/publish?sharedLibraryName=LibraryJdk&componentName=Development&name=Development-v1.shc" \
--request PUT\
--header "Accept:application/json" \
--user 'username':'password
Antwort:
{
"result": {
"changeset_id": {
"value": "1a2bd15c7764a1109ac0cf0bbb5a99fc",
"link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/1a2bd15c7764a1109ac0cf0bbb5a99fc"
},
"cdm_deployable_id": null,
"cdm_shared_component_node_id": {
"value": "fe2b155c7764a1109ac0cf0bbb5a995d",
"link": "http://instance.servicenow.com/api/now/table/sn_cdm_node/fe2b155c7764a1109ac0cf0bbb5a995d"
},
"cdm_shared_component_id": {
"value": "362b155c7764a1109ac0cf0bbb5a9970",
"link": "http://instance.servicenow.com/api/now/table/sn_cdm_shared_component/362b155c7764a1109ac0cf0bbb5a9970"
},
"description": null,
"cdm_application_id": {
"value": "122bd15c7764a1109ac0cf0bbb5a99fa",
"link": "http://instance.servicenow.com/api/now/table/sn_cdm_application/122bd15c7764a1109ac0cf0bbb5a99fa"
},
"published": true,
"sys_updated_on": "2023-01-18 14:15:44",
"last_published": "2023-01-18 09:53:37",
"sequence_number": "1",
"number": "SNAP0001110",
"sys_id": "df2b155c7764a1109ac0cf0bbb5a9949",
"sys_updated_by": "admin",
"sys_created_on": "2023-01-18 09:53:36",
"name": "logonService-V2.1-v1.shc",
"last_validated": "",
"validation": "passed",
"sys_created_by": "admin"
}
}
CdmVersionApi – PUT /sn_cdm/versions/unpublish
Hebt die Veröffentlichung einer Version einer gemeinsam genutzten Komponente in einer angegebenen gemeinsam genutzten Bibliothek auf.
Für den Zugriff auf diesen Endpunkt ist die Rolle „CDM-Editor“ erforderlich.
URL-Format
Versionierte URL: /api/sn_cdm/{api_version}/versions/publish
Standard-URL: /api/sn_cdm/versions/publish
Unterstützte Anforderungsparameter
| 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 |
| Name | Beschreibung |
|---|---|
| Name | Erforderlich. Name der Version der gemeinsam genutzten Komponente, deren Veröffentlichung aufgehoben werden soll. Befindet sich in der Tabelle „Gemeinsam genutzte CDM-Komponente“ [sn_cdm_shared_component]. Datentyp: Zeichenfolge |
| returnFields | Kommagetrennte Liste von Feldern in der Tabelle „CDM-Snapshot“ [sn_cdm_snapshot], die als Teil der Antwort zurückgegeben werden sollen. Datentyp: Zeichenfolge Standard: Gibt alle Nicht-Systemfelder zurück. |
| sharedComponentName | Erforderlich. Name der gemeinsam genutzten Komponente, deren Veröffentlichung aufgehoben werden soll. Befindet sich in der Tabelle „Gemeinsam genutzte CDM-Komponente“ [sn_cdm_shared_component]. Datentyp: Zeichenfolge |
| sharedLibraryName | Erforderlich. Name der gemeinsamen Bibliothek, in der sich die angegebene Komponente befindet. Befindet sich in der CDM-Anwendungstabelle [sn_cdm_application]. Das Typfeld im zugeordneten Datensatz muss auf „shared_library“ festgelegt werden. 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ützte Typen:
Standard: 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 HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Beim Aufheben der Veröffentlichung ist ein Fehler aufgetreten. Mögliche Probleme:
|
| 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_application_id | Details zur CDM-Anwendung, die dem Snapshot zugeordnet ist. Datentyp: Objekt |
| cdm_application_id.link | Rufen Sie auf, um mithilfe der REST- Tabellen -API auf den CDM-Anwendungsdatensatz zuzugreifen. Datentyp: Zeichenfolge |
| cdm_application_id.value | Sys_id des zugeordneten CDM-Anwendungsdatensatzes. Befindet sich in der CDM-Anwendungstabelle [sn_cdm_application]. Datentyp: Zeichenfolge |
| cdm_deployable_id | Details zum bereitstellbaren CDM, das dem Snapshot zugeordnet ist. Datentyp: Objekt |
| cdm_deployable_id.link | Ruft die Syntax zum Abfragen dieses bereitstellbaren Datensatzes mit der Tabellen -REST-API auf. Datentyp: Zeichenfolge |
| cdm_deployable_id.value | Sys_id des bereitstellbaren Datensatzes. Befindet sich in der Tabelle „Bereitstellbares CDM“ [sn_cdm_deployable]. Datentyp: Zeichenfolge |
| changeset_id | Details zum Changeset, das dem Snapshot zugeordnet ist. Datentyp: Objekt |
| changeset_id.link | Ruft die Syntax zum Abfragen dieses Changeset-Datensatzes mit der Tabellen -REST-API auf. Datentyp: Zeichenfolge |
| changeset_id.value | Eindeutiger Bezeichner des Changeset-Datensatzes. Befindet sich in der Tabelle „CDM-Änderungssatz“ [sn_cdm_changeset]. Datentyp: Zeichenfolge |
| Beschreibung | Kurze Beschreibung des Snapshots. Datentyp: Zeichenfolge |
| Fehler | Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler. Datentyp: Objekt |
| Fehler.Detail | Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde. Datentyp: Zeichenfolge |
| last_published | Datum und Uhrzeit der letzten Veröffentlichung des Snapshots. Datentyp: Zeichenfolge Format: jjjj-mm-tt hh:mm:ss |
| last_validated | Datum und Uhrzeit der letzten Validierung des Snapshots. Datentyp: Zeichenfolge Format: jjjj-mm-tt hh:mm:ss |
| Name | Name des Snapshots Datentyp: Zeichenfolge |
| Nummer | Eindeutige Nummer, die den Snapshot identifiziert. Dieser Wert stellt einen visuell lesbaren Bezeichner für die Zuordnung bereit. Datentyp: Zeichenfolge |
| Veröffentlicht | Kennzeichnung, die angibt, ob der Snapshot veröffentlicht wurde. Mögliche Werte:
Datentyp: Boolesch |
| sys_created_by | Name des Benutzers, der den Snapshot erstellt hat. Datentyp: Zeichenfolge |
| sys_created_on | Datum und Uhrzeit der Erstellung des Snapshots. Datentyp: Zeichenfolge Format: jjjj-mm-tt hh:mm:ss |
| sys_id | Sys_id des Snapshots. Befindet sich in der Tabelle „CDM-Snapshot“ [sn_cdm_snapshot]. Datentyp: Zeichenfolge |
| sys_updated_by | Name des Benutzers, der den Snapshot aktualisiert hat. Datentyp: Zeichenfolge |
| sys_updated_on | Datum und Uhrzeit der letzten Aktualisierung des Snapshots. Datentyp: Zeichenfolge Format: jjjj-mm-tt hh:mm:ss |
| Validierung | Aktueller Validierungsstatus des Snapshots. Mögliche Werte:
Datentyp: Zeichenfolge |
cURL-Anforderung
Das folgende Codebeispiel zeigt, wie die Veröffentlichung der gemeinsam genutzten Komponente „paymentService-V1“ in der gemeinsam genutzten Bibliothek „OracleG-Bibliothek-10“ aufgehoben wird.
curl "https://instance-name.service-now.com/api/sn_cdm/versions/unpublish?sharedLibraryName=OracleG-Library-10&sharedComponentName=paymentService-V1.1&name=paymentService-V1.1-v1.shc" \
--request PUT \
--header "Accept:application/json" \
--user 'username':'password'
Antwort:
{
"result": {
"changeset_id": {
"value": "1a2bd15c7764a1109ac0cf0bbb5a99fc",
"link": "http://192.168.0.129:8080/api/now/table/sn_cdm_changeset/1a2bd15c7764a1109ac0cf0bbb5a99fc"
},
"cdm_deployable_id": null,
"cdm_shared_component_node_id": {
"value": "fe2b155c7764a1109ac0cf0bbb5a995d",
"link": "http://192.168.0.129:8080/api/now/table/sn_cdm_node/fe2b155c7764a1109ac0cf0bbb5a995d"
},
"cdm_shared_component_id": {
"value": "362b155c7764a1109ac0cf0bbb5a9970",
"link": "http://192.168.0.129:8080/api/now/table/sn_cdm_shared_component/362b155c7764a1109ac0cf0bbb5a9970"
},
"description": null,
"cdm_application_id": {
"value": "122bd15c7764a1109ac0cf0bbb5a99fa",
"link": "http://192.168.0.129:8080/api/now/table/sn_cdm_application/122bd15c7764a1109ac0cf0bbb5a99fa"
},
"published": false,
"sys_updated_on": "2023-01-18 14:15:44",
"last_published": "2023-01-18 09:53:37",
"sequence_number": "1",
"number": "SNAP0001110",
"sys_id": "df2b155c7764a1109ac0cf0bbb5a9949",
"sys_updated_by": "admin",
"sys_created_on": "2023-01-18 09:53:36",
"name": "logonService-V2.1-v1.shc",
"last_validated": "",
"validation": "passed",
"sys_created_by": "admin"
}
}