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


---

# UserCriteria - Dans le champ d'application

# UserCriteria - 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 UserCriteria fournit des méthodes pour créer, modifier et supprimer des enregistrements de critères d'utilisateur à l'aide de scripts.

Pour utiliser cette classe dans une application incluse dans le périmètre, utilisez l'identificateur `d'espace` de noms sn_uc. Le module d'extension de l'API incluse dans le périmètre des critères d'utilisateur (ID : com.glideapp.user_criteria.scoped.api) doit être activé pour accéder à cette API.

## UserCriteria : UserCriteria() {#ariaid-title2}

Crée une instance de la classe UserCriteria.  

    var uc = new sn_uc.UserCriteria();

## UserCriteria : UserCriteria (chaîne sys_id) {#ariaid-title3}

Crée une instance de la classe UserCriteria avec le sys_id spécifié.
{#r_UCS-UserCriteria_S__table_dxz_fz2_vz__entry__3}

| Nom | Type | Description |
|-|-|-|
| sys_id | Chaîne | sys_id des critères d'utilisateur. |
[Tableau 1. Paramètres]

{#r_UCS-UserCriteria_S__table_dxz_fz2_vz}  

    var uc = new sn_uc.UserCriteria("31bea3d53790200044e0bfc8bcbe5dec");

## UserCriteria : create(Object columnValues, Boolean standardUpdate) {#ariaid-title4}

Crée un critère d'utilisateur avec les valeurs spécifiées dans la table user_criteria. Les valeurs spécifiées dans columnValues remplacent les valeurs fournies par les setters.
{#r_UCS-create_O_B__table_ncp_prf_vz__entry__3}

| Nom | Type | Description |
|-|-|-|
| columnValues (colonnes de valeurs) | Objet | Paires de clés et de valeurs pour une colonne et sa valeur. |
| standardUpdate (Mise à jour standard) | Booléen | Définissez la valeur sur vrai pour activer l'exécution des moteurs et du workflow. |
[Tableau 2. Paramètres]

{#r_UCS-create_O_B__table_ncp_prf_vz} {#r_UCS-create_O_B__table_ocp_prf_vz__entry__2}

| Type | Description |
|-|-|
| Chaîne | sys_id des critères d'utilisateur créés. |
[Tableau 3. Renvoie]

{#r_UCS-create_O_B__table_ocp_prf_vz}  

    var uc = new sn_uc.UserCriteria(); 
    uc.setCompanies("31bea3d53790200044e0bfc8bcbe5dec,0c441abbc6112275000025157c651c89");
    uc.setActive(true); 
    uc.setUsers("31bea3d53790200044e0bfc8bcbe5dec,0c441abbc6112275000025157c651c89");
    var UserCriteriaId = uc.create();
    gs.info(UserCriteriaId);

Sortie :

    41bea3d53790200044e0bfc8bcbe5dec

## UserCriteria : deleteRecord() {#ariaid-title5}

Supprime les critères d'utilisateur actuels.
{#r_UCS-deleteRecord__table_erq_jlf_vz__entry__3}

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

{#r_UCS-deleteRecord__table_erq_jlf_vz} {#r_UCS-deleteRecord__table_frq_jlf_vz__entry__2}

| Type | Description |
|-|-|
| Booléen | Si vrai, les critères d'utilisateur sont supprimés. Si la valeur est \<\< faux \>\>, aucun critère d'utilisateur à supprimer n'est trouvé. |
[Tableau 5. Renvoie]

{#r_UCS-deleteRecord__table_frq_jlf_vz}  

    var uc = new sn_uc.UserCriteria("31bea3d53790200044e0bfc8bcbe5dec");
    uc.deleteRecord();

Sortie :

    true

## UserCriteria : lire (colonnes de chaîne) {#ariaid-title6}

Affiche le mappage pour les paires d'attributs et de valeurs de l'élément de catalogue.
{#r_UCS-read_S__table_rnk_bpf_vz__entry__3}

| Nom | Type | Description |
|-|-|-|
| colonnes | Chaîne | Tableau d'attributs d'éléments de catalogue. |
[Tableau 6. Paramètres]

{#r_UCS-read_S__table_rnk_bpf_vz} {#r_UCS-read_S__table_snk_bpf_vz__entry__2}

| Type | Description |
|-|-|
| Objet | Mappage des paires d'attributs et de valeurs de l'élément de catalogue. |
[Tableau 7. Renvoie]

{#r_UCS-read_S__table_snk_bpf_vz}  

    var uc = new sn_uc.UserCriteria("7b8a6927ef732100438236caa5c0fb89");
    var obj = uc.read(["company","name"]);
    gs.info(JSON.stringify(obj));

Sortie :

    Script: {"name":"All ACME Corporation employees","company":"e7c1f3d53790200044e0bfc8bcbe5deb,227cdfb03710200044e0bfc8bcbe5d6b,86c1f3193790200044e0bfc8bcbe5d95,98c37b193790200044e0bfc8bcbe5dbe,81f95197ac1d55eb35432fd1e068385e,df7d53303710200044e0bfc8bcbe5dac,81fdf9ebac1d55eb4cb89f136a082555,4b7d13f03710200044e0bfc8bcbe5db6,81f87336ac1d55eb06002def816d139f,81fbfe03ac1d55eb286d832de58ae1fd,81fca4cbac1d55eb355b4b6db0e3c80f,187d13f03710200044e0bfc8bcbe5df2,81fd65ecac1d55eb42a426568fc87a63,31bea3d53790200044e0bfc8bcbe5dec,81f75fcaac1d55eb2b0781d6f2c3c260"}

## UserCriteria : setActive(booléen actif) {#ariaid-title7}

Spécifie si les critères d'utilisateur sont actifs.
{#r_UCS-setActive_B__table_lc1_x3f_vz__entry__3}

| Nom | Type | Description |
|-|-|-|
| Actif | Booléen | Si vrai, les critères d'utilisateur sont actifs. Si la valeur est définie sur faux, les critères d'utilisateur sont inactifs. |
[Tableau 8. Paramètres]

{#r_UCS-setActive_B__table_lc1_x3f_vz} {#r_UCS-setActive_B__table_mc1_x3f_vz__entry__2}

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

{#r_UCS-setActive_B__table_mc1_x3f_vz}  

    var uc = new sn_uc.UserCriteria();
    uc.setActive(true); 

## UserCriteria : setAdvanced(booléen avancé) {#ariaid-title8}

Spécifie si les critères d'utilisateur ont un script avancé.
{#r_UCS-setAdvanced_B__table_eps_xff_vz__entry__3}

| Nom | Type | Description |
|-|-|-|
| Avancés | Booléen | Si vrai, les critères d'utilisateur ont un script avancé. Si la valeur est définie sur false, les critères d'utilisateur n'ont pas de script avancé. |
[Tableau 10. Paramètres]

{#r_UCS-setAdvanced_B__table_eps_xff_vz} {#r_UCS-setAdvanced_B__table_fps_xff_vz__entry__2}

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

{#r_UCS-setAdvanced_B__table_fps_xff_vz}  

    var uc = new sn_uc.UserCriteria();
    uc.setAdvanced(true); 

## UserCriteria : setCompanies(String companies) {#ariaid-title9}

Définit la propriété de l'entreprise pour les critères d'utilisateur.
{#r_UCS-setCompanies_S__table_qrr_gff_vz__entry__3}

| Nom | Type | Description |
|-|-|-|
| Entreprises | Chaîne | Liste séparée par des virgules des sys_ids de société à définir pour les critères d'utilisateur. |
[Tableau 12. Paramètres]

{#r_UCS-setCompanies_S__table_qrr_gff_vz} {#r_UCS-setCompanies_S__table_rrr_gff_vz__entry__2}

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

{#r_UCS-setCompanies_S__table_rrr_gff_vz}  

    var uc = new sn_uc.UserCriteria();
    uc.setCompanies("31bea3d53790200044e0bfc8bcbe5dec,0c441abbc6112275000025157c651c89"); 

## UserCriteria : setDepartments(String departments) {#ariaid-title10}

Définit la propriété du département pour les critères d'utilisateur.
{#r_UCS-setDepartments_S__table_k24_ddf_vz__entry__3}

| Nom | Type | Description |
|-|-|-|
| départements | Chaîne | Liste séparée par des virgules des sys_ids de département à définir pour les critères d'utilisateur. |
[Tableau 14. Paramètres]

{#r_UCS-setDepartments_S__table_k24_ddf_vz} {#r_UCS-setDepartments_S__table_l24_ddf_vz__entry__2}

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

{#r_UCS-setDepartments_S__table_l24_ddf_vz}  

    var uc = new sn_uc.UserCriteria();
    uc.setDepartments("31bea3d53790200044e0bfc8bcbe5dec,0c441abbc6112275000025157c651c89"); 

## UserCriteria : setGroups(groupes de chaînes) {#ariaid-title11}

Définit la propriété de groupe pour les critères d'utilisateur.
{#r_UCS-setGroups_S__table_zzq_j3f_vz__entry__3}

| Nom | Type | Description |
|-|-|-|
| groupes | Chaîne | Liste séparée par des virgules des sys_ids de groupe à définir pour les critères d'utilisateur. |
[Tableau 16. Paramètres]

{#r_UCS-setGroups_S__table_zzq_j3f_vz} {#r_UCS-setGroups_S__table_a1r_j3f_vz__entry__2}

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

{#r_UCS-setGroups_S__table_a1r_j3f_vz}  

    var uc = new sn_uc.UserCriteria();
    uc.setGroups("31bea3d53790200044e0bfc8bcbe5dec,0c441abbc6112275000025157c651c89"); 

## UserCriteria : setLocations(String locations) {#ariaid-title12}

Définit la propriété d'emplacement pour les critères d'utilisateur.
{#r_UCS-setLocations_S__table_hrs_42f_vz__entry__3}

| Nom | Type | Description |
|-|-|-|
| locations | Chaîne | Liste séparée par des virgules des sys_ids d'emplacement à définir pour les critères d'utilisateur. |
[Tableau 18. Paramètres]

{#r_UCS-setLocations_S__table_hrs_42f_vz} {#r_UCS-setLocations_S__table_irs_42f_vz__entry__2}

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

{#r_UCS-setLocations_S__table_irs_42f_vz}  

    var uc = new sn_uc.UserCriteria();
    uc.setLocations("31bea3d53790200044e0bfc8bcbe5dec,0c441abbc6112275000025157c651c89"); 

## UserCriteria : setMatchAll(booléen match_all) {#ariaid-title13}

Définit la propriété match_all pour les critères d'utilisateur.
{#r_UCS-setMatchAll_B__table_wvg_gkf_vz__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun | match_all | Si vrai, toutes les conditions définies en tant que propriétés pour les critères d'utilisateur doivent être remplies. Si la valeur est définie sur false, au moins une condition définie en tant que propriété des critères d'utilisateur doit être remplie. |
[Tableau 20. Paramètres]

{#r_UCS-setMatchAll_B__table_wvg_gkf_vz} {#r_UCS-setMatchAll_B__table_xvg_gkf_vz__entry__2}

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

{#r_UCS-setMatchAll_B__table_xvg_gkf_vz}  

    var uc = new sn_uc.UserCriteria();
    uc.setMatchAll(true); 

## UserCriteria : setName(nom de la chaîne) {#ariaid-title14}

Définit la propriété de nom pour les critères d'utilisateur.
{#r_UCS-setName_S__table_qzy_vhf_vz__entry__3}

| Nom | Type | Description |
|-|-|-|
| nom | Chaîne | Nom des critères d'utilisateur. |
[Tableau 22. Paramètres]

{#r_UCS-setName_S__table_qzy_vhf_vz} {#r_UCS-setName_S__table_rzy_vhf_vz__entry__2}

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

{#r_UCS-setName_S__table_rzy_vhf_vz}  

    var uc = new sn_uc.UserCriteria();
    uc.setName("Property1"); 

## UserCriteria : setRoles(rôles de chaîne) {#ariaid-title15}

Définit la propriété de rôle pour les critères d'utilisateur.
{#r_UCS-setRoles_S__table_wxt_h1f_vz__entry__3}

| Nom | Type | Description |
|-|-|-|
| roles | Chaîne | Liste séparée par des virgules des sys_ids de rôles à définir pour les critères d'utilisateur. |
[Tableau 24. Paramètres]

{#r_UCS-setRoles_S__table_wxt_h1f_vz} {#r_UCS-setRoles_S__table_xxt_h1f_vz__entry__2}

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

{#r_UCS-setRoles_S__table_xxt_h1f_vz}  

    var uc = new sn_uc.UserCriteria();
    uc.setRoles("31bea3d53790200044e0bfc8bcbe5dec,0c441abbc6112275000025157c651c89"); 

## UserCriteria : setScript(script de chaîne) {#ariaid-title16}

Définit le script pour les critères d'utilisateur.
{#r_UCS-setScript_S__table_elp_zgf_vz__entry__3}

| Nom | Type | Description |
|-|-|-|
| script | Chaîne | Script à définir pour les critères d'utilisateur avancés. |
[Tableau 26. Paramètres]

{#r_UCS-setScript_S__table_elp_zgf_vz} {#r_UCS-setScript_S__table_flp_zgf_vz__entry__2}

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

{#r_UCS-setScript_S__table_flp_zgf_vz}  

    var uc = new sn_uc.UserCriteria();
    uc.setScript("function scriptTest() {
      var retVal;
      if (gs.getUser().getRecord().getDisplayValue('department') == 'Product Management') {
          retVal = true;
      } else {
          retVal = false;
      }
      return retVal;
    }"); 

## UserCriteria : setUsers(String users) {#ariaid-title17}

Définit la propriété d'utilisateur pour les critères d'utilisateur.
{#r_UCS-setUsers_S__table_npm_qbf_vz__entry__3}

| Nom | Type | Description |
|-|-|-|
| utilisateurs | Chaîne | Liste séparée par des virgules des sys_ids d'utilisateur à définir pour les critères d'utilisateur. |
[Tableau 28. Paramètres]

{#r_UCS-setUsers_S__table_npm_qbf_vz} {#r_UCS-setUsers_S__table_opm_qbf_vz__entry__2}

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

{#r_UCS-setUsers_S__table_opm_qbf_vz}  

    var uc = new sn_uc.UserCriteria();
    uc.setUsers("31bea3d53790200044e0bfc8bcbe5dec,0c441abbc6112275000025157c651c89"); 

## UserCriteria : update(Object columnValues, String reason) {#ariaid-title18}

Met à jour l'élément de catalogue actuel avec les valeurs spécifiées.
{#r_UCS-update_O_S__table_nrg_fmf_vz__entry__3}

| Nom | Type | Description |
|-|-|-|
| columnValues (colonnes de valeurs) | Objet | Mappage pour le nom de colonne et les paires de valeurs. |
| motif | Chaîne | Motif de la mise à jour de l'élément de catalogue. |
[Tableau 30. Paramètres]

{#r_UCS-update_O_S__table_nrg_fmf_vz} {#r_UCS-update_O_S__table_org_fmf_vz__entry__2}

| Type | Description |
|-|-|
| Chaîne | Renvoie la sys_id des critères d'utilisateur créés. |
[Tableau 31. Renvoie]

{#r_UCS-update_O_S__table_org_fmf_vz}  

    var uc = new sn_uc.UserCriteria();
    uc.update("name": "Updated name", "The existing name is not relevant. Setting a relevant name"); 

Sortie :

    31bea3d53790200044e0bfc8bcbe5dec