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


---

# CatalogItemVariableSet - com escopo

# CatalogItemVariableSet - 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) 3 min. de leitura

A API CatalogItemVariableSet fornece métodos que permitem criar e modificar conjuntos de variáveis de item do catálogo de serviços usando scripts.

Esta API é executada no namespace `sn_sc`.

## CatalogItemVariableSet - criar (Boolean StandardUpdate) {#ariaid-title2}

Insere o conjunto de variáveis de item do catálogo definido.
{#r_CatalogItemVariableSet-create_Boolean__table_dk2_55d_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: habilita a execução de mecanismos e fluxos de trabalho. * falso: não habilita a execução de mecanismos e fluxos de trabalho. {#r_CatalogItemVariableSet-create_Boolean__ul_ygw_ztp_lnb} |
[Tabela 1. Parâmetros]

{#r_CatalogItemVariableSet-create_Boolean__table_dk2_55d_ns} {#r_CatalogItemVariableSet-create_Boolean__table_ek2_55d_ns__entry__2}

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

{#r_CatalogItemVariableSet-create_Boolean__table_ek2_55d_ns}  

    // Given an existing catalog item
    var catItemSysId = "e0d08b13c3330100c8b837659bba8fb4";
    addVariableSets(catItemSysId);

    function addVariableSets(catItemSysId) {
      // List of all variable sets to attach
      var myVarSets = [];

      // Create variable set
      var myVarSetAttrs = {"name": "Requester details", "order": "100"};
      var myVarSet = new sn_sc.CatalogItemVariableSet();
      myVarSet.setAttributes(myVarSetAttrs);
      var myVarSetId = myVarSet.create(true);
      myVarSets.push(myVarSetId);
    }

## CatalogItemVariableSet - deleteRecord(Booliano StandardUpdate) {#ariaid-title3}

Exclui um conjunto de variáveis.
{#r_CatalogItemVariableSet-deleteRecord_Boolean__table_rzk_z5d_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_CatalogItemVariableSet-deleteRecord_Boolean__ul_nnx_xwn_kpb} |
[Tabela 3. Parâmetros]

{#r_CatalogItemVariableSet-deleteRecord_Boolean__table_rzk_z5d_ns} {#r_CatalogItemVariableSet-deleteRecord_Boolean__table_szk_z5d_ns__entry__2}

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

{#r_CatalogItemVariableSet-deleteRecord_Boolean__table_szk_z5d_ns}  
Este exemplo remove Meu conjunto de variáveis de todos os itens do catálogo que o usam e exclui Meu conjunto de variáveis.

    // Get the sys_id of the variable set you want to delete
    var vSet = new GlideRecord('item_option_new_set');
    vSet.addEncodedQuery('title=My Variable Set'); // find My Variable Set
    vSet.query();
    if (vSet.next()) {

        // first remove the variable set from all catalog items
        var catItemVset = new GlideRecord('io_set_item'); // M2M table linking variable set and catalog item
        catItemVset.addQuery('variable_set', vSet.getUniqueValue); // find all catalog items using My Variable Set
        catItemVset.query();
        while (catItemVset.next()) {
            var vsetM2M = new sn_sc.CatalogItemVariableSetM2M(catItemVset.getUniqueValue()); // io_set_item M2M record sys_id
            vsetM2M.deleteRecord(true); // delete M2M record
        }

        // then delete the variable set record
        var varset = new sn_sc.CatalogItemVariableSet(vSet.getUniqueValue()); 
        varset.deleteRecord(true);
    }

## CatalogItemVariableSet - read (colunas de objeto, Booliano StandardUpdate) {#ariaid-title4}

Retorna um mapeamento de valores de atributo do conjunto de variáveis do item do catálogo.
{#r_CatalogItemVariableSet-read_Object_Boolean__table_k4p_dvd_ns__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| colunas | Objeto | Especifique o conjunto de colunas para o qual 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_CatalogItemVariableSet-read_Object_Boolean__ul_nnx_xwn_kpb} |
[Tabela 5. Parâmetros]

{#r_CatalogItemVariableSet-read_Object_Boolean__table_k4p_dvd_ns} {#r_CatalogItemVariableSet-read_Object_Boolean__table_l4p_dvd_ns__entry__2}

| Tipo | Descrição |
|-|-|
| Objeto | Uma coluna de mapeamento de objeto nomeia para valores. |
[Tabela 6. Retorna]

{#r_CatalogItemVariableSet-read_Object_Boolean__table_l4p_dvd_ns}

## CatalogItemVariableSet - setAttributes(atributos de objeto) {#ariaid-title5}

Define atributos para um conjunto de variáveis.
{#r_CatalogItemVariableSet-setAttributes_Map__table_urd_nvd_ns__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| atributos | Objeto | Uma coluna de mapeamento de objeto nomeia para valores. |
[Tabela 7. Parâmetros]

{#r_CatalogItemVariableSet-setAttributes_Map__table_urd_nvd_ns} {#r_CatalogItemVariableSet-setAttributes_Map__table_vrd_nvd_ns__entry__2}

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

{#r_CatalogItemVariableSet-setAttributes_Map__table_vrd_nvd_ns}  
Este exemplo cria um conjunto de variáveis e adiciona uma variável ao novo conjunto.

    createVariableSet('My Variable Set', 'This is my test variable set', '100', 'one_to_one');

    function createVariableSet(name, description, order, type) {
        var myVarSet = new sn_sc.CatalogItemVariableSet();
        // fields used in object are from table item_option_new_set
        var myVarSetAttrs = {
            "name": name,
            "description": description,
            "order": order,
            "type": type
        }; 
        myVarSet.setAttributes(myVarSetAttrs);
        var myVarSetId = myVarSet.create(true); // returns the sys_id of the created variable set
        gs.info('Variable set created in table item_option_new_set with sys_id ' + myVarSetId);

        // add a variable to the newly created variable set
        var myVar = new sn_sc.CatalogItemVariable();
        var myVarAttrs = {
            "type": "6", // type 6 is single line text
            "variable_set": myVarSetId.toString(), 
            "question_text": "Example question",
            "name": "example_question",
            "order": 200
        };
        myVar.setAttributes(myVarAttrs);
        myVar.create(true);
    }

Saída:

    Variable set created in table item_option_new_set with sys_id e21df65a1bff7c10593876a61a4bcbc4

## CatalogItemVariableSet - update (objeto columnValues, booliano standardUpdate) {#ariaid-title6}

Atualiza um conjunto de variáveis.
{#r_CatalogItemVariableSet-update_Object_Boolean__table_z35_5vd_ns__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| columnValues | Objeto | Uma coluna de mapeamento de objeto nomeia 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_CatalogItemVariableSet-update_Object_Boolean__ul_nnx_xwn_kpb} |
[Tabela 9. Parâmetros]

{#r_CatalogItemVariableSet-update_Object_Boolean__table_z35_5vd_ns} {#r_CatalogItemVariableSet-update_Object_Boolean__table_aj5_5vd_ns__entry__2}

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

{#r_CatalogItemVariableSet-update_Object_Boolean__table_aj5_5vd_ns}  
Este exemplo atualiza a descrição e a ordem do conjunto de variáveis Perguntas padrão de funcionários.

    // Get the sys_id of the variable set you want to update
    var vSet = new GlideRecord('item_option_new_set');
    vSet.addEncodedQuery('title=Standard Employee Questions'); // find the Standard Employee Questions variable set
    vSet.query();
    if (vSet.next()) {
        var varset = new sn_sc.CatalogItemVariableSet(vSet.getUniqueValue()); 
        var attr = {
            'description': 'This should be used for all end user requests such as phones, tablets, etc. \n My description line',
            'order': '500' 
        };
        varset.update(attr, true);
    }