CdmSharedLibraryApi

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

    • Die CdmSharedLibraryApi stellt Endpunkte bereit, mit denen Sie gemeinsam genutzte Bibliotheken und gemeinsam genutzte Komponenten erstellen und verwalten können. Sie verfügt auch über Endpunkte, mit denen Sie die Konfigurationsdaten einer gemeinsam genutzten Komponente hochladen und exportieren können.

    Diese API erfordert die Aktivierung des Plugins Configuration Data Management (CDM), damit diese APIs in der Instanz verfügbar sind. Darüber hinaus müssen Sie über eine der folgenden Rollen verfügen, um auf diese API zugreifen zu können:
    • Rolle „CDM-Editor“.
    • CDM-Administratorrolle

    Weitere Informationen zu gemeinsam genutzten Bibliotheken und gemeinsam genutzten Komponenten finden Sie unter Komponenten in Anwendungen gemeinsam nutzen – Komponentenbibliotheken.

    CdmSharedLibraryApi – DELETE /sn_cdm/shared_libraries

    Löscht die gemeinsam genutzte Bibliothek mit dem angegebenen Namen.

    Für den Zugriff auf diesen Endpunkt ist die CDM-Administratorrolle erforderlich.

    URL-Format

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

    Standard-URL: /api/sn_cdm/shared_libraries

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 3. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Name Erforderlich. Name der zu löschenden gemeinsamen Bibliothek. Befindet sich in der CDM-Anwendungstabelle [sn_cdm_application].

    Datentyp: Zeichenfolge

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.

    Tabelle : 4. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts.

    Unterstützte Typen:

    • application/json
    • application/xml
    • text/xml

    Standard: application/json
    Tabelle : 5. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

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

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

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Fehler Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler.

    Datentyp: Objekt

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

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

    Datentyp: Zeichenfolge
    status Fehlerstatus der Anforderung.

    Mögliche Werte: Fehler

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie Sie die gemeinsam genutzte Bibliothek „javalib“ löschen.

    curl "http://instance.servicenow.com/sn_cdm/shared_libraries?name='javalib'\ 
--request DELETE\ 
--header "Accept:application/json" \ 
--user 'username':'password'

    Antwort:

    ""

    CdmSharedLibraryApi – DELETE /sn_cdm/shared_libraries/components

    Löscht die angegebene gemeinsam genutzte Komponente aus der angegebenen Bibliothek.

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

    Hinweis:
    Sie können eine Komponente nur löschen, wenn sie derzeit nicht verwendet wird. Außerdem können Sie eine Komponente nicht löschen, wenn die zugehörige gemeinsame Bibliothek nicht aktiv ist.

    URL-Format

    Versionierte URL: /api/sn_cdm/{api_version}/shared_libraries/components

    Standard-URL: /api/sn_cdm/shared_libraries/components

    Unterstützte Anforderungsparameter

    Tabelle : 7. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 8. Abfrageparameter
    Name Beschreibung
    changesetNumber Erforderlich. Nummer des Changesets, das der Komponente zugeordnet ist. Befindet sich in der Tabelle „CDM-Änderungssatz“ [sn_cdm_changeset].

    Datentyp: Zeichenfolge
    Name Erforderlich. Name der zu löschenden gemeinsam genutzten Komponente. 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 zu löschende Komponente befindet. Befindet sich in der CDM-Anwendungstabelle [sn_cdm_application].

    Datentyp: Zeichenfolge
    Tabelle : 9. Anforderungstextparameter
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.

    Tabelle : 10. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts.

    Unterstützte Typen:

    • application/json
    • application/xml
    • text/xml

    Standard: application/json
    Tabelle : 11. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

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

    Tabelle : 12. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung.
    Mögliche Probleme:
    • Gemeinsame Bibliothek ist nicht vorhanden.
    • Gemeinsame Bibliothek ist nicht aktiv.
    • Gemeinsam genutzte Komponente wird verwendet. Kann nicht gelöscht werden.
    • Der Benutzer darf die gemeinsam genutzte Komponente nicht löschen.
    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
    Fehler Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler.

    Datentyp: Objekt

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

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

    Datentyp: Zeichenfolge
    status Fehlerstatus der Anforderung.

    Mögliche Werte: Fehler

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie die Komponente „TestComponent“ unter der gemeinsam genutzten Bibliothek „javalib“ gelöscht wird.

    curl "http://instance.servicenow.com/sn_cdm/shared_libraries/components?sharedLibraryName='javalib&changesetNumber='chset-8'&name='TestComponent'\ 
