---
sourceDocument: Référence de l’API Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - fr-FR

ft:publication_title :

    - Référence de l’API Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# CatCategory : inclus dans le champ d'application

# CatCategory : inclus dans le champ d'application {#ariaid-title1}

* Rversion finale: Xanadu
* 
* Mis à jour 1 août 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 4 minutes de lecture

L'API CatCategory fournit des méthodes qui vous permettent de créer et de modifier des catégories de catalogue de services à l'aide de scripts.

Cette API s'exécute dans l'espace de noms `sn_sc` .  
Important :  
Cette API est accessible ; Toutefois, l'implémentation recommandée est [l'API REST Catalogue de services](https://servicenow-prod.fluidtopics.net/dednQB_~L6Wvep9IGOpmUQ#c_ServiceCatalogAPI "L’API Service Catalog fournit des points de terminaison qui accèdent à Catalogue de services la configuration et aux actions à partir d’un .Portail de services").

## CatCategory : availableForUserCriteria(Action de chaîne, tableau criteriaIDs) {#ariaid-title2}

Ajoute les critères d'utilisateur à la catégorie actuelle du Available For catalogue.
{#r_CCS-availableForUserCriteria_S_A__table_oz2_pln_vz__entry__3}

| Nom | Type | Description |
|-|-|-|
| action | Chaîne | Action à effectuer. * <kbd class="ph userinput">add</kbd> : ajoute les critères d'utilisateur à la liste Disponible pour . * <kbd class="ph userinput">delete</kbd> : supprime les critères d'utilisateur de la liste Disponible pour . {#r_CCS-availableForUserCriteria_S_A__ul_gc4_bs4_kpb} |
| ID de critères | Tableau | Tableau des critères d'utilisateur sys_ids. |
[Tableau 1. Paramètres]

{#r_CCS-availableForUserCriteria_S_A__table_oz2_pln_vz} {#r_CCS-availableForUserCriteria_S_A__table_pz2_pln_vz__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 2. Renvoie]

{#r_CCS-availableForUserCriteria_S_A__table_pz2_pln_vz}  

    var item = new sn_sc.CatCategory("31bea3d53790200044e0bfc8bcbe5dec");
    item.availableForUserCriteria("add", ["0c441abbc6112275000025157c651c89"]);

## CatCategory : canView(booléen isMobile, chaîne userSysId) {#ariaid-title3}

Détermine si un utilisateur spécifié peut afficher une catégorie spécifiée sur un appareil mobile ou un ordinateur de bureau.
{#CCS-canView_B_S__table_j5n_smk_chb__entry__3}

| Nom | Type | Description |
|-|-|-|
| isMobile | Booléen | Marqueur indiquant s'il faut vérifier l'accès de l'utilisateur sur un appareil mobile ou un ordinateur de bureau. * true : valider pour mobile. * false : valider pour le bureau. |
| userSysId | Chaîne | Sys_id de l'utilisateur à valider. |
[Tableau 3. Paramètres]

{#CCS-canView_B_S__table_j5n_smk_chb} {#CCS-canView_B_S__table_k5n_smk_chb__entry__2}

| Type | Description |
|-|-|
| Booléen | Marqueur indiquant si l'utilisateur peut afficher la catégorie associée. * true : l'utilisateur peut afficher la catégorie. * false : l'utilisateur ne peut pas afficher la catégorie. {#CCS-canView_B_S__ul_iwk_ynk_chb} |
[Tableau 4. Renvoie]

{#CCS-canView_B_S__table_k5n_smk_chb}  

    var scopedCategoryObj = new sn_sc.CatCategory('7b1262b9530033007444ddeeff7b12ae');
    scopedCategoryObj.canView(false, '62826bf03710200044e0bfc8bcbe5df1');

## CatCategory : créer (booléen standardUpdate) {#ariaid-title4}

Insérez la catégorie définie.
{#r_CatCategory-create_Boolean__table_afn_1b2_ns__entry__3}

| Nom | Type | Description |
|-|-|-|
| standardUpdate (Mise à jour standard) | Booléen | Marqueur indiquant s'il faut activer l'exécution des moteurs et du workflow. Valeurs valides : * true : activez les moteurs et le workflow. * false : n'activez pas les moteurs et le workflow. {#r_CatCategory-create_Boolean__ul_nnx_xwn_kpb} |
[Tableau 5. Paramètres]

{#r_CatCategory-create_Boolean__table_afn_1b2_ns} {#r_CatCategory-create_Boolean__table_bfn_1b2_ns__entry__2}

| Type | Description |
|-|-|
| Chaîne | Sys_id de l'enregistrement de variable inséré. |
[Tableau 6. Renvoie]

{#r_CatCategory-create_Boolean__table_bfn_1b2_ns}  

    var categoryCreate = new sn_sc.CatCategory();
    categoryCreate.setAttributes({"title" : "test a scoped category", "sc_catalog" : "e0d08b13c3330100c8b837659bba8fb4"});
    var categorySysId = categoryCreate.create();
    var isValidSysId = categorySysId.match(/^[0-9a-fA-F]{32}$/) == null ? false : true;
    global.Assert.assertEquals(true, isValidSysId,"CategorySysId: ["+ categorySysId +"] is not valid", true, isValidSysId);

## CatCategory : deleteRecord(Boolean standardUpdate) {#ariaid-title5}

Supprime l'enregistrement de catégorie sur lequel la classe CatCategory a été initialement instanciée.
{#r_CatCategory-deleteRecord_Boolean__table_xzp_4b2_ns__entry__3}

| Nom | Type | Description |
|-|-|-|
| standardUpdate (Mise à jour standard) | Booléen | Marqueur indiquant s'il faut activer l'exécution des moteurs et du workflow. Valeurs valides : * true : activez les moteurs et le workflow. * false : n'activez pas les moteurs et le workflow. {#r_CatCategory-deleteRecord_Boolean__ul_nnx_xwn_kpb} |
[Tableau 7. Paramètres]

{#r_CatCategory-deleteRecord_Boolean__table_xzp_4b2_ns} {#r_CatCategory-deleteRecord_Boolean__table_yzp_4b2_ns__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 8. Renvoie]

{#r_CatCategory-deleteRecord_Boolean__table_yzp_4b2_ns}  

    var categoryDelete = new sn_sc.CatCategory(categorySysId);
    categoryDelete.deleteRecord();
    var category = new sn_sc.CatCategory(categorySysId);
    values = category.read({"title" : "", "sc_catalog":""}, false);
    global.Assert.assertEquals("", values.title,"Category should title");

## CatCategory : getID() {#ariaid-title6}

Renvoie les sys_id de la catégorie actuelle.
{#CCS-getID__table_db4_h4d_sbb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 9. Paramètres]

{#CCS-getID__table_db4_h4d_sbb} {#CCS-getID__table_eb4_h4d_sbb__entry__2}

| Type | Description |
|-|-|
| Chaîne | Sys_id de la catégorie actuelle. |
[Tableau 10. Renvoie]

{#CCS-getID__table_eb4_h4d_sbb}  
Exemple :

    var cart = new sn_sc.CatCategory("2809952237b1300054b6a3549dbe5dd4");
    var categoryID = cart.getID();
    gs.info(categoryID);

Sortie :

    2809952237b1300054b6a3549dbe5dd4

## CatCategory : notAvailableForUserCriteria(Action de chaîne, Array\[\] criteriaIDs) {#ariaid-title7}

Ajoute les Not Available For critères d'utilisateur à une catégorie de catalogue.
{#r_CCS-notAvailableForUserCriteria_S_A__table_yxb_1mn_vz__entry__3}

| Nom | Type | Description |
|-|-|-|
| action | Chaîne | Action à effectuer. * <kbd class="ph userinput">ajouter</kbd> : ajoute les critères d'utilisateur à la liste Non disponible pour . * <kbd class="ph userinput">delete</kbd> : supprime les critères d'utilisateur de la liste Non disponible pour . {#r_CCS-notAvailableForUserCriteria_S_A__ul_gc4_bs4_kpb} |
[Tableau 11. Paramètres]

{#r_CCS-notAvailableForUserCriteria_S_A__table_yxb_1mn_vz} {#r_CCS-notAvailableForUserCriteria_S_A__table_zxb_1mn_vz__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 12. Renvoie]

{#r_CCS-notAvailableForUserCriteria_S_A__table_zxb_1mn_vz}  

    var item = new sn_sc.CatCategory("31bea3d53790200044e0bfc8bcbe5dec");
    item. notAvailableForUserCriteria("add", ["0c441abbc6112275000025157c651c89"]);

## CatCategory : read(Colonnes d'objets, booléen standardUpdate) {#ariaid-title8}

Renvoie un mappage de la catégorie.
{#r_CatCategory-read_Object_Boolean__table_p2h_5b2_ns__entry__3}

| Nom | Type | Description |
|-|-|-|
| colonnes | Objet | Ensemble de colonnes dont vous souhaitez obtenir les valeurs. |
| standardUpdate (Mise à jour standard) | Booléen | Marqueur indiquant s'il faut activer l'exécution des moteurs et du workflow. Valeurs valides : * true : activez les moteurs et le workflow. * false : n'activez pas les moteurs et le workflow. {#r_CatCategory-read_Object_Boolean__ul_nnx_xwn_kpb} |
[Tableau 13. Paramètres]

{#r_CatCategory-read_Object_Boolean__table_p2h_5b2_ns} {#r_CatCategory-read_Object_Boolean__table_q2h_5b2_ns__entry__2}

| Type | Description |
|-|-|
| Objet | Mappage des noms de colonnes aux valeurs. |
[Tableau 14. Renvoie]

{#r_CatCategory-read_Object_Boolean__table_q2h_5b2_ns}  

    var category = new sn_sc.CatCategory("a96277509f300200b407b89a442e704e");
    var values = category.read({"title" : ""}, true);
    gs.log(values.title);

## CatCategory : setAttributes(attributs de l'objet) {#ariaid-title9}

Définit les valeurs d'attribut de cette catégorie.
{#r_CatCategory-setAttributes_Object__table_psn_512_ns__entry__3}

| Nom | Type | Description |
|-|-|-|
| attributs | Objet | Attributs des nouvelles paires de champs et de valeurs. |
[Tableau 15. Paramètres]

{#r_CatCategory-setAttributes_Object__table_psn_512_ns} {#r_CatCategory-setAttributes_Object__table_qsn_512_ns__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 16. Renvoie]

{#r_CatCategory-setAttributes_Object__table_qsn_512_ns}  

    var categoryCreate = new sn_sc.CatCategory();
    categoryCreate.setAttributes({"title" : "test a scoped category", "sc_catalog" : "e0d08b13c3330100c8b837659bba8fb4"});
    var categorySysId = categoryCreate.create();
    var isValidSysId = categorySysId.match(/^[0-9a-fA-F]{32}$/) == null ? false : true;
    global.Assert.assertEquals(true, isValidSysId,"CategorySysId: ["+ categorySysId +"] is not valid", true, isValidSysId);

## CatCategory : setTableName(String tableName) {#ariaid-title10}

Définit le nom de table de cette catégorie.
{#r_CatCategory-setTableName_String__table_vh4_3dl_qs__entry__3}

| Nom | Type | Description |
|-|-|-|
| tableName | Chaîne | Nom de la table qui étend sc_category. |
[Tableau 17. Paramètres]

{#r_CatCategory-setTableName_String__table_vh4_3dl_qs} {#r_CatCategory-setTableName_String__table_wh4_3dl_qs__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 18. Renvoie]

{#r_CatCategory-setTableName_String__table_wh4_3dl_qs}  

    var categoryRead = new sn_sc.CatCategory(categorySysId);
    categoryRead.setTableName("test_category");
    var values = categoryRead.read({"title" : "", "sc_catalog":"", "test": ""}, false);
    gs.info(categorySysId);
    gs.info(values.title);
    gs.info(values.test);
    global.Assert.assertEquals("testValue", values.test,"Category extends sc_category and stores its extended value");

## CatCategory : mettre à jour (objet columnValues, booléen standardUpdate) {#ariaid-title11}

Met à jour la catégorie actuelle avec les paires nom-valeur spécifiées.
{#r_CatCategory-update_Object_Boolean__table_dfz_fb2_ns__entry__3}

| Nom | Type | Description |
|-|-|-|
| columnValues (colonnes de valeurs) | Objet | Mappage des noms de colonnes aux valeurs. |
| standardUpdate (Mise à jour standard) | Booléen | Marqueur indiquant s'il faut activer l'exécution des moteurs et du workflow. Valeurs valides : * true : activez les moteurs et le workflow. * false : n'activez pas les moteurs et le workflow. {#r_CatCategory-update_Object_Boolean__ul_nnx_xwn_kpb} |
[Tableau 19. Paramètres]

{#r_CatCategory-update_Object_Boolean__table_dfz_fb2_ns} {#r_CatCategory-update_Object_Boolean__table_efz_fb2_ns__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 20. Renvoie]

{#r_CatCategory-update_Object_Boolean__table_efz_fb2_ns}  

    var categoryUpdate = new sn_sc.CatCategory(categorySysId);
    categoryUpdate.update({"title" : "test changed scoped category"}, true);
    values = categoryUpdate.read({"title" : "", "sc_catalog":""}, false);
    global.Assert.assertEquals("test changed scoped category", values.title,"Category should title");