CatCategory - com escopo

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 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.

    CatCategory - availableForUserCriteria(ação de cadeia de caracteres, critérios de matrizIDs)

    Adiciona os critérios do usuário Available For à categoria do catálogo atual.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    ação Cadeia de caracteres Ação a ser executada.
    • add: adiciona os critérios do usuário à lista Disponível para.
    • delete: exclui os critérios do usuário da lista Disponível para.
    critériosIDs Matriz Matriz dos critérios do usuário sys_ids.
    Tabela 2. Retornos
    Tipo Descrição
    vazio
    var item = new sn_sc.CatCategory("31bea3d53790200044e0bfc8bcbe5dec");
    item.availableForUserCriteria("add", ["0c441abbc6112275000025157c651c89"]);

    CatCategory - canView (booliano isMobile, cadeia de caracteres userSysId)

    Determina se um usuário especificado pode exibir uma categoria especificada em um dispositivo móvel ou desktop.

    Tabela 3. Parâmetros
    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 4. Retornos
    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.
    var scopedCategoryObj = new sn_sc.CatCategory('7b1262b9530033007444ddeeff7b12ae');
    scopedCategoryObj.canView(false, '62826bf03710200044e0bfc8bcbe5df1');

    CatCategory - create(Booliano StandardUpdate)

    Insira a categoria definida.

    Tabela 5. Parâmetros
    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.
    Tabela 6. Retornos
    Tipo Descrição
    Cadeia de caracteres Sys_id do registro de variável inserido.
    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)

    Exclui o registro de categoria no qual a classe CatCategory foi instanciada inicialmente.

    Tabela 7. Parâmetros
    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.
    Tabela 8. Retornos
    Tipo Descrição
    vazio
    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()

    Retorna o sys_id da categoria atual.

    Tabela 9. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 10. Retorna
    Tipo Descrição
    Cadeia de caracteres Sys_id da categoria atual.

    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)

    Adiciona os critérios do usuário Not Available For a uma categoria do catálogo.

    Tabela 11. Parâmetros
    Nome Tipo Descrição
    ação Cadeia de caracteres Ação a ser executada.
    • add: adiciona os critérios do usuário à lista Não disponível para.
    • delete: exclui os critérios do usuário da lista Não disponível para.
    Tabela 12. Retornos
    Tipo Descrição
    vazio
    var item = new sn_sc.CatCategory("31bea3d53790200044e0bfc8bcbe5dec");
    item. notAvailableForUserCriteria("add", ["0c441abbc6112275000025157c651c89"]);

    CatCategory - read (colunas de objeto, booliano padrãoAtualizar)

    Retorna um mapeamento da categoria.

    Tabela 13. Parâmetros
    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.
    Tabela 14. Retornos
    Tipo Descrição
    Objeto Mapeamento de nomes de coluna para valores.
    var category = new sn_sc.CatCategory("a96277509f300200b407b89a442e704e");
    var values = category.read({"title" : ""}, true);
    gs.log(values.title);

    CatCategory - setAttributes(atributos de objeto)

    Define os valores de atributo para esta categoria.

    Tabela 15. Parâmetros
    Nome Tipo Descrição
    atributos Objeto Atributos para os novos pares de campo e valor.
    Tabela 16. Retornos
    Tipo Descrição
    vazio
    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")

    Define o nome da tabela para esta categoria.

    Tabela 17. Parâmetros
    Nome Tipo Descrição
    tableName Cadeia de caracteres Nome da tabela que estende sc_category.
    Tabela 18. Retornos
    Tipo Descrição
    vazio
    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)

    Atualiza a categoria atual com os pares de nome-valor especificados.

    Tabela 19. Parâmetros
    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.
    Tabela 20. Retornos
    Tipo Descrição
    vazio
    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");