--request DELETE\ 
--header "Accept:application/json" \ 
--user 'username':'password'

    Antwort:

    ""

    CdmSharedLibraryApi – GET /sn_cdm/shared_libraries/upload-status/{upload-id}

    Gibt den aktuellen Status der angegebenen Upload-Anforderung für die gemeinsame Bibliothek zurück.

    URL-Format

    Versionierte URL: /api/sn_cdm/{api_version}/shared_libraries/upload-status/{upload-id}

    Standard-URL: /api/sn_cdm/shared_libraries/upload-status/{upload-id}

    Unterstützte Anforderungsparameter

    Tabelle : 13. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Upload-ID Sys_id der Upload-Anforderung, deren Status zurückgegeben werden soll. Dieser Wert wird von verschiedenen CdmSharedLibrary-Upload-Anforderungsendpunkten zurückgegeben.

    Datentyp: Zeichenfolge
    Tabelle : 14. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 15. Anforderungstextparameter
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.

    Tabelle : 16. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts.

    Unterstützte Typen:

    • application/json
    • application/xml
    • text/xml

    Standard: application/json
    Tabelle : 17. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

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

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

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Fehler Beschreibung der Fehler, die beim Upload aufgetreten sind.

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

    Datentyp: Array von Zeichenfolge

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

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

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

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

    Datentyp: Zeichenfolge
    Ausgabe.Beschreibung Derzeit nicht verwendet.

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

    Datentyp: Zeichenfolge
    Ausgabe.Nummer Eindeutiger Identifizierungswert des Changesets, z. B. Chset-124.

    Datentyp: Zeichenfolge
    Ausgabe.veröffentlichen_option Wert der Veröffentlichungsoption, der im zugeordneten Upload-Aufruf übergeben wird.

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

    Datentyp: Zeichenfolge
    ausgabe.freigegebenBibliothekName Name der gemeinsamen Bibliothek, wie im ursprünglichen Upload-Aufruf übergeben.

    Datentyp: Zeichenfolge
    Ausgabe.snapshot_description Beschreibung des zugeordneten Snapshots.

    Datentyp: Zeichenfolge
    Ausgabe.snapshot_name Name des zugeordneten Snapshots.

    Datentyp: Zeichenfolge
    Ausgabe.Status Status des Uploads.
    Mögliche Werte:
    • ABGESCHLOSSEN: Upload wurde abgeschlossen.
    • EXIREDRROR: Fehler beim Verarbeiten der Upload-Anforderung. Der Auftrag wurde mehr als 15 Minuten ausgeführt und vom System beendet.
    • IN_PROGRESS: Upload wird ausgeführt.
    • NEU: Die Verarbeitung wurde noch nicht gestartet.
    • BEREIT: Anforderung wurde in die Warteschlange gestellt.

    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 Upload-Anforderung.

    Mögliche Werte: VERARBEITET

    Datentyp: Zeichenfolge
    Status Aktueller Status der Upload-Anforderung.
    Mögliche Werte:
    • abgeschlossen
    • Fehler
    type Typ der Upload-Anforderung.

    Mögliche Werte: Upload_and_commit

    Datentyp: Zeichenfolge
    hochgeladene ID Sys_id des Datensatzes, der die hochgeladene Konfigurationsnutzlast enthält.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Dieses Codebeispiel zeigt, wie der Status für die Upload-ID 0d91d9891b2b19109524cae0604bcbe6 angefordert wird.

    curl "http://instance.servicenow.com/api/sn_cdm/shared_libraries/upload-status/0d91d9891b2b19109524cae0604bcbe6" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Antwort:

    // Successful response
{
  "result": {
    "type": "upload_and_commit",
    "state": "completed",
    "output": {
      "sys_id": "0002ea107768a1109ac0cf0bbb5a9963",
      "number": "Chset-457",
      "title": "admin8802ea107768a1109ac0cf0bbb5a9962",
      "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": "OracleG-Library-15",
      "last_conflict_detection_time": null
    },
    "processing_state": "PROCESSED",
    "upload_id": "00b226547768a1109ac0cf0bbb5a99f2"
  }
}

// Error response
{
  "result": {
    "type": "upload_and_commit",
    "state": "error",
    "output": "Error: Application with sys_id 87fb1ecb1be3111050fc21b0604bcb95 is in State Deleted. No data can be modified on deleted applications",
    "processing_state": "PROCESSED",
    "upload_id": "fcdfaf7f1b88211050fc21b0604bcb79"
  }
}

    CdmSharedLibraryApi – POST /sn_cdm/shared_libraries

    Erstellt eine neue gemeinsam genutzte Bibliothek mit dem angegebenen Namen.

    Für den Zugriff auf diesen Endpunkt ist die CDM-Administratorrolle erforderlich.

    URL-Format

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

    Standard-URL: /api/sn_cdm/shared_libraries

    Unterstützte Anforderungsparameter

    Tabelle : 19. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 20. Abfrageparameter
    Name Beschreibung
    Beschreibung Beschreibung der gemeinsamen Bibliothek.

    Datentyp: Zeichenfolge

    Standard: Leer
    Name Erforderlich. Name der zu erstellenden gemeinsamen Bibliothek. Dieser Name muss für alle CDM-Anwendungen und -Bibliotheken eindeutig sein.

    Datentyp: Zeichenfolge
    returnFields Kommagetrennte Liste von Feldern, die als Teil der Antwort zurückgegeben werden sollen. Befindet sich in der CDM-Anwendungstabelle [sn_cdm_application].

    Datentyp: Zeichenfolge

    Standard: Alle Nicht-Systemfelder werden zurückgegeben.
    userGroupIds Kommagetrennte Liste von sys_ids der Benutzergruppen, die die zugeordnete gemeinsame Bibliothek bearbeiten können. Alle Benutzer mit den richtigen Rollen können die gemeinsame Bibliothek anzeigen. Befindet sich in der Gruppentabelle [sys_user_group].

    Datentyp: Zeichenfolge

    Standard: Alle Benutzer mit der Rolle „CDM-Editor“ können Daten in der gemeinsamen Bibliothek bearbeiten.
    Tabelle : 21. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.

    Tabelle : 22. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts.

    Unterstützte Typen:

    • application/json
    • application/xml
    • text/xml

    Standard: application/json
    Tabelle : 23. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

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

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

    Parameter des Antwort-Haupttexts

    Name Beschreibung
    <fields> Angeforderte Felder aus der Tabelle „CDM-Anwendung“ [sn_cdm_application].

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

    Datentyp: Objekt

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

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

    Datentyp: Zeichenfolge
    status Fehlerstatus der Anforderung.

    Mögliche Werte: Fehler

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird, um die gemeinsam genutzte Bibliothek Java11Lib zu erstellen, in der alle Benutzergruppen auf die Bibliothek zugreifen können.

    curl "http://instance.servicenow.com/api/sn_cdm/shared_libraries?name=Java11Lib&description=The%20new%20java%20library" \ 
