--- 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 --- # CdmQuery - com escopo # CdmQuery - 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) 18 min. de leitura A inclusão de script CdmQuery fornece métodos que permitem consultar a árvore de modelo de dados CDM. Ele retorna uma lista de objetos de nó que são campos/colunas específicos na tabela Nó do CDM \[sn_cdm_node\]. Esses valores são retornados como propriedades no objeto. Cada objeto é um nó no modelo de dados. Esta inclusão de script é fluente, o que significa que a maioria de seus métodos oferece suporte ao encadeamento e retorna um objeto CdmQuery. Os métodos nesta inclusão de script são classificados em tipos diferentes. Você deve especificá-los em uma ordem específica em uma chamada, com base no tipo. Todos os métodos, exceto os métodos de resultado, são encadeados. Nota: Esta documentação cobre somente o uso da inclusão de script CdmQuery na consulta de dados de snapshot, portanto, somente os métodos necessários para este processo estão documentados no momento. A consulta de dados de snapshot é necessária ao gravar scripts de política de PaCE para validação de dados e scripts de exportador CDM para exportação de dados. Tipos de método: * método de entrada: este método especifica o nó de entrada. CdmQuery limita sua consulta ao nó de entrada e seus nós descendentes. É obrigatório especificar o nó de entrada. [CdmQuery - snapshotId(cadeia de caracteres snapshotSysID)](https://servicenow-prod.fluidtopics.net/hXEmFqHw5IxGLHZyKHcRQw#CdmQuery-snapshotId_S "Especifica o nó de entrada. A API CdmQuery limita sua consulta ao nó de entrada e seus nós descendentes. Chamar este método é obrigatório.") * método de consulta: este método executa a consulta especificada.[CdmQuery - consulta ()](https://servicenow-prod.fluidtopics.net/hXEmFqHw5IxGLHZyKHcRQw#CdmQuery-query "Executa a consulta especificada no banco de dados CDM ou no cache com base nas configurações, no nó de entrada e nas configurações de filtro.") * métodos de resultado: esses métodos retornam um conjunto específico de dados de resultados. * [CdmQuery - forEach (função de função)](https://servicenow-prod.fluidtopics.net/hXEmFqHw5IxGLHZyKHcRQw#CdmQuery-forEach_F "Percorre cada um dos nós de resultado e aplica a função fornecida que aceita um objeto CdmNode.") * [CdmQuery - getTree (Booliano simpleTree, Booliano prettify)](https://servicenow-prod.fluidtopics.net/hXEmFqHw5IxGLHZyKHcRQw#CdmQuery-getTree_B_B "Retorna os resultados da consulta CDM especificados.") * [CdmQuery - getValue(String fieldName)](https://servicenow-prod.fluidtopics.net/hXEmFqHw5IxGLHZyKHcRQw#CdmQuery-getValue_S "Retorna o valor do campo especificado do resultado de nó iterado atual.") * [CdmQuery - next()](https://servicenow-prod.fluidtopics.net/hXEmFqHw5IxGLHZyKHcRQw#CmdQuery-next "Itera para o próximo resultado de nó e o retorna se existir.") * métodos de configuração: esses métodos modificam o comportamento de CdmQuery(). * [CdmQuery - decryptPassword (descriptografia booliana)](https://servicenow-prod.fluidtopics.net/hXEmFqHw5IxGLHZyKHcRQw#CdmQuery-decryptPassword_B "Permite que você especifique se os valores descriptografados para o item de dados de configuração criptografado (CDI) e nós de variável são retornados nos resultados.") * [CdmQuery - sigaIncludes (booliano sigaIncludes)](https://servicenow-prod.fluidtopics.net/hXEmFqHw5IxGLHZyKHcRQw#CdmQuery-followIncludes_B "Permite que você especifique se os nós vinculados estão totalmente resolvidos, de modo que os nós descendentes de um nó referenciado apareçam em um nó vinculado.") * [CdmQuery - substituVariable (substituto booliano)](https://servicenow-prod.fluidtopics.net/hXEmFqHw5IxGLHZyKHcRQw#CdmQuery-substituteVariable_B "Permite que você especifique se as referências de variável devem ser substituídas em nós de item de dados de configuração (CDI) pelo valor do nó de variável referenciado.") * [CdmQuery - useCache (booliano useCache)](https://servicenow-prod.fluidtopics.net/hXEmFqHw5IxGLHZyKHcRQw#CmdQuery-useCache_B "Permite que você especifique se os dados devem ser recuperados do cache, se houver, em vez de consultar o banco de dados.") Os métodos snapshotId() e query() são obrigatórios. Você deve adicionar os métodos filter e definindo antes do método query(), mas depois do método snapshotId(). A ordem em que você adiciona filtros e métodos de configuração não é importante, a menos que sejam conflitantes. Nesse caso, o método relevante mais recente prevalece. Você deve adicionar quaisquer métodos de resultado, como getTree() para buscar o resultado, após o método query(). Por exemplo: var primarySnapshot = new sn_cdm.CdmQuery() .snapshotId("1a2fe2e6c3a27010cc0a259d7640dd59") .decryptPassword(true) .includeFileMetadata() .query() .getTree(true, false); Essa API é executada no namespace `sn_cdm` e você deve ter as funções sn_cdm.cdm_viewer ou sn_cdm.cdm_secrets para acessar seus vários métodos. ## CdmQuery - CdmQuery() {#ariaid-title2} Instancia um objeto CdmQuery. Você deve chamar este método antes de chamar qualquer outro método CdmQuery. {#CdmQuery-CdmQuery__table_rtj_44n_vwb__entry__3} | Nome | Tipo | Descrição | |-|-|-| | Nenhum(a) | | | [Tabela 1. Parâmetros] {#CdmQuery-CdmQuery__table_rtj_44n_vwb} Os exemplos de código a seguir mostram como chamar o método CdmQuery para instanciar um objeto CdmQuery no namespace sn_cdm. var primarySnapshot = new sn_cdm.CdmQuery() .snapshotId("1a2fe2e6c3a27010cc0a259d7640dd59") .decryptPassword(true) .query() .getTree(); ## CdmQuery - decryptPassword (descriptografia booliana) {#ariaid-title3} Permite que você especifique se os valores descriptografados para o item de dados de configuração criptografado (CDI) e nós de variável são retornados nos resultados. Um erro será gerado se o usuário não tiver a função sn_cdm.cdm_secrets necessária. {#CdmQuery-decryptPassword_B__table_lwv_kkz_5wb__entry__3} | Nome | Tipo | Descrição | |-|-|-| | decrypt | Booliano | Opcional. Sinalizador que indica se valores descriptografados devem ser retornados para o CDI e os nós de variável. Valores válidos: * verdadeiro: retorna valores descriptografados para o CDI e os nós de variável. * falso: retorna valores criptografados para o CDI e nós de variável. Padrão: falso | [Tabela 2. Parâmetros] {#CdmQuery-decryptPassword_B__table_lwv_kkz_5wb} {#CdmQuery-decryptPassword_B__table_mwv_kkz_5wb__entry__2} | Tipo | Descrição | |-|-| | Nenhum(a) | | [Tabela 3. Retorna] {#CdmQuery-decryptPassword_B__table_mwv_kkz_5wb} O exemplo de código a seguir mostra como chamar a API CdmQuery() e especificar para retornar valores criptografados para o CDI e os nós de variável. var primarySnapshot = new sn_cdm.CdmQuery() .snapshotId("9f12a80047352150fd6ce977746d4364") .decryptPassword(false) .query() .getTree(true,true); gs.info(primarySnapshot); Retornar resultados: { "Development_1": { "vars": {}, "services": { "vars": {}, "paymentComponent": { "applicationSLA": "24x7", "paymentService": { "database": { "backup": { "dbServer": "db23.paymentx.be" }, "dbIpAddress": "10.20.40.50", "dbName": "paymentX_dev2", "dbPort": "8050", "dbServer": "db22.paymentx.be", "dbUserName": "root", "dbPassword": "*******" } } } } } } O exemplo de código a seguir mostra como chamar a API CdmQuery() e especificar para retornar valores descriptografados para o CDI e os nós de variável. var primarySnapshot = new sn_cdm.CdmQuery() .snapshotId("9f12a80047352150fd6ce977746d4364") .decryptPassword(true) .query() .getTree(true,true); gs.info(primarySnapshot); Retornar resultados: { "Development_1": { "vars": {}, "services": { "vars": {}, "paymentComponent": { "applicationSLA": "24x7", "paymentService": { "database": { "backup": { "dbServer": "db23.paymentx.be" }, "dbIpAddress": "10.20.40.50", "dbName": "paymentX_dev2", "dbPort": "8050", "dbServer": "db22.paymentx.be", "dbUserName": "root", "dbPassword": "dev1-password" } } } } } } ## CdmQuery - sigaIncludes (booliano sigaIncludes) {#ariaid-title4} Permite que você especifique se os nós vinculados estão totalmente resolvidos, de modo que os nós descendentes de um nó referenciado apareçam em um nó vinculado. {#CdmQuery-followIncludes_B__table_ebw_4xz_5wb__entry__3} | Nome | Tipo | Descrição | |-|-|-| | seguirInclusões | Booliano | Opcional. Sinalizador que indica se os nós vinculados foram totalmente resolvidos. Valores válidos: * verdadeiro: os nós vinculados foram totalmente resolvidos. * falso: os nós vinculados não foram totalmente resolvidos. Padrão: verdadeiro | [Tabela 4. Parâmetros] {#CdmQuery-followIncludes_B__table_ebw_4xz_5wb} {#CdmQuery-followIncludes_B__table_fbw_4xz_5wb__entry__2} | Tipo | Descrição | |-|-| | Nenhum(a) | | [Tabela 5. Retorna] {#CdmQuery-followIncludes_B__table_fbw_4xz_5wb} O exemplo de código a seguir mostra como retornar dados totalmente resolvidos, followIncludes = verdadeiro. var primarySnapshot = new sn_cdm.CdmQuery() .snapshotId("9f12a80047352150fd6ce977746d4364") .followIncludes(true) .query() .getTree(false, true); Exemplo de dados de retorno: { "sys_id": "62a0a0cc47f12150fd6ce977746d431a", "type": "sn_cdm_node_deployable", "main_id": "111673", "name": "Development_1", "node_path": "!K<+!K<0!K<1", "effective_path": "!K<+!K<0!K<1", "main_id_encoded": "K<1", "node_classifier": "/application/deployables/env:Development", "status": "valid", "level": "2", "children": [ { "sys_id": "2aa0a0cc47f12150fd6ce977746d431a", "type": "sn_cdm_node_folder", "main_id": "111674", "name": "vars", "node_path": "!K<+!K<0!K<1!K<2", "effective_path": "!K<+!K<0!K<1!K<2", "main_id_encoded": "K<2", "node_classifier": "/application/deployables/env:Development/vars", "status": "valid", "level": "3", "children": [], "hasParent": true }, { "sys_id": "2ca1600047352150fd6ce977746d4391", "type": "sn_cdm_node_linked", "main_id": "111693", "name": "services", "node_path": "!K<+!K<0!K<1!K