---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# KatalogJS -- Umfang

# KatalogJS -- Umfang {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 4 Minuten Lesedauer

Die KatalogJS Die API bietet Methoden zum Überprüfen und Abrufen katalogspezifischer Eigenschaften.

Um diese Klasse in einer bereichsbezogenen Anwendung zu verwenden, verwenden Sie `sn_sc `Namespace-Bezeichner. Für den Zugriff auf ist das standardmäßig aktivierte Servicekatalog-API-Plugin (com.glideapp.servicecatalog.scoped.api) erforderlich KatalogJS API.

## CatalogJS -- Katalog (GlideRecord Now_GR) {#ariaid-title2}

Erstellt eine Instanz der Katalogklasse für das angegebene Glide-Datensatzobjekt.
{#CJS-Catalog_G__table_og2_g1c_5bb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Now_GR | Objekt | Glide-Datensatz, der auf die Tabelle „sc_catalog" verweist. |
[Tabelle : 1. Parameter]

{#CJS-Catalog_G__table_og2_g1c_5bb}  
Dieses Beispiel zeigt, wie eine neue Instanz der Katalogklasse erstellt wird.

    var now_GR = new GlideRecord('sc_catalog');
     now_GR.addQuery('sys_id','e0d08b13c3330100c8b837659bba8fb4');
     now_GR.query();
     var catalog = new sn_sc.Catalog(now_GR);

## CatalogJS -- Katalog (Zeichenfolge sys_ID) {#ariaid-title3}

Erstellt eine Instanz der Katalogklasse mit der angegebenen sys_ID
{#CJS-Catalog_S__table_tf1_gbc_5bb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| sys_id | Zeichenfolge | SYS_ID des Katalogs. |
[Tabelle : 2. Parameter]

{#CJS-Catalog_S__table_tf1_gbc_5bb}  
Dieses Beispiel zeigt, wie eine Instanz der Katalogklasse mit der angegebenen syst_ID erstellt wird

    new sn_sc.Catalog(catalog_sys_id);
    var catalog = new sn_sc.Catalog("31bea3d53790200044e0bfc8bcbe5dec");

## CatalogJS -- canView (Boolescher Wert für Mobilgeräte, Zeichenfolgen-UserID) {#ariaid-title4}

Bestimmt, ob ein Anwender die aktuelle Kategorie auf einem Mobilgerät oder Desktop anzeigen kann.
{#CJS-canView_B__table_mnl_2lz_sbb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Mobile | Boolean | Kennzeichnung, die angibt, ob überprüft werden soll, ob der Anwender den aktuellen Katalog in einer mobilen Ansicht oder einer Desktop-Ansicht anzeigen kann. Gültige Werte: * Wahr: Mobile Ansicht * Falsch: Desktop-Ansicht {#CJS-canView_B__ul_qfp_cb4_kpb} |
| userId | Zeichenfolge | Optional. SYS_ID des Anwenders, um zu überprüfen, ob er den Katalog anzeigen kann. Standard: Aktueller Anwender |
[Tabelle : 3. Parameter]

{#CJS-canView_B__table_mnl_2lz_sbb} {#CJS-canView_B__table_nnl_2lz_sbb__entry__2}

| Typ | Beschreibung |
|-|-|
| Boolean | Kennzeichnung, die angibt, ob der Katalog vom Anwender angezeigt werden kann. Gültige Werte: * Wahr: Katalog kann vom Anwender angezeigt werden. * Falsch: Katalog kann vom Anwender nicht angezeigt werden. {#CJS-canView_B__ul_wbn_mb4_kpb} |
[Tabelle : 4. Rückgaben]

{#CJS-canView_B__table_nnl_2lz_sbb}  
Beispiel:

    var catalog = new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
    gs.info(catalog.canView(true));

Ausgabe:

    true

## CatalogJS -- getAvailableCatalog() {#ariaid-title5}

Gibt den verfügbaren aktiven Katalog zurück.
Wenn nur ein aktiver Katalog vorhanden ist, gibt die Methode diesen Katalog zurück. Andernfalls wird der früheste Katalog zurückgegeben, der aus der Liste der Kataloge erstellt wurde, die der Anwender anzeigen kann. Wenn kein Katalog verfügbar ist, gibt die Methode Null zurück.
{#CJS-getAvailableCatalog__table_m31_rmz_sbb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 5. Parameter]

{#CJS-getAvailableCatalog__table_m31_rmz_sbb} {#CJS-getAvailableCatalog__table_n31_rmz_sbb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | Objekt, das auf den frühesten Katalog verweist, den der Anwender anzeigen kann, oder Null, wenn kein Katalog verfügbar ist. |
[Tabelle : 6. Rückgaben]

{#CJS-getAvailableCatalog__table_n31_rmz_sbb}  
Dieses Beispiel gibt den Katalog zurück, der dem aktuellen Anwender zur Verfügung steht.

    var catalog = sn_sc.Catalog.getAvailableCatalog()

## CatalogJS -- getBackgroundColor() {#ariaid-title6}

Gibt die Kataloghintergrundfarbe zurück.
{#CJS-getBackgroundColor__table_etj_mrz_sbb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 7. Parameter]

{#CJS-getBackgroundColor__table_etj_mrz_sbb} {#CJS-getBackgroundColor__table_ftj_mrz_sbb__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Hintergrundfarbe des Katalogs. |
[Tabelle : 8. Rückgaben]

{#CJS-getBackgroundColor__table_ftj_mrz_sbb}  
Dieses Beispiel gibt die Hintergrundfarbe für den zugehörigen Katalog zurück.

    var catalog = new sn_sc.Catalog("0f910a2ac3112200b12d9f2974d3ae3c");
    gs.info("Catalog background: " + catalog.getBackgroundColor());

Ausgabe:

    Catalog background: white

## CatalogJS -- getCatalogCount() {#ariaid-title7}

Gibt die Anzahl der in der Katalogtabelle aktiven Kataloge zurück.
{#CJS-getCatalogCount__table_ez1_znz_sbb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 9. Parameter]

{#CJS-getCatalogCount__table_ez1_znz_sbb} {#CJS-getCatalogCount__table_fz1_znz_sbb__entry__2}

| Typ | Beschreibung |
|-|-|
| Ganzzahl | Anzahl der in der Katalogtabelle verfügbaren Kataloge. |
[Tabelle : 10. Rückgaben]

{#CJS-getCatalogCount__table_fz1_znz_sbb}  
Beispiel:

    console.log(sn_sc.Catalog.getCatalogCount());

Ausgabe:

    3

## CatalogJS -- getCategories() {#ariaid-title8}

Gibt die Kategorien für den aktuellen Katalog zurück.
{#CJS-getCategories__table_nwt_l4z_sbb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 11. Parameter]

{#CJS-getCategories__table_nwt_l4z_sbb} {#CJS-getCategories__table_owt_l4z_sbb__entry__2}

| Typ | Beschreibung |
|-|-|
| ArrayList | Gibt die Kategorien für den aktuellen Katalog zurück. |
[Tabelle : 12. Rückgaben]

{#CJS-getCategories__table_owt_l4z_sbb}  
Dieses Beispiel gibt die Kategorien zurück, die im aktuellen Katalogelement verfügbar sind.

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
    console.log(catalog.getCategories());

Ausgabe:

    0 : {header_image: "", sys_id: "e15706fc0a0a0aa7007fc21e1ab70c2f", description: "Your IT gateway. Report issues and submit requests.", title: "Can We Help You?"} 
    1 : {header_image: "", sys_id: "95fc11615f1211001c9b2572f2b477c6", description: "Services offered by different departments in the organization", title: "Departmental Services"} 
    2 : {header_image: "", sys_id: "900682363731300054b6a3549dbe5d5f", description: "Desktop computers for your work area.", title: "Desktops"} 
    3 : {header_image: "", sys_id: "d2f716fcc611227a015a142fa0b262c1", description: "Order new furniture, and fixtures, or request for cubicle modifications can also be ordered here.", title: "Furniture and Decor"} 
    4 : {header_image: "", sys_id: "d258b953c611227a0146101fb1be7c31", description: "Order from a variety of hardware to meet your business needs, including phones, tablets and laptops.", title: "Hardware"} 

## CatalogJS -- getCategoryIds() {#ariaid-title9}

Gibt die sys_IDs der Kategorien im aktuellen Katalog an.
{#CJS-getCategoryIds__table_ivv_3pz_sbb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 13. Parameter]

{#CJS-getCategoryIds__table_ivv_3pz_sbb} {#CJS-getCategoryIds__table_jvv_3pz_sbb__entry__2}

| Typ | Beschreibung |
|-|-|
| ArrayList | Gibt die sys_IDs der Kategorien im aktuellen Katalog zurück. |
[Tabelle : 14. Rückgaben]

{#CJS-getCategoryIds__table_jvv_3pz_sbb}  
Dieses Beispiel gibt die sys_IDs der im aktuellen Katalog verfügbaren Kategorien zurück.

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
    console.log(catalog.getCategoryIds());

Ausgabe:

    0:"e15706fc0a0a0aa7007fc21e1ab70c2f"
    1 : "95fc11615f1211001c9b2572f2b477c6"
    2 : "900682363731300054b6a3549dbe5d5f"
    3 : "d2f716fcc611227a015a142fa0b262c1"

## CatalogJS -- getDescription() {#ariaid-title10}

Gibt die Beschreibung des aktuellen Katalogs zurück.
{#CJS-getDescription__table_g5q_3qz_sbb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 15. Parameter]

{#CJS-getDescription__table_g5q_3qz_sbb} {#CJS-getDescription__table_h5q_3qz_sbb__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Katalogbeschreibung. |
[Tabelle : 16. Rückgaben]

{#CJS-getDescription__table_h5q_3qz_sbb}  
Dieses Beispiel gibt den Namen des aktuellen Katalogs zurück.

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
    console.log(catalog.getDescription());

Ausgabe:

    Service Catalog - IT Now

## CatalogJS -- getDesktopImageSRC() {#ariaid-title11}

Gibt den Namen der Katalog-Desktop-Image-Datei zurück.
{#CJS-getDesktopImageSRC__table_zdf_csz_sbb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 17. Parameter]

{#CJS-getDesktopImageSRC__table_zdf_csz_sbb} {#CJS-getDesktopImageSRC__table_a2f_csz_sbb__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Dateiname des Katalog-Desktop-Images. |
[Tabelle : 18. Rückgaben]

{#CJS-getDesktopImageSRC__table_a2f_csz_sbb}  
Dieses Beispiel gibt den Namen der aktuellen Katalog-Desktop-Image-Datei zurück.

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
    console.log(catalog.getDesktopImageSRC());

Ausgabe:

    adbcc271475211002ee987e8dee49001.iix

## CatalogJS -- getGr() {#ariaid-title12}

Gibt den GlideRecord des aktuellen Katalogs zurück.
{#CJS-getGr__table_vdd_rqz_sbb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 19. Parameter]

{#CJS-getGr__table_vdd_rqz_sbb} {#CJS-getGr__table_wdd_rqz_sbb__entry__2}

| Typ | Beschreibung |
|-|-|
| GlideRecord | GlideRecord des aktuellen Katalogs. |
[Tabelle : 20. Rückgaben]

{#CJS-getGr__table_wdd_rqz_sbb}  
Dieses Beispiel gibt den GlideRecord für den angegebenen Katalog zurück.

    var catalog = new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
    data.history = catalog.getGr();

## CatalogJS -- getHeaderIconSRC() {#ariaid-title13}

Gibt das Headersymbol des aktuellen Katalogs zurück.
{#CJS-getHeaderIconSRC__table_xsg_5rz_sbb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 21. Parameter]

{#CJS-getHeaderIconSRC__table_xsg_5rz_sbb} {#CJS-getHeaderIconSRC__table_ysg_5rz_sbb__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Symbol für Katalog-Header. |
[Tabelle : 22. Rückgaben]

{#CJS-getHeaderIconSRC__table_ysg_5rz_sbb}  
Dieses Beispiel zeigt, wie der Name des Katalogheader-Symbols abgerufen wird.

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
    gs.info(catalog.getHeaderIconSRC());

Ausgabe:

    service_catalog_header.png

## CatalogJS -- GetId() {#ariaid-title14}

Gibt die sys_ID des aktuellen Katalogs zurück.
{#CJS-getID__table_xqx_xpz_sbb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 23. Parameter]

{#CJS-getID__table_xqx_xpz_sbb} {#CJS-getID__table_yqx_xpz_sbb__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | SYS_ID des aktuellen Katalogs. |
[Tabelle : 24. Rückgaben]

{#CJS-getID__table_yqx_xpz_sbb}  
Dieses Beispiel gibt die sys_ID des aktuellen Katalogs zurück.

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
    console.log(catalog.getId());

Ausgabe:

    e0d08b13c3330100c8b837659bba8fb4

## CatalogJS -- getTitle() {#ariaid-title15}

Gibt den Titel des aktuellen Katalogs zurück.
{#CJS-getTitle__table_fxp_mxz_sbb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 25. Parameter]

{#CJS-getTitle__table_fxp_mxz_sbb} {#CJS-getTitle__table_gxp_mxz_sbb__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Titel des aktuellen Katalogs. |
[Tabelle : 26. Rückgaben]

{#CJS-getTitle__table_gxp_mxz_sbb}  
Dieses Beispiel gibt den Titel des aktuellen Katalogs zurück.

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
    gs.info(catalog.getTitle());

Ausgabe:

    Service Catalog

## CatalogJS -- hasCategories() {#ariaid-title16}

Gibt an, ob der aktuelle Katalog Kategorien enthält.
{#CJS-hasCategories__table_kwh_lsz_sbb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 27. Parameter]

{#CJS-hasCategories__table_kwh_lsz_sbb} {#CJS-hasCategories__table_lwh_lsz_sbb__entry__2}

| Typ | Beschreibung |
|-|-|
| Boolean | Kennzeichnung, die angibt, ob der aktuelle Katalog Kategorien enthält. Gültige Werte: * Wahr: Katalog hat Kategorien. * Falsch: Katalog enthält keine Kategorien. {#CJS-hasCategories__ul_l1q_qn4_kpb} |
[Tabelle : 28. Rückgaben]

{#CJS-hasCategories__table_lwh_lsz_sbb}  
Dieses Beispiel zeigt, wie bestimmt werden kann, ob der aktuelle Katalog Kategorien enthält.

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
    gs.info(catalog.hasCategories());

Ausgabe:

    false

## CatalogJS -- hasItems() {#ariaid-title17}

Gibt an, ob der aktuelle Katalog Katalogelemente enthält.
{#CJS-hasItems__table_abg_5wz_sbb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 29. Parameter]

{#CJS-hasItems__table_abg_5wz_sbb} {#CJS-hasItems__table_bbg_5wz_sbb__entry__2}

| Typ | Beschreibung |
|-|-|
| Boolean | Kennzeichnung, die angibt, ob der aktuelle Katalog Katalogelemente enthält. Gültige Werte: * Wahr: Katalog enthält Katalogelemente. * Falsch: Katalog enthält keine Katalogelemente. {#CJS-hasItems__ul_l1q_qn4_kpb} |
[Tabelle : 30. Rückgaben]

{#CJS-hasItems__table_bbg_5wz_sbb}  
Beispiel:

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
    gs.info(catalog.hasItems());

Ausgabe:

    true

## CatalogJS -- isWishlistEnabled() {#ariaid-title18}

Gibt an, ob die Wunschliste für den aktuellen Katalog aktiviert ist.
{#CJS-isWishlistEnabled__table_emb_xk2_sbb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 31. Parameter]

{#CJS-isWishlistEnabled__table_emb_xk2_sbb} {#CJS-isWishlistEnabled__table_fmb_xk2_sbb__entry__2}

| Typ | Beschreibung |
|-|-|
| Boolean | Kennzeichnung, die angibt, ob der aktuelle Katalog Wunschlisten unterstützt. Gültige Werte: * Wahr: Katalog unterstützt Wunschlisten. * Falsch: Katalog unterstützt keine Wunschlisten. {#CJS-isWishlistEnabled__ul_l1q_qn4_kpb} |
[Tabelle : 32. Rückgaben]

{#CJS-isWishlistEnabled__table_fmb_xk2_sbb}  
Dieses Beispiel zeigt, wie überprüft wird, ob Wunschlisten für den aktuellen Katalog aktiviert sind.

    var catalog = new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
    gs.info(catalog.isWishlistEnabled());

Ausgabe:

    true