--request POST \ 
--header "Accept:application/json" \ 
--user 'userName':'password

    Antwort:

    {
  "result": {
    "sdlc_component": null,
    "cdi_count": "0",
    "available": false,
    "description": "Description of LibraryA",
    "managed_by_group": null,
    "sys_updated_on": "2023-01-18 11:34:43",
    "type": "shared_library",
    "node": {
      "value": "d852b15877a4a1109ac0cf0bbb5a99aa",
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_node/d852b15877a4a1109ac0cf0bbb5a99aa"
    },
    "sys_id": "185235dc77a4a1109ac0cf0bbb5a994e",
    "sys_updated_by": "admin",
    "node_main": {
      "value": "1852b15877a4a1109ac0cf0bbb5a99aa",
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_node_main/1852b15877a4a1109ac0cf0bbb5a99aa"
    },
    "sys_created_on": "2023-01-18 11:34:43",
    "cdi_usage": "0",
    "name": "LibraryA",
    "last_committed_changeset": {
      "value": "9052b15877a4a1109ac0cf0bbb5a99aa",
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/9052b15877a4a1109ac0cf0bbb5a99aa"
    },
    "state": "active",
    "sys_created_by": "admin"
  }
}

    CdmSharedLibraryApi – POST /sn_cdm/shared_libraries/components

    Erstellt die angegebene gemeinsam genutzte Komponente unter der angegebenen Bibliothek.

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

    URL-Format

    Versionierte URL: /api/sn_cdm/{api_version}/shared_libraries/components

    Standard-URL: /api/sn_cdm/shared_libraries/components

    Unterstützte Anforderungsparameter

    Tabelle : 25. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 26. Abfrageparameter
    Name Beschreibung
    changesetNumber Erforderlich.
    Eindeutiger Bezeichner des zugeordneten Changesets, z. B. „Chset-10“. Befindet sich in der Tabelle „CDMChangeset“ [sn_cdm_changeset].

    Datentyp: Zeichenfolge
    Beschreibung Beschreibung der gemeinsam genutzten Komponente.

    Datentyp: Zeichenfolge
    Name Erforderlich. Name der gemeinsam genutzten Komponente, die in der gemeinsamen Bibliothek erstellt werden soll. Dieser Name muss eindeutig sein.

    Datentyp: Zeichenfolge
    returnFields Kommagetrennte Liste von Feldern in der Tabelle „CDM-Knoten“ [sn_cdm_node], die als Teil der Antwort zurückgegeben werden sollen.

    Datentyp: Zeichenfolge

    Standard: Alle nicht internen Felder werden zurückgegeben.
    sharedLibraryName Erforderlich. Name der gemeinsamen Bibliothek, unter der die Komponente erstellt werden soll. Diese Bibliothek muss bereits vorhanden sein und sich im aktiven Status befinden.

    Datentyp: Zeichenfolge
    Tabelle : 27. Anforderungstextparameter
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.

    Tabelle : 28. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts.

    Unterstützte Typen:

    • application/json
    • application/xml
    • text/xml

    Standard: application/json
    Tabelle : 29. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

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

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

    Parameter des Antwort-Haupttexts

    Name Beschreibung
    <requested fields> Angeforderte Felder aus der Tabelle „CDM-Knoten“ [sn_cdm_node].
    Fehler Wird nur zurückgegeben, wenn während der Verarbeitung ein Fehler aufgetreten ist.

    Datentyp: Objekt

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

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

    Datentyp: Zeichenfolge
    status Fehlerstatus der Anforderung.

    Mögliche Werte: Fehler

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Im folgenden Codebeispiel wird die Komponente „SharedComponent“ unter der gemeinsamen Bibliothek „javalib“ gespeichert.

    curl "http://instance.servicenow.com/sn_cdm/shared_libraries/components/?sharedLibraryName=javalib&changeSetNumber='Chset-9'&name='SharedComponent'\  
