---
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


---

# KatalogClientScript -- Umfang

# KatalogClientScript -- Umfang {#ariaid-title1}

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

Die KatalogClientScript Die API bietet Methoden, mit denen Sie Katalog-Client-Skriptdatensätze erstellen, ändern oder löschen können.

Um diese Klasse in einer bereichsbezogenen Anwendung zu verwenden, verwenden Sie `sn_sc `Namespace-Bezeichner. Das standardmäßig aktivierte Plugin „bereichsbezogene API des Servicekatalogs" (ID: com.glideapp.servicecatalog.scoped.api) ist für den Zugriff auf erforderlich KatalogClientScript API.

## CatalogClientScript -- CatalogClientScript() {#ariaid-title2}

Erstellt eine Instanz der Klasse „CatalogClientScript".
{#r_CCSS-CatalogClientScript__table_hlv_q2c_1z__entry__3}

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

{#r_CCSS-CatalogClientScript__table_hlv_q2c_1z}  

    var catalogClientScript = new sn_sc.CatalogClientScript();

## CatalogClientScript -- addScript (Zeichenfolgenskript) {#ariaid-title3}

Fügt dem Katalog-Client-Skript ein Skript hinzu.
{#r_CCSS-addScript_S__table_m1v_1ds_sy__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Skript | Zeichenfolge | Skript, das dem Katalog-Client-Skript hinzugefügt werden soll. |
[Tabelle : 2. Parameter]

{#r_CCSS-addScript_S__table_m1v_1ds_sy} {#r_CCSS-addScript_S__table_n1v_1ds_sy__entry__2}

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 3. Rückgaben]

{#r_CCSS-addScript_S__table_n1v_1ds_sy}  
Dieses Beispiel zeigt, wie diese Methode aufgerufen wird.

    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.addScript("function onLoad(){Enter the script}");

## CatalogClientScript -- appliesToCatalogItem (boolesche Kennzeichnung) {#ariaid-title4}

Gibt an, ob das Katalog-Client-Skript für ein Katalogelement ausgeführt wird.
{#r_CCSS-appliesToCatalogItem_B__table_zsm_rzr_sy__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| kennzeichnen | Boolean | Bei „wahr" wird das Katalog-Client-Skript für das Katalogelement ausgeführt. Bei „falsch" wird das Katalog-Client-Skript nicht für das Katalogelement ausgeführt. |
[Tabelle : 4. Parameter]

{#r_CCSS-appliesToCatalogItem_B__table_zsm_rzr_sy} {#r_CCSS-appliesToCatalogItem_B__table_atm_rzr_sy__entry__2}

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 5. Rückgaben]

{#r_CCSS-appliesToCatalogItem_B__table_atm_rzr_sy}  

    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.appliesToCatalogItem(true);

## CatalogClientScript -- appliesToCatalogTask (boolesche Kennzeichnung) {#ariaid-title5}

Gibt an, ob das Katalog-Client-Skript für eine Katalogaufgabe ausgeführt wird.
{#r_CCSS-appliesToCatalogTask_B__table_tqp_n2s_sy__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| kennzeichnen | Boolean | Bei „wahr" wird das Katalog-Client-Skript für die Katalogaufgabe ausgeführt. Bei „falsch" wird das Katalog-Client-Skript für die Katalogaufgabe nicht ausgeführt. |
[Tabelle : 6. Parameter]

{#r_CCSS-appliesToCatalogTask_B__table_tqp_n2s_sy} {#r_CCSS-appliesToCatalogTask_B__table_uqp_n2s_sy__entry__2}

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 7. Rückgaben]

{#r_CCSS-appliesToCatalogTask_B__table_uqp_n2s_sy}  
Dieses Beispiel zeigt, wie diese Methode aufgerufen wird.

    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.appliesToCatalogTask(true);

## CatalogClientScript -- appliesToRequestedItem (boolesche Kennzeichnung) {#ariaid-title6}

Gibt an, ob das Katalog-Client-Skript für ein angefordertes Element ausgeführt wird.
{#r_CCSS-appliesToRequestedItem_B__table_rsq_p1s_sy__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| kennzeichnen | Boolean | Bei „wahr" wird das Katalog-Client-Skript für das angeforderte Element ausgeführt. Bei „falsch" wird das Katalog-Client-Skript für das angeforderte Element nicht ausgeführt. |
[Tabelle : 8. Parameter]

{#r_CCSS-appliesToRequestedItem_B__table_rsq_p1s_sy} {#r_CCSS-appliesToRequestedItem_B__table_ssq_p1s_sy__entry__2}

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 9. Rückgaben]

{#r_CCSS-appliesToRequestedItem_B__table_ssq_p1s_sy}  
Dieses Beispiel zeigt, wie die Methode aufgerufen wird.

    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.appliesToRequestedItem(true);

## CatalogClientScript -- appliesToTargetRecord (boolesche Kennzeichnung) {#ariaid-title7}

Gibt an, ob das Katalog-Client-Skript für ein angefordertes Element ausgeführt wird.
{#r_CCSS-appliesToTargetRecord_B__table_hwy_44l_5z__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| kennzeichnen | Boolean | Bei „wahr" wird das Katalog-Client-Skript für den Zieldatensatz ausgeführt. Bei „falsch" wird das Katalog-Client-Skript nicht für den Zieldatensatz ausgeführt. |
[Tabelle : 10. Parameter]

{#r_CCSS-appliesToTargetRecord_B__table_hwy_44l_5z} {#r_CCSS-appliesToTargetRecord_B__table_iwy_44l_5z__entry__2}

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 11. Rückgaben]

{#r_CCSS-appliesToTargetRecord_B__table_iwy_44l_5z}  
Dieses Beispiel zeigt, wie die Methode aufgerufen wird.

    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.appliesToTargetRecord(true);

## CatalogClientScript -- create(boolescher Standard -- Update) {#ariaid-title8}

Fügt das definierte Katalog-Client-Skript in die Tabelle catalog_script_Client ein.
{#r_CCSS-create_B__table_kj1_xbs_kx__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Standardaktualisierung | Boolean | Kennzeichnung, die angibt, ob die Ausführung von Engines und Workflows aktiviert werden soll. Gültige Werte: * Wahr: Engines und Workflow aktivieren. * Falsch: Engines und Workflow nicht aktivieren. {#r_CCSS-create_B__ul_nnx_xwn_kpb} |
[Tabelle : 12. Parameter]

{#r_CCSS-create_B__table_kj1_xbs_kx} {#r_CCSS-create_B__table_lj1_xbs_kx__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | SYS_ID des Katalog-Client-Skripts. |
[Tabelle : 13. Rückgaben]

{#r_CCSS-create_B__table_lj1_xbs_kx}  
Dieses Beispiel zeigt, wie die Methode aufgerufen wird.

    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.setAttributes({"name": "My Catalog Item", "applies_to": "item", "ui_type": "desktop", "type": "onLoad"});
    catalogClientScript.appliesToCatalogItem(true);
    catalogClientScript.appliesToRequestedItem(true);
    catalogClientScript.appliesToCatalogTask(true);
    catalogClientScript.appliesToTargetRecord(true);
    var catalogClientScriptId = catalogClientScript.create();
    gs.info(catalogClientScriptId);

Ausgabe:

    039c516237b1300054b6a3549dbe5dfc

## CatalogClientScript -- deleteRecord(Zeichenfolge sys_ID, boolescher Standard-Update) {#ariaid-title9}

Löscht das definierte Katalog-Client-Skript.
{#r_CCSS-deleteRecord_S_B__table_jdv_hsz_qy__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| sys_id | Zeichenfolge | SYS_ID des Katalog-Client-Skripts. |
| Standardaktualisierung | Boolean | Kennzeichnung, die angibt, ob die Ausführung von Engines und Workflows aktiviert werden soll. Gültige Werte: * Wahr: Engines und Workflow aktivieren. * Falsch: Engines und Workflow nicht aktivieren. {#r_CCSS-deleteRecord_S_B__ul_nnx_xwn_kpb} |
[Tabelle : 14. Parameter]

{#r_CCSS-deleteRecord_S_B__table_jdv_hsz_qy} {#r_CCSS-deleteRecord_S_B__table_kdv_hsz_qy__entry__2}

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 15. Rückgaben]

{#r_CCSS-deleteRecord_S_B__table_kdv_hsz_qy}  
Das folgende Beispiel zeigt, wie ein Katalog-Client-Skript gelöscht wird.

    var sys_id = "039c516237b1300054b6a3549dbe5dfc"; 
    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.deleteRecord("039c516237b1300054b6a3549dbe5dfc");

## CatalogClientScript -- setAttributes (Zuordnungsattribute) {#ariaid-title10}

Definiert Attributwerte für das Katalog-Client-Skript.
{#r_CCSS-setAttributes_M__table_fyy_tyr_sy__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| attributes | Karte | Ein JSON-Objekt, das eine Zuordnung für die Feld- und Wertpaare aufweist. |
[Tabelle : 16. Parameter]

{#r_CCSS-setAttributes_M__table_fyy_tyr_sy} {#r_CCSS-setAttributes_M__table_gyy_tyr_sy__entry__2}

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 17. Rückgaben]

{#r_CCSS-setAttributes_M__table_gyy_tyr_sy}  
Dieses Beispiel zeigt, wie die Methode aufgerufen wird.

    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.setAttributes({"name": "My Catalog Item", "applies_to": "catalog_item", "ui_type": "desktop", "type": "onLoad"});

## CatalogClientScript -- setCatalogItem(Zeichenfolge sys_ID) {#ariaid-title11}

Ordnet dem Katalog-Client-Skript ein Katalogelement zu.
{#r_CCSS-setCatalogItem_S__table_v3g_zds_sy__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| sys_id | Zeichenfolge | SYS_ID des Katalogelements. |
[Tabelle : 18. Parameter]

{#r_CCSS-setCatalogItem_S__table_v3g_zds_sy} {#r_CCSS-setCatalogItem_S__table_w3g_zds_sy__entry__2}

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 19. Rückgaben]

{#r_CCSS-setCatalogItem_S__table_w3g_zds_sy}  
Dieses Beispiel zeigt, wie ein Katalogelement dem aktuellen Katalog-Client-Skript zugeordnet wird.

    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.setCatalogItem("039c516237b1300054b6a3549dbe5dfc");

## CatalogClientScript -- setOnChangeVariable(Zeichenfolge sys_ID) {#ariaid-title12}

Führt das Katalog-Client-Skript aus, wenn ein Variablenwert aktualisiert wird.
{#r_CCSS-setOnChangeVariable_S__table_m3r_3cs_sy__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| sys_id | Zeichenfolge | SYS_ID der Variablen. |
[Tabelle : 20. Parameter]

{#r_CCSS-setOnChangeVariable_S__table_m3r_3cs_sy} {#r_CCSS-setOnChangeVariable_S__table_n3r_3cs_sy__entry__2}

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 21. Rückgaben]

{#r_CCSS-setOnChangeVariable_S__table_n3r_3cs_sy}  
Dieses Beispiel zeigt, wie die Methode aufgerufen wird.

    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.setOnChangeVariable("039c516237b1300054b6a3549dbe5dfc");

## CatalogClientScript -- setVariableSet(Zeichenfolge sys_ID) {#ariaid-title13}

Ordnet dem Katalog-Client-Skript einen Variablensatz zu.
{#r_CCSS-setVariableSet_S__table_cvz_tbs_sy__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| sys_id | Zeichenfolge | SYS_ID des Variablensatzes. |
[Tabelle : 22. Parameter]

{#r_CCSS-setVariableSet_S__table_cvz_tbs_sy} {#r_CCSS-setVariableSet_S__table_dvz_tbs_sy__entry__2}

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 23. Rückgaben]

{#r_CCSS-setVariableSet_S__table_dvz_tbs_sy}  
Dieses Beispiel zeigt, wie die Methode aufgerufen wird.

    var catalogClientScript = new sn_sc.CatalogClientScript();
    catalogClientScript.setVariableSet("039c516237b1300054b6a3549dbe5dfc");


