CdmVersionApi
Die CdmVersionApi Stellt Endpunkte bereit, mit denen Sie Versionen (Snapshots) in veröffentlichen, ihre Veröffentlichung rückgängig machen und exportieren können Konfigurationsdaten-Management(CDM) für gemeinsam genutzte Komponenten in gemeinsam genutzten Bibliotheken.
Sie veröffentlichen einen Snapshot, damit er exportiert werden kann, wodurch aktiviert wird Kontinuierliche Integration und kontinuierliche Bereitstellung (CICD) Pipeline für den Zugriff auf die zugehörigen gemeinsam genutzten Komponenten und Bibliotheken. Exporter können nur für veröffentlichte Snapshots ausgeführt werden. Wenn Snapshots nicht mehr benötigt werden, können Sie ihre Veröffentlichung rückgängig machen, um die Verwirrung hinsichtlich der Eignung des Snapshots zu verringern.
- 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 Snapshots finden Sie unter Zeigen Sie Snapshots an .
CdmVersionApi – GET /sn_cdm/versions/Export
Gibt die Konfigurationsdaten für eine angegebene gemeinsam genutzte Komponente in einer angegebenen gemeinsamen 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. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Datenformat | Erforderlich. Format der Konfigurationsdaten. Gültige Werte:
Datentyp: Zeichenfolge |
| Entschlüsseln Sie das Passwort | 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. Datentyp: Zeichenfolge Tabelle: Gemeinsam genutzte CDM-Komponente [sn_cdm_Shared_component] |
| sharedLibraryName | Erforderlich. Name der gemeinsamen Bibliothek, die die Komponente enthält, deren Konfigurationsdaten Sie zurückgeben möchten. Für die angegebene Anwendung muss das Typfeld auf „Shared_Library“ festgelegt sein. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application] |
| SubstituteVariables | Kennzeichnung, die angibt, ob die Variablen verfolgt werden sollen. Informationen zum Befolgen der Variablen finden Sie unter Validieren und Korrigieren von Konfigurationsdaten . Gültige Werte:
Standardwert: wahr |
| 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 REST API-HTTP-Antwortcodes .
| 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 |
| error.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“ in der gemeinsamen 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/published
Veröffentlicht eine Version einer gemeinsam genutzten Komponente in einer angegebenen gemeinsamen Bibliothek.
Für den Zugriff auf diesen Endpunkt ist die Rolle „CDM-Editor“ erforderlich.
URL-Format
Versionierte URL: /api/sn_cdm/{api_Version}/versions/published
Standard-URL: /api/sn_cdm/versions/published
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 |
|---|---|
| name | Erforderlich. Name der Version der freigegebenen Komponente, die veröffentlicht werden soll. Datentyp: Zeichenfolge Tabelle: Gemeinsam genutzte CDM-Komponente [sn_cdm_Shared_component] |
| returnFields | Kommagetrennte Liste von Feldern in der CDM-Snapshot-Tabelle [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 freigegebenen Komponente, die veröffentlicht werden soll. Datentyp: Zeichenfolge Tabelle: Gemeinsam genutzte CDM-Komponente [sn_cdm_Shared_component] |
| sharedLibraryName | Erforderlich. Name der gemeinsamen Bibliothek, in der sich die angegebene Komponente befindet. Das Typfeld im zugehörigen Datensatz muss auf „Shared_Library“ festgelegt werden. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application] |
| 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 REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Fehler beim Veröffentlichen. 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 | Aufruf zur Verwendung, um mit dem REST auf den CDM-Anwendungsdatensatz zuzugreifen Tabelle API. Datentyp: Zeichenfolge |
| cdm_Application_ID.Wert | SYS_ID des zugehörigen CDM-Anwendungsdatensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application] |
| cdm_bereitstellbare_ID | Details zum bereitstellbaren CDM-Element, das dem Snapshot zugeordnet ist. Datentyp: Objekt |
| cdm_bereitstellbar_ID.Link | Aufrufsyntax zum Abfragen dieses bereitstellbaren Datensatzes mit Tabelle REST-API. Datentyp: Zeichenfolge |
| cdm_bereitstellbar_ID.Wert | SYS_ID des bereitstellbaren Datensatzes. Datentyp: Zeichenfolge Tabelle: CDM bereitstellbar [sn_cdm_bereitstellbar] |
| changeset_ID | Details zum Changeset, das dem Snapshot zugeordnet ist. Datentyp: Objekt |
| changeset_ID.Link | Aufrufsyntax zum Abfragen dieses Changeset-Datensatzes mit Tabelle REST-API. Datentyp: Zeichenfolge |
| changeset_ID.Wert | Eindeutiger Bezeichner des Changeset-Datensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Änderungssatz [sn_cdm_changeset] |
| Beschreibung | Kurze Beschreibung des Snapshots. 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_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 Anwenders, 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. Datentyp: Zeichenfolge Tabelle: CDM-Snapshot [sn_cdm_Snapshot] |
| sys_updated_by | Name des Anwenders, 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 „Entwicklung“ 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: /sn_cdm/versions/unpublished EINFÜGEN
Hebt die Veröffentlichung einer Version einer gemeinsam genutzten Komponente in einer angegebenen gemeinsamen 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/published
Standard-URL: /api/sn_cdm/versions/published
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 |
|---|---|
| name | Erforderlich. Name der Version der freigegebenen Komponente, deren Veröffentlichung aufgehoben werden soll. Datentyp: Zeichenfolge Tabelle: Gemeinsam genutzte CDM-Komponente [sn_cdm_Shared_component] |
| returnFields | Kommagetrennte Liste von Feldern in der CDM-Snapshot-Tabelle [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 freigegebenen Komponente, deren Veröffentlichung aufgehoben werden soll. Datentyp: Zeichenfolge Tabelle: Gemeinsam genutzte CDM-Komponente [sn_cdm_Shared_component] |
| sharedLibraryName | Erforderlich. Name der gemeinsamen Bibliothek, in der sich die angegebene Komponente befindet. Das Typfeld im zugehörigen Datensatz muss auf „Shared_Library“ festgelegt werden. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application] |
| 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 REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Fehler beim Aufheben der Veröffentlichung. 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 | Aufruf zur Verwendung, um mit dem REST auf den CDM-Anwendungsdatensatz zuzugreifen Tabelle API. Datentyp: Zeichenfolge |
| cdm_Application_ID.Wert | SYS_ID des zugehörigen CDM-Anwendungsdatensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application] |
| cdm_bereitstellbare_ID | Details zum bereitstellbaren CDM-Element, das dem Snapshot zugeordnet ist. Datentyp: Objekt |
| cdm_bereitstellbar_ID.Link | Aufrufsyntax zum Abfragen dieses bereitstellbaren Datensatzes mit Tabelle REST-API. Datentyp: Zeichenfolge |
| cdm_bereitstellbar_ID.Wert | SYS_ID des bereitstellbaren Datensatzes. Datentyp: Zeichenfolge Tabelle: CDM bereitstellbar [sn_cdm_bereitstellbar] |
| changeset_ID | Details zum Changeset, das dem Snapshot zugeordnet ist. Datentyp: Objekt |
| changeset_ID.Link | Aufrufsyntax zum Abfragen dieses Changeset-Datensatzes mit Tabelle REST-API. Datentyp: Zeichenfolge |
| changeset_ID.Wert | Eindeutiger Bezeichner des Changeset-Datensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Änderungssatz [sn_cdm_changeset] |
| Beschreibung | Kurze Beschreibung des Snapshots. 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_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 Anwenders, 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. Datentyp: Zeichenfolge Tabelle: CDM-Snapshot [sn_cdm_Snapshot] |
| sys_updated_by | Name des Anwenders, 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“ aus der gemeinsamen Bibliothek „OracleG-Library-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"
}
}