--request POST\  
--header "Accept:application/json" \  
--user 'username':'password'

    Antwort:

    {
  "result": {
    "changeset_id": {
      "value": "ca7e6a501b202110636e0fe0604bcb71",
      "link": "https://instance.servicenow.com/api/now/table/sn_cdm_changeset/ca7e6a501b202110636e0fe0604bcb71"
    },
    "node_path": "!2!3!:",
    "description": null,
    "sys_updated_on": "2023-01-18 16:04:52",
    "type": "sn_cdm_node_shared_component",
    "sys_class_name": "sn_cdm_node",
    "sys_id": "6d2072901b602110636e0fe0604bcbec",
    "sys_updated_by": "admin",
    "previous_version": null,
    "sys_created_on": "2023-01-18 16:04:52",
    "value": null,
    "effective_from": null,
    "linked_to": null,
    "sys_created_by": "admin",
    "restricted_to": null,
    "linked_to_version": null,
    "level": "2",
    "conflict_type": null,
    "main_id": "19",
    "effective_to": null,
    "secure_value": null,
    "node_classifier": "/shared_library/shared_components",
    "main_id_encoded": ":",
    "name": "testSharedComponent",
    "position": null,
    "reason_for_conflict": null,
    "system_folder": false,
    "status": "new",
    "conflict": false
  }
}

    CdmSharedLibraryApi – POST /sn_cdm/shared_libraries/uploads/components

    Ermöglicht das Erstellen und Verwalten von gemeinsam genutzten Bibliotheken und gemeinsam genutzten Komponenten. Dieser Endpunkt erstellt einen gemeinsam genutzten Komponentenknoten in der Tabelle „CDM-Knoten“ [sn_cdm_node] und einen Datensatz für gemeinsam genutzte Komponenten in der Tabelle „Gemeinsam genutzte CDM-Komponente“ [sn_cdm_shared_component].

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

    Hinweis:
    Standardmäßig beträgt die maximale Upload-Größe für Inhalte 2 MB. Sie können diesen Standard ändern, indem Sie die Eigenschaft sn_cdm.max_allowed_upload_file_size aktualisieren.
    Hinweis:
    Diese Upload-Methode kann nicht zum Ändern von Knoten verwendet werden. Verwenden Sie die alternative Methode CdmSharedLibraryApi – POST /sn_cdm/shared_libraries/uploads/components/file, um Knoten zu ändern.

    URL-Format

    Versionierte URL: /api/sn_cdm/{api_version}/shared_libraries/uploads/components

    Standard-URL: /api/sn_cdm/shared_libraries/uploads/components

    Unterstützte Anforderungsparameter

    Tabelle : 31. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 32. Abfrageparameter
    Name Beschreibung
    autoCommit Kennzeichnung, die angibt, ob das im Parameter changesetNumber identifizierte Changeset nach dem Upload an das Datenmodell übergeben wird.
    Gültige Werte:
    • true: Changeset wird nach dem Upload committet.
    • „false“: Changeset wird nach dem Upload nicht bestätigt.

    Datentyp: Boolesch

    Standardwert: false
    autoDelete Kennzeichnung, die angibt, ob die vorhandenen Knoten, die nicht Teil des Upload-Inhalts sind, nach Abschluss der Verarbeitung gelöscht werden.
    Gültige Werte:
    • true: Vorhandene Knoten automatisch löschen.
    • false: Vorhandene Knoten nicht automatisch löschen.

    Datentyp: Boolesch

    Standardwert: false
    changesetNumber Erforderlich. Zeichenfolge, die das mit der Anwendung verknüpfte Changeset eindeutig identifiziert, z. B. Chset-102. Befindet sich in der Tabelle „CDM-Änderungssatz“ [sn_cdm_changeset]. Dieses Changeset muss sich im Status „Offen“ befinden.

    Datentyp: Zeichenfolge
    dataFormat Erforderlich. Format der Konfigurationsdaten.
    Gültige Werte:
    • CSV
    • ini
    • json
    • Eigenschaften
    • unformatiert
    • XML
    • YAML

    Datentyp: Zeichenfolge
    deleteRedundantOverrides Kennzeichnung, die angibt, ob eine Überschreibung erstellt werden soll, wenn redundante Werte vorhanden sind.
    Gültige Werte:
    • true: Wenn redundante Werte vorhanden sind, wird keine Überschreibung erstellt.
    • false: Wenn redundante Werte vorhanden sind, wird mit einer Überschreibung fortgefahren.

    Standardwert: true
    IdentifierKeys Liste der Namen, die angeben, welcher Schlüssel in einem untergeordneten Array-Element zum Identifizieren desselben Knotens verwendet werden soll.

    Zum Beispiel, wenn Sie Folgendes hochladen:

    [
  {"name" : "Allan, "city" : "Paris"}, 
  {"name" : "Karen, "city" : "Sydney"}
]

    im folgenden vorhandenen Modell:

    [
  {"name" : "Karen, "city" : "Manila"},
  {"name" : "Allan, "city" : "Brussels"}
]

    und Sie identifierKeys auf namefestlegen, wird die folgende Ausgabe erzeugt:

    [
  {"name" : "Karen, "city" : "Sydney"},
  {"name" : "Allan, "city" : "Paris"}
]

    Andernfalls wird die folgende Ausgabe erzeugt:

    [
  {"name" : "Karen, "city" : "Manila"},
  {"name" : "Allan, "city" : "Brussels"},
  {"name" : "Allan, "city" : "Paris"},
  {"name" : "Karen, "city" : "Sydney"}
]

    Datentyp: Array von Zeichenfolgen
    ignoreAttribute Kennzeichnung, die angibt, ob das angegebene Datenformat Attribute unterstützt (derzeit nur XML).
    Gültige Werte:
    • true: Wenn das angegebene Datenformat Attribute unterstützt, werden alle Attribute in den Eingabedaten während des Uploads übersprungen.
    • false: Wenn das angegebene Datenformat Attribute unterstützt, werden alle Attribute in den Eingabedaten in den Upload einbezogen.

    Datentyp: Boolesch

    Standardwert: false
    namePath Pfad des Zielknotens, unter den die Konfigurationsdaten hochgeladen werden sollen Dieser Pfad ist relativ zu den Komponenten, der Sammlung oder dem bereitstellbaren Ordner (abhängig vom aufgerufenen Endpunkt).
    Sie können den Namenspfad in einem der folgenden Formate übergeben. So definieren Sie beispielsweise den Namenspfad für den Knoten testApp/deployables/Development1/cdi1:
    • Backslash-Format: testApp/deployables/Development1/cdi1
      Hinweis:
      Wenn Ihr Knotenname einen umgekehrten Schrägstrich („/“) enthält, können Sie dieses Format nicht verwenden.
    • Back-End-Namenspfad mit Ersetzungszeichen: testAppdeployables​Development1​cdi1
    • Array: ['testApp','bereitstellbare Elemente','Entwicklung1','cdi1']
    Hinweis:
    Wenn die angegebene Komponente im angegebenen Pfad nicht vorhanden ist, erstellt das System die Komponente automatisch im angegebenen Pfad und lädt die Daten.

    Datentyp: Zeichenfolge
    veröffentlichenOption
    Veröffentlichungsoption für die zugeordneten konfigurierten Snapshots.
    Gültige Werte:
    • veröffentlichen_new_and_unpublish_old: Veröffentlichen Sie den neuen Snapshot, der nach dem Commit erstellt wurde, und heben Sie die Veröffentlichung des vorhandenen Snapshots auf.
    • veröffentlichen_none: Keine Snapshots veröffentlichen.

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

    Datentyp: Zeichenfolge

    Standard: veröffentlichen_none
    sharedLibraryName Erforderlich. Name der zu erstellenden oder zu verwaltenden gemeinsamen Bibliothek. Befindet sich in der CDM-Anwendungstabelle [sn_cdm_application].

    Datentyp: Zeichenfolge
    Tabelle : 33. Anforderungstextparameter
    Name Beschreibung
    Variablen-Upload-Daten Hochzuladende Konfigurationsdaten. Dies können beliebige Daten in dem Format sein, das durch den Parameter dataFormat der Abfrageparameter definiert ist.

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.

    Tabelle : 34. Anforderungskopfzeilen.
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützte Typen: text/plain und application/x-www-form-urlencoded.

    Standard: text/plain
    Tabelle : 35. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

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

    Tabelle : 36. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung. Die Upload-Anforderung wurde abgelehnt.
    Mögliche Probleme:
    • Die Größe der Konfigurationsnutzlast ist größer als der zulässige Höchstwert – standardmäßig 2 MB.
    • Erforderliche Parameter fehlen im Aufruf.
    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
    Fehler Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler.

    Datentyp: Objekt

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

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

    Datentyp: Zeichenfolge
    hochgeladene ID Sys_id der Upload-Anforderung. Verwenden Sie diese ID, um den Endpunkt aufzurufen und den Status des Uploads zu erhalten.

    Datentyp: Zeichenfolge
    status Fehlerstatus der Anforderung.

    Mögliche Werte: Fehler

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie die gemeinsam genutzte Bibliothek mit dem Namen Demo_App1631126164773 hochgeladen wird, wobei die Konfigurationsdaten Nur-Text sind.

    curl "http://instance.servicenow.com/api/sn_cdm/sharedlibrary/component/upload?namePath=%2FSettings%2FdbSettings&dataFormat=json&appName=Demo_App1631126164773&changesetNumber=Chset-8&autoCommit=false&publishOption=publish_none&autoDelete=true" \ 
--request POST \  
--header "Accept:application/json" \  
--header "Content-Type:text/plain" \  
--data "{  
  \"dbIPAddress\": \"10.10.10.110\",  
\"dbPort\": \"8080\",  
\"dbConnectionString\": \"admin:admin server1.xyz.com:8080 dbName_payments\",  
\"dbConnectionStringBackup\": \"admin:admin server2.xyz.com dbName_payments_backup\ "}" \  
--user 'username':'password'

    Die folgenden Rückgabeergebnisse zeigen sowohl eine erfolgreiche als auch eine Fehlerantwort auf diese Anforderung.

    // Successful response 
{  
"result": {  
    "upload_id": "ec1f71f45322301096edddeeff7b12b3"  
  }  
}
 
// Error response 

{  
"error": {  
   "message": "Size of uploaded data:6853632.0(bytes) is greater than max allowed upload limit of 2097152.0(bytes)",  
   "detail": ""  
},  
"status": "failure" 
}

    CdmSharedLibraryApi – POST /sn_cdm/shared_libraries/uploads/components/file

    Lädt Dateien als Teil des Configuration Data Model (CDM) im Komponentenordner in einer gemeinsamen Bibliothek hoch.

    URL-Format

    Versionierte URL: /api/sn_cdm/{api_version}shared_libraries/uploads/components/file

    Standard-URL: /api/sn_cdm/shared_libraries/uploads/components/file

    Unterstützte Anforderungsparameter

    Tabelle : 37. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 38. Abfrageparameter
    autoCommit Kennzeichnung, die angibt, ob das im Parameter changesetNumber identifizierte Changeset nach dem Upload an das Datenmodell übergeben wird.
    Gültige Werte:
    • true: Changeset wird nach dem Upload committet.
    • „false“: Changeset wird nach dem Upload nicht bestätigt.

    Datentyp: Boolesch

    Standardwert: false
    autoValidieren Kennzeichnung, die angibt, ob die beim Commit erstellten Snapshots validiert werden.
    Gültige Werte:
    • true: Validiert die Snapshots.
    • false: Snapshots nicht validieren.
    Hinweis:
    Diese Option ist nur verfügbar, wenn der Parameter autoCommit den Wert truehat.

    Datentyp: Boolesch

    Standardwert: false
    changesetNumber Zeichenfolge, die das mit der Anwendung verknüpfte Changeset eindeutig identifiziert, z. B. Chset-102. Dieses Changeset muss sich im Status „Offen“ befinden. Befindet sich in der Tabelle „CDM-Änderungssatz“ [sn_cdm_changeset].

    Datentyp: Zeichenfolge

    Standard: Erstellt ein zu verwendendes Changeset. Die Changeset-Details werden als Teil der CdmApplicationsApi – GET /sn_cdm/applications/upload-status/{upload_id} -Ergebnisse zurückgegeben.
    fileName Name der hochzuladenden Datei. Dieser Name kann sich vom tatsächlichen Dateinamen unterscheiden und die Dateierweiterung enthalten. Beispiel: .txt/.scv/.jar. Der Wert fileName wird beim Herunterladen der Datei angewendet.

    Datentyp: Zeichenfolge
    fileNodeName Name des Dateiknotens. Dieser Dateiname wird beim Exportieren in den Konfigurationsdaten verwendet. Dieser Name erfordert keine Dateierweiterung und wirkt sich auch nicht auf den Download aus.

    Datentyp: Zeichenfolge
    namePath Pfad des Zielknotens, unter den die Konfigurationsdaten hochgeladen werden sollen Dieser Pfad ist relativ zu den Komponenten, der Sammlung oder dem bereitstellbaren Ordner (abhängig vom aufgerufenen Endpunkt).
    Sie können den Namenspfad in einem der folgenden Formate übergeben. So definieren Sie beispielsweise den Namenspfad für den Knoten testApp/deployables/Development1/cdi1:
    • Backslash-Format: testApp/deployables/Development1/cdi1
      Hinweis:
      Wenn Ihr Knotenname einen umgekehrten Schrägstrich („/“) enthält, können Sie dieses Format nicht verwenden.
    • Back-End-Namenspfad mit Ersetzungszeichen: testAppdeployables​Development1​cdi1
    • Array: ['testApp','bereitstellbare Elemente','Entwicklung1','cdi1']
    Hinweis:
    Wenn die angegebene Komponente im angegebenen Pfad nicht vorhanden ist, erstellt das System die Komponente automatisch im angegebenen Pfad und lädt die Daten.

    Datentyp: Zeichenfolge
    sharedLibraryName Erforderlich. Name der gemeinsamen Bibliothek, in der sich die zu löschende Komponente befindet. Befindet sich in der CDM-Anwendungstabelle [sn_cdm_application].

    Datentyp: Zeichenfolge
    Tabelle : 39. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Variablen-Upload-Daten Hochzuladende Konfigurationsdaten. Standardmäßig ist die Dateigröße für Uploads auf 5 MB beschränkt. Informationen zum Anpassen der Größen und des Typs der Upload-Datei finden Sie unter Now Support Artikel.

    Datentyp: Zeichenfolge/Stream

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.

    Tabelle : 40. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Content-Type Inhaltstyp der hochzuladenden Datei. Beispiele: application/zip, text/plain, application/json.
    Tabelle : 41. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

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

    Tabelle : 42. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung.

    Upload-Anforderung wurde abgelehnt.

    Mögliche Probleme:
    • Die Größe der Konfigurationsnutzlast ist größer als das zulässige Maximum (standardmäßig 2 MB).
    • Erforderliche Parameter fehlen im Aufruf.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Fehler Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler.

    Datentyp: Objekt

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

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

    Datentyp: Zeichenfolge
    status Fehlerstatus der Anforderung.

    Mögliche Werte: Fehler

    Datentyp: Zeichenfolge
    hochgeladene ID Sys_id der Upload-Anforderung. Verwenden Sie diese ID, um den Endpunkt CdmApplicationsApi – GET /sn_cdm/applications/upload-status/{upload_id} aufzurufen und den Status des Uploads abzurufen.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Der folgende Aufruf zeigt, wie eine Nur-Text-Datei in den Komponentenordner in der gemeinsamen Bibliothek hochgeladen wird.

    curl "http://instance.servicenow.com/api/sn_cdm/shared_libraries/uploads/components/file?autoValidate=true&sharedLibraryName=sharedLibA &namePath=testComponent%2FfilesFolder&fileName=testFileNodeName.txt&publishOption=publish_valid&changesetNumber=Chset-108&autoCommit=true&fileNodeName=testFile.txt" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:text/plain" \ 
--data "This is sample content that will be uploaded to a plain text file."\ 
--user 'username':'password'

    Die folgenden Rückgabeergebnisse zeigen sowohl eine erfolgreiche als auch eine Fehlerantwort auf diese Anforderung.

    // Successful completion of the upload request
{ 
  "result": { 
    "upload_id": "ec1f71f45322301096edddeeff7b12b3" 
  } 
} 

// Error response. Payload is too large.
{ 
  "error": { 
    "message": "Could not find active application with name: ‘testApp’ of type application", 
    "detail": "" 
  },
  "status": "failure"
}

    CdmSharedLibraryApi – PUT /sn_cdm/shared_libraries

    Aktualisiert die Informationen der gemeinsamen Bibliothek. Verwenden Sie diesen Endpunkt, um den Namen, die Beschreibung, den Status einer gemeinsamen Bibliothek und die Benutzergruppen zu aktualisieren, die auf die Bibliothek zugreifen können.

    Für den Zugriff auf diesen Endpunkt ist die CDM-Administratorrolle erforderlich.

    URL-Format

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

    Standard-URL: /api/sn_cdm/shared_libraries

    Unterstützte Anforderungsparameter

    Tabelle : 43. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 44. Abfrageparameter
    Name Beschreibung
    Name Erforderlich. Name der zu aktualisierenden gemeinsamen Bibliothek. Befindet sich in der CDM-Anwendungstabelle [sn_cdm_application].

    Datentyp: Zeichenfolge
    newAvailableState Kennzeichnung, die den Status der gemeinsam genutzten Bibliothek angibt.
    Gültige Werte:
    • true: Die gemeinsame Bibliothek ist aktiv.
    • false: Die gemeinsame Bibliothek ist inaktiv. Keine Benutzer dürfen auf diese Bibliothek zugreifen.

    Standardwert: true
    neueBeschreibung Aktualisierte Beschreibung der gemeinsamen Bibliothek.

    Datentyp: Zeichenfolge
    neuerName Neuer Name der gemeinsamen Bibliothek.

    Datentyp: Zeichenfolge
    neueBenutzerGruppeIds Kommagetrennte Liste der sys_ids der Benutzergruppen, die auf die zugeordnete gemeinsame Bibliothek zugreifen können. Befindet sich in der Gruppentabelle [sys_user_group].

    Datentyp: Zeichenfolge
    returnFields Kommagetrennte Liste von Feldern in der Tabelle „CDM-Anwendung“ [sn_cdm_application], die als Teil der Antwort zurückgegeben werden sollen.

    Datentyp: Zeichenfolge

    Standard: Alle Nicht-Systemfelder werden zurückgegeben.
    Tabelle : 45. Anforderungstextparameter
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.

    Tabelle : 46. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts.

    Unterstützte Typen:

    • application/json
    • application/xml
    • text/xml

    Standard: application/json
    Tabelle : 47. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

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

    Tabelle : 48. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 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
    <fields> Angeforderte Felder aus der Tabelle „CDM-Anwendung“ [sn_cdm_application].

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

    Datentyp: Objekt

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

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

    Datentyp: Zeichenfolge
    status Fehlerstatus der Anforderung.

    Mögliche Werte: Fehler

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie dieser Endpunkt für die gemeinsame Bibliothek Java11Lib aufgerufen und der Bibliotheksname und die Beschreibung aktualisiert werden.

    curl "http://instance.servicenow.com/sn_cdm/shared_libraries?name=' javalib'&newName=’NewLibraryName’&newDescription=’new%20description%20of%20library’\ 
--request PUT\ 
--header "Accept:application/json" \ 
--user 'username':'password'

    Antwort:

    {
  "result": {
    "sdlc_component": null,
    "cdi_count": "0",
    "available": true,
    "description": "Set new description",
    "managed_by_group": null,
    "sys_updated_on": "2023-01-18 11:51:14",
    "type": "shared_library",
    "node": {
      "value": "021635dc77a4a1109ac0cf0bbb5a9952",
      "link": "http://192.168.0.129:8080/api/now/table/sn_cdm_node/021635dc77a4a1109ac0cf0bbb5a9952"
    },
    "sys_id": "185235dc77a4a1109ac0cf0bbb5a994e",
    "sys_updated_by": "admin",
    "node_main": {
      "value": "1852b15877a4a1109ac0cf0bbb5a99aa",
      "link": "http://192.168.0.129:8080/api/now/table/sn_cdm_node_main/1852b15877a4a1109ac0cf0bbb5a99aa"
    },
    "sys_created_on": "2023-01-18 11:34:43",
    "cdi_usage": "0",
    "name": "LibraryA",
    "last_committed_changeset": {
      "value": "4a1635dc77a4a1109ac0cf0bbb5a9951",
      "link": "http://192.168.0.129:8080/api/now/table/sn_cdm_changeset/4a1635dc77a4a1109ac0cf0bbb5a9951"
    },
    "state": "active",
    "sys_created_by": "admin"
  }
}

    CdmSharedLibraryApi – PUT /sn_cdm/shared_libraries/components

    Aktualisiert den Namen und die Beschreibung der angegebenen gemeinsam genutzten Komponente.

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

    Hinweis:
    Umbenennen ist nur zulässig, wenn eine Komponente noch nie verwendet wurde, z. B. wenn der Snapshot der Komponente nie importiert wurde. Das Umbenennungsszenario dient in erster Linie dazu, Tippfehler beim Erstellen neuer Komponenten zu beheben.

    URL-Format

    Versionierte URL: /api/sn_cdm/{api_version}/shared_libraries/components

    Standard-URL: /api/sn_cdm/shared_libraries/components

    Unterstützte Anforderungsparameter

    Tabelle : 49. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 50. Abfrageparameter
    Name Beschreibung
    changesetNumber Erforderlich. Name des zugeordneten Changesets. Befindet sich in der Tabelle „CDM-Änderungssatz“ [sn_cdm_changeset].

    Datentyp: Zeichenfolge
    Name Erforderlich. Name der zu aktualisierenden gemeinsam genutzten Komponente. Befindet sich in der Tabelle „Gemeinsam genutzte CDM-Komponente“ [sn_cdm_shared_component].

    Datentyp: Zeichenfolge
    neuerName Erforderlich. Aktualisierter Name der gemeinsam genutzten Komponente.

    Datentyp: Zeichenfolge
    neueBeschreibung Aktualisierte Beschreibung der gemeinsam genutzten Komponente.

    Datentyp: Zeichenfolge

    Standard: Leer
    returnFields Kommagetrennte Liste von Feldern in der Tabelle „Gemeinsam genutzte CDM-Komponente“ [sn_cdm_shared_component], die als Teil der Antwort zurückgegeben werden soll.

    Datentyp: Zeichenfolge

    Standard: Alle Nicht-Systemfelder werden zurückgegeben.
    Tabelle : 51. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.

    Tabelle : 52. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts.

    Unterstützte Typen:

    • application/json
    • application/xml
    • text/xml

    Standard: application/json
    Tabelle : 53. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

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

    Tabelle : 54. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 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
    <fields> Angeforderte Felder aus der Tabelle „Gemeinsam genutzte CDM-Komponente“ [sn_cdm_shared_component].

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

    Datentyp: Objekt

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

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

    Datentyp: Zeichenfolge
    status Fehlerstatus der Anforderung.

    Mögliche Werte: Fehler

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Code-Beispiel zeigt, wie die Beschreibung der Komponente SharedComponentTest aktualisiert wird.

    curl "http://instance.servicenow.com/sn_cdm/shared_libraries/components/?sharedLibraryName=javalib&changeSetNumber='chset-9'&name='SharedComponentTest'&newDescription='The shared component description'\  
--request POST\  
--header "Accept:application/json" \  
--user 'username':'password

    Antwort:

    {
  "result": {
    "changeset_id": {
      "value": "5c33311077e4a1109ac0cf0bbb5a9902",
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/5c33311077e4a1109ac0cf0bbb5a9902"
    },
    "node_path": "!(1!(2!(3",
    "description": "Changing the description only",
    "sys_updated_on": "2023-01-18 12:09:05",
    "type": "sn_cdm_node_shared_component",
    "sys_class_name": "sn_cdm_node",
    "sys_id": "9953f99077a4a1109ac0cf0bbb5a99ec",
    "sys_updated_by": "admin",
    "previous_version": null,
    "sys_created_on": "2023-01-18 11:39:09",
    "value": null,
    "effective_from": null,
    "linked_to": null,
    "sys_created_by": "admin",
    "restricted_to": null,
    "linked_to_version": null,
    "level": "2",
    "conflict_type": null,
    "main_id": "183",
    "effective_to": null,
    "secure_value": null,
    "node_classifier": "/shared_library/shared_components",
    "main_id_encoded": "(3",
    "name": "sharedComponentName",
    "position": null,
    "reason_for_conflict": null,
    "system_folder": false,
    "status": "new",
    "conflict": false
  }
}