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


---

# CatCategory - com escopo

# CatCategory - 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 CatCategory fornece métodos que permitem criar e modificar categorias do catálogo de serviços usando scripts.

Esta API é executada no namespace `sn_sc`.  
Importante:  
Esta API está acessível; no entanto, a implementação recomendada é a [REST API do Catálogo de serviços](https://servicenow-prod.fluidtopics.net/CjuMVB2PsJ3YyMaD6jyIhw#c_ServiceCatalogAPI "A API do Catálogo de serviços fornece endpoints que acessam Catálogo de serviços configuração e ações de dentro de um Portal de serviços.").

## CatCategory - availableForUserCriteria(ação de cadeia de caracteres, critérios de matrizIDs) {#ariaid-title2}

Adiciona os critérios do usuário Available For à categoria do catálogo atual.
{#r_CCS-availableForUserCriteria_S_A__table_oz2_pln_vz__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| ação | Cadeia de caracteres | Ação a ser executada. * <kbd class="ph userinput">add</kbd>: adiciona os critérios do usuário à lista Disponível para. * <kbd class="ph userinput">delete</kbd>: exclui os critérios do usuário da lista Disponível para. {#r_CCS-availableForUserCriteria_S_A__ul_gc4_bs4_kpb} |
| critériosIDs | Matriz | Matriz dos critérios do usuário sys_ids. |
[Tabela 1. Parâmetros]

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

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

{#r_CCS-availableForUserCriteria_S_A__table_pz2_pln_vz}  

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

## CatCategory - canView (booliano isMobile, cadeia de caracteres userSysId) {#ariaid-title3}

Determina se um usuário especificado pode exibir uma categoria especificada em um dispositivo móvel ou desktop.
{#CCS-canView_B_S__table_j5n_smk_chb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| isMobile | Booliano | Sinalizador que indica se o usuário deve verificar o acesso em um dispositivo móvel ou desktop. * verdadeiro: validar para dispositivos móveis. * falso: validar para desktop. |
| userSysId | Cadeia de caracteres | Sys_id do usuário a ser validado. |
[Tabela 3. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Booliano | Sinalizador que indica se o usuário pode exibir a categoria associada. * verdadeiro: o usuário pode exibir a categoria. * falso: o usuário não pode exibir a categoria. {#CCS-canView_B_S__ul_iwk_ynk_chb} |
[Tabela 4. Retorna]

{#CCS-canView_B_S__table_k5n_smk_chb}  

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

## CatCategory - create(Booliano StandardUpdate) {#ariaid-title4}

Insira a categoria definida.
{#r_CatCategory-create_Boolean__table_afn_1b2_ns__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| padrãoAtualizar | Booliano | Sinalizador que indica se a execução de mecanismos e fluxos de trabalho deve ser habilitada. Valores válidos: * verdadeiro: habilitar mecanismos e fluxo de trabalho. * falso: não habilite mecanismos e fluxo de trabalho. {#r_CatCategory-create_Boolean__ul_nnx_xwn_kpb} |
[Tabela 5. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Sys_id do registro de variável inserido. |
[Tabela 6. Retorna]

{#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(Booliano StandardUpdate) {#ariaid-title5}

Exclui o registro de categoria no qual a classe CatCategory foi instanciada inicialmente.
{#r_CatCategory-deleteRecord_Boolean__table_xzp_4b2_ns__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| padrãoAtualizar | Booliano | Sinalizador que indica se a execução de mecanismos e fluxos de trabalho deve ser habilitada. Valores válidos: * verdadeiro: habilitar mecanismos e fluxo de trabalho. * falso: não habilite mecanismos e fluxo de trabalho. {#r_CatCategory-deleteRecord_Boolean__ul_nnx_xwn_kpb} |
[Tabela 7. Parâmetros]

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

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

{#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}

Retorna o sys_id da categoria atual.
{#CCS-getID__table_db4_h4d_sbb__entry__3}

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

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

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Sys_id da categoria atual. |
[Tabela 10. Retorna]

{#CCS-getID__table_eb4_h4d_sbb}  
Exemplo:

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

Saída:

    2809952237b1300054b6a3549dbe5dd4

## CatCategory - notAvailableForUserCriteria(ação de cadeia de caracteres, Array \[\] critériosIDs) {#ariaid-title7}

Adiciona os critérios do usuário Not Available For a uma categoria do catálogo.
{#r_CCS-notAvailableForUserCriteria_S_A__table_yxb_1mn_vz__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| ação | Cadeia de caracteres | Ação a ser executada. * <kbd class="ph userinput">add</kbd>: adiciona os critérios do usuário à lista Não disponível para. * <kbd class="ph userinput">delete</kbd>: exclui os critérios do usuário da lista Não disponível para. {#r_CCS-notAvailableForUserCriteria_S_A__ul_gc4_bs4_kpb} |
[Tabela 11. Parâmetros]

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

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

{#r_CCS-notAvailableForUserCriteria_S_A__table_zxb_1mn_vz}  

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

## CatCategory - read (colunas de objeto, booliano padrãoAtualizar) {#ariaid-title8}

Retorna um mapeamento da categoria.
{#r_CatCategory-read_Object_Boolean__table_p2h_5b2_ns__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| colunas | Objeto | Conjunto de colunas para os quais você deseja os valores. |
| padrãoAtualizar | Booliano | Sinalizador que indica se a execução de mecanismos e fluxos de trabalho deve ser habilitada. Valores válidos: * verdadeiro: habilitar mecanismos e fluxo de trabalho. * falso: não habilite mecanismos e fluxo de trabalho. {#r_CatCategory-read_Object_Boolean__ul_nnx_xwn_kpb} |
[Tabela 13. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Objeto | Mapeamento de nomes de coluna para valores. |
[Tabela 14. Retorna]

{#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(atributos de objeto) {#ariaid-title9}

Define os valores de atributo para esta categoria.
{#r_CatCategory-setAttributes_Object__table_psn_512_ns__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| atributos | Objeto | Atributos para os novos pares de campo e valor. |
[Tabela 15. Parâmetros]

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

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

{#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(cadeia de caracteres "tableName") {#ariaid-title10}

Define o nome da tabela para esta categoria.
{#r_CatCategory-setTableName_String__table_vh4_3dl_qs__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| tableName | Cadeia de caracteres | Nome da tabela que estende sc_category. |
[Tabela 17. Parâmetros]

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

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

{#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 - atualizar (objeto columnValues, Booliano padrãoAtualizar) {#ariaid-title11}

Atualiza a categoria atual com os pares de nome-valor especificados.
{#r_CatCategory-update_Object_Boolean__table_dfz_fb2_ns__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| columnValues | Objeto | Mapeamento de nomes de coluna para valores. |
| padrãoAtualizar | Booliano | Sinalizador que indica se a execução de mecanismos e fluxos de trabalho deve ser habilitada. Valores válidos: * verdadeiro: habilitar mecanismos e fluxo de trabalho. * falso: não habilite mecanismos e fluxo de trabalho. {#r_CatCategory-update_Object_Boolean__ul_nnx_xwn_kpb} |
[Tabela 19. Parâmetros]

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

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

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