---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# UserCriteria - com escopo

# UserCriteria - com escopo {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 4 min. de leitura

A API UserCriteria fornece métodos para criar, modificar e excluir registros de critérios do usuário usando scripts.

Para usar esta classe em uma aplicação com escopo, use o identificador de namespace `sn_uc`. O plug-in User Criteria Scoped API (ID: com.glideapp.user_criteria.scoped.api) deve ser habilitado para acessar esta API.

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

Cria uma instância da classe UserCriteria.  

    var uc = new sn_uc.UserCriteria();

## UserCriteria - UserCriteria(cadeia de caracteres sys_id) {#ariaid-title3}

Cria uma instância da classe UserCriteria com o sys_id especificado.
{#r_UCS-UserCriteria_S__table_dxz_fz2_vz__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| sys_id | Cadeia de caracteres | sys_id dos critérios do usuário. |
[Tabela 1. Parâmetros]

{#r_UCS-UserCriteria_S__table_dxz_fz2_vz}  

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

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

Cria critérios do usuário com valores especificados na tabela user_criteria. Os valores especificados em columnValues substituem os valores fornecidos por meio de setters.
{#r_UCS-create_O_B__table_ncp_prf_vz__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| columnValues | Objeto | Pares de chave e valor para uma coluna e seu valor. |
| padrãoAtualizar | Booliano | Defina como verdadeiro para habilitar a execução de mecanismos e fluxos de trabalho. |
[Tabela 2. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | sys_id dos critérios do usuário criados. |
[Tabela 3. Retorna]

{#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);

Saída:

    41bea3d53790200044e0bfc8bcbe5dec

## Critérios de usuário - deleteRecord() {#ariaid-title5}

Exclui os critérios do usuário atual.
{#r_UCS-deleteRecord__table_erq_jlf_vz__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 4. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Booliano | Se verdadeiro, os critérios do usuário serão excluídos. Se falso, nenhum critério do usuário foi encontrado para excluir. |
[Tabela 5. Retorna]

{#r_UCS-deleteRecord__table_frq_jlf_vz}  

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

Saída:

    true

## UserCriteria - read (colunas de cadeia de caracteres) {#ariaid-title6}

Exibe o mapeamento dos pares de atributo e valor do item do catálogo.
{#r_UCS-read_S__table_rnk_bpf_vz__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| colunas | Cadeia de caracteres | Matriz de atributos de item do catálogo. |
[Tabela 6. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Objeto | Mapeamento para os pares de atributo e valor do item do catálogo. |
[Tabela 7. Retorna]

{#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));

Saída:

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

## UserCriteria - setActive (booliano ativo) {#ariaid-title7}

Especifica se os critérios do usuário estão ativos.
{#r_UCS-setActive_B__table_lc1_x3f_vz__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| ativo | Booliano | Se verdadeiro, os critérios do usuário estão ativos. Se falso, os critérios do usuário estão inativos. |
[Tabela 8. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 9. Retorna]

{#r_UCS-setActive_B__table_mc1_x3f_vz}  

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

## UserCriteria - setAdvanced(booliano avançado) {#ariaid-title8}

Especifica se os critérios do usuário têm um script avançado.
{#r_UCS-setAdvanced_B__table_eps_xff_vz__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| avançado | Booliano | Se verdadeiro, os critérios do usuário têm um script avançado. Se falso, os critérios do usuário não terão um script avançado. |
[Tabela 10. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 11. Retorna]

{#r_UCS-setAdvanced_B__table_fps_xff_vz}  

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

## UserCriteria - setCompanies(cadeia de caracteres empresas) {#ariaid-title9}

Define a propriedade da empresa para os critérios do usuário.
{#r_UCS-setCompanies_S__table_qrr_gff_vz__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| empresas | Cadeia de caracteres | Lista separada por vírgulas dos sys_ids da empresa a serem definidos para os critérios do usuário. |
[Tabela 12. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 13. Retorna]

{#r_UCS-setCompanies_S__table_rrr_gff_vz}  

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

## UserCriteria - setDepartments(cadeia de caracteres departamentos) {#ariaid-title10}

Define a propriedade do departamento para os critérios do usuário.
{#r_UCS-setDepartments_S__table_k24_ddf_vz__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| departamentos | Cadeia de caracteres | Lista separada por vírgulas dos sys_ids do departamento a serem definidos para os critérios do usuário. |
[Tabela 14. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 15. Retorna]

{#r_UCS-setDepartments_S__table_l24_ddf_vz}  

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

## UserCriteria - setGroups(cadeias de caracteres grupos) {#ariaid-title11}

Define a propriedade do grupo para os critérios do usuário.
{#r_UCS-setGroups_S__table_zzq_j3f_vz__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| grupos | Cadeia de caracteres | Lista separada por vírgulas dos sys_ids do grupo a serem definidos para os critérios do usuário. |
[Tabela 16. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 17. Retorna]

{#r_UCS-setGroups_S__table_a1r_j3f_vz}  

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

## UserCriteria - setLocations(cadeia de caracteres locais) {#ariaid-title12}

Define a propriedade de local para os critérios do usuário.
{#r_UCS-setLocations_S__table_hrs_42f_vz__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| localizações | Cadeia de caracteres | Lista separada por vírgulas dos sys_ids de local a serem definidos para os critérios do usuário. |
[Tabela 18. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 19. Retorna]

{#r_UCS-setLocations_S__table_irs_42f_vz}  

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

## UserCriteria - setMatchAll(Boolean match_all) {#ariaid-title13}

Define a propriedade match_all para os critérios do usuário.
{#r_UCS-setMatchAll_B__table_wvg_gkf_vz__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum(a) | corresponder_a todos | Se verdadeiro, todas as condições definidas como propriedades para os critérios do usuário devem ser atendidas. Se falso, pelo menos uma condição definida como uma propriedade para os critérios do usuário deverá ser atendida. |
[Tabela 20. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 21. Retorna]

{#r_UCS-setMatchAll_B__table_xvg_gkf_vz}  

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

## UserCriteria - setName(cadeia de caracteres name) {#ariaid-title14}

Define a propriedade de nome para os critérios do usuário.
{#r_UCS-setName_S__table_qzy_vhf_vz__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| nome | Cadeia de caracteres | Nome dos critérios do usuário. |
[Tabela 22. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 23. Retorna]

{#r_UCS-setName_S__table_rzy_vhf_vz}  

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

## UserCriteria - setRoles(Funções de cadeia de caracteres) {#ariaid-title15}

Define a propriedade de função para os critérios do usuário.
{#r_UCS-setRoles_S__table_wxt_h1f_vz__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| funções | Cadeia de caracteres | Lista separada por vírgulas da função sys_ids a ser definida para os critérios do usuário. |
[Tabela 24. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 25. Retorna]

{#r_UCS-setRoles_S__table_xxt_h1f_vz}  

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

## UserCriteria - setScript(cadeia de caracteres script) {#ariaid-title16}

Define o script para os critérios do usuário.
{#r_UCS-setScript_S__table_elp_zgf_vz__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| script | Cadeia de caracteres | Script a ser definido para os critérios avançados do usuário. |
[Tabela 26. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 27. Retorna]

{#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;
    }"); 

## Critérios de usuário - setUsers(cadeia de caracteres usuários) {#ariaid-title17}

Define a propriedade do usuário para os critérios do usuário.
{#r_UCS-setUsers_S__table_npm_qbf_vz__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| usuários | Cadeia de caracteres | Lista separada por vírgulas dos sys_ids do usuário a serem definidos para os critérios do usuário. |
[Tabela 28. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 29. Retorna]

{#r_UCS-setUsers_S__table_opm_qbf_vz}  

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

## UserCriteria - update (objeto columnValues, motivo da cadeia de caracteres) {#ariaid-title18}

Atualiza o item do catálogo atual com os valores especificados.
{#r_UCS-update_O_S__table_nrg_fmf_vz__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| columnValues | Objeto | Mapeamento para o nome da coluna e os pares de valores. |
| motivo | Cadeia de caracteres | Motivo para atualizar o item do catálogo. |
[Tabela 30. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Retorna o sys_id dos critérios do usuário criados. |
[Tabela 31. Retorna]

{#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"); 

Saída:

    31bea3d53790200044e0bfc8bcbe5dec