{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":721,"path":"api-reference/server-api-reference/CdmQueryScopedAPI.md","title":"CdmQuery - Scoped","bundle":null,"doc_type":null,"release":"australia","body":"\n# CdmQuery- Scoped\n\nThe CdmQuery script include provides methods that enable you to query the CDM data model tree. It returns a list of node objects that are specific fields/columns in the CDM Node \\[sn\\_cdm\\_node\\] table. These values are returned as properties in the object. Every object is a node in the data model.\n\nThis script include is fluent which means most of its methods support chaining and return a CdmQuery object. The methods within this script include are classified into different types. You must specify them in a particular order within a call, based on their type. All methods except the result methods are chainable.\n\n**Note:** This documentation only covers the usage of the CdmQuery script include in querying snapshot data, therefore, only methods necessary for this process are currently documented. Querying snapshot data is needed when writing PaCE policy scripts for data validation and CDM exporter scripts for data export.\n\nMethod types:\n\n- entry method: This method specifies the entry node. CdmQuery limits its query to the entry node and its descendant nodes. Specifying the entry node is mandatory.\n\n [CdmQuery - snapshotId\\(String snapshotSysID\\)](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/CdmQueryScopedAPI.md)\n\n- query method: This method executes the specified query.\n\n [CdmQuery - query\\(\\)](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/CdmQueryScopedAPI.md)\n\n- result methods: These methods return a specific set of results data.\n - [CdmQuery - forEach\\(Function function\\)](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/CdmQueryScopedAPI.md)\n - [CdmQuery - getTree\\(Boolean simpleTree, Boolean prettify\\)](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/CdmQueryScopedAPI.md)\n - [CdmQuery - getValue\\(String fieldName\\)](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/CdmQueryScopedAPI.md)\n - [CdmQuery - next\\(\\)](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/CdmQueryScopedAPI.md)\n- setting methods: These methods modify the behavior of CdmQuery\\(\\).\n - [CdmQuery - decryptPassword\\(Boolean decrypt\\)](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/CdmQueryScopedAPI.md)\n - [CdmQuery - followIncludes\\(Boolean followIncludes\\)](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/CdmQueryScopedAPI.md)\n - [CdmQuery - includeFileMetadata\\(\\)](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/CdmQueryScopedAPI.md)\n - [CdmQuery - substituteVariable\\(Boolean substitute\\)](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/CdmQueryScopedAPI.md)\n - [CdmQuery - useCache\\(Boolean useCache\\)](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/CdmQueryScopedAPI.md)\n\nThe snapshotId\\(\\) and query\\(\\) methods are mandatory. You must add filter and setting methods before the query\\(\\) method, but after the snapshotId\\(\\) method. The order in which you add filter and setting methods is not important, unless they are conflicting, in which case the latest relevant method prevails. You must add any result methods, such as getTree\\(\\) to fetch the result, after the query\\(\\) method.\n\nFor example:\n\n```\nvar primarySnapshot = new sn_cdm.CdmQuery()\n .snapshotId(\"1a2fe2e6c3a27010cc0a259d7640dd59\")\n .decryptPassword(true)\n .includeFileMetadata()\n .query()\n .getTree(true, false);\n```\n\nThis API runs in the `sn_cdm` namespace and you must have the sn\\_cdm.cdm\\_viewer or sn\\_cdm.cdm\\_secrets roles to access its various methods.\n\n**Parent Topic:**[Server API reference](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/api-server.md)\n\n## CdmQuery - CdmQuery\\(\\)\n\nInstantiates a CdmQuery object. You must call this method prior to calling any other CdmQuery methods.\n\n|Name|Type|Description|\n|----|----|-----------|\n|None| ||\n\nThe following code examples shows how to call the CdmQuery method to instantiate a CdmQuery object in the sn\\_cdm namespace.\n\n```\nvar primarySnapshot = new sn_cdm.CdmQuery()\n.snapshotId(\"1a2fe2e6c3a27010cc0a259d7640dd59\")\n.decryptPassword(true)\n.query()\n.getTree();\n```\n\n## CdmQuery - decryptPassword\\(Boolean decrypt\\)\n\nEnables you to specify whether decrypted values for encrypted configuration data item \\(CDI\\) and variable nodes are returned in the results.\n\nAn error is thrown if the user does not have the required sn\\_cdm.cdm\\_secrets role.\n\n\n
\n\nName\n\n\n\nType\n\n\n\nDescription\n\n
\n\ndecrypt\n\n\n\nBoolean\n\n\n\nOptional. Flag that indicates whether to return decrypted values for the CDI and variable nodes.Valid values:\n\n- true: Return decrypted values for the CDI and variable nodes.\n- false: Return encrypted values for the CDI and variable nodes.\n\nDefault: false\n\n
|Type|Description|\n|----|-----------|\n|None| |\n\nThe following code example shows how to call the CdmQuery\\(\\) API and specify to return encrypted values for the CDI and variable nodes.\n\n```\nvar primarySnapshot = new sn_cdm.CdmQuery()\n.snapshotId(\"9f12a80047352150fd6ce977746d4364\")\n.decryptPassword(false)\n.query()\n.getTree(true,true);\n\ngs.info(primarySnapshot);\n```\n\nReturn results:\n\n```\n{\n \"Development_1\": {\n \"vars\": {},\n \"services\": {\n \"vars\": {},\n \"paymentComponent\": {\n \"applicationSLA\": \"24x7\",\n \"paymentService\": {\n \"database\": {\n \"backup\": {\n \"dbServer\": \"db23.paymentx.be\"\n },\n \"dbIpAddress\": \"10.20.40.50\",\n \"dbName\": \"paymentX_dev2\",\n \"dbPort\": \"8050\",\n \"dbServer\": \"db22.paymentx.be\",\n \"dbUserName\": \"root\",\n \"dbPassword\": \"*******\"\n }\n }\n }\n }\n }\n}\n```\n\nThe following code example shows how to call the CdmQuery\\(\\) API and specify to return decrypted values for the CDI and variable nodes.\n\n```\nvar primarySnapshot = new sn_cdm.CdmQuery()\n.snapshotId(\"9f12a80047352150fd6ce977746d4364\")\n.decryptPassword(true)\n.query()\n.getTree(true,true);\n\ngs.info(primarySnapshot);\n```\n\nReturn results:\n\n```\n{\n \"Development_1\": {\n \"vars\": {},\n \"services\": {\n \"vars\": {},\n \"paymentComponent\": {\n \"applicationSLA\": \"24x7\",\n \"paymentService\": {\n \"database\": {\n \"backup\": {\n \"dbServer\": \"db23.paymentx.be\"\n },\n \"dbIpAddress\": \"10.20.40.50\",\n \"dbName\": \"paymentX_dev2\",\n \"dbPort\": \"8050\",\n \"dbServer\": \"db22.paymentx.be\",\n \"dbUserName\": \"root\",\n \"dbPassword\": \"dev1-password\"\n }\n }\n }\n }\n }\n}\n```\n\n## CdmQuery - followIncludes\\(Boolean followIncludes\\)\n\nEnables you to specify whether linked nodes are fully resolved, such that descendant nodes of a referenced node appear under a linked node.\n\n\n
\n\nName\n\n\n\nType\n\n\n\nDescription\n\n
\n\nfollowIncludes\n\n\n\nBoolean\n\n\n\nOptional. Flag that indicates whether linked nodes are fully resolved.Valid values:\n\n- true: Linked nodes are fully resolved.\n- false: Linked nodes are not fully resolved.\n\nDefault: true\n\n
|Type|Description|\n|----|-----------|\n|None| |\n\nThe following code example shows how to return data that is fully resolved, **followIncludes** = true.\n\n```\nvar primarySnapshot = new sn_cdm.CdmQuery()\n .snapshotId(\"9f12a80047352150fd6ce977746d4364\")\n .followIncludes(true)\n .query()\n .getTree(false, true);\n```\n\nExample return data:\n\n```\n{\n \"sys_id\": \"62a0a0cc47f12150fd6ce977746d431a\",\n \"type\": \"sn_cdm_node_deployable\",\n \"main_id\": \"111673\",\n \"name\": \"Development_1\",\n \"node_path\": \"!K<+!K<0!K<1\",\n \"effective_path\": \"!K<+!K<0!K<1\",\n \"main_id_encoded\": \"K<1\",\n \"node_classifier\": \"/application/deployables/env:Development\",\n \"status\": \"valid\",\n \"level\": \"2\",\n \"children\": [\n {\n \"sys_id\": \"2aa0a0cc47f12150fd6ce977746d431a\",\n \"type\": \"sn_cdm_node_folder\",\n \"main_id\": \"111674\",\n \"name\": \"vars\",\n \"node_path\": \"!K<+!K<0!K<1!K<2\",\n \"effective_path\": \"!K<+!K<0!K<1!K<2\",\n \"main_id_encoded\": \"K<2\",\n \"node_classifier\": \"/application/deployables/env:Development/vars\",\n \"status\": \"valid\",\n \"level\": \"3\",\n \"children\": [],\n \"hasParent\": true\n },\n {\n \"sys_id\": \"2ca1600047352150fd6ce977746d4391\",\n \"type\": \"sn_cdm_node_linked\",\n \"main_id\": \"111693\",\n \"name\": \"services\",\n \"node_path\": \"!K<+!K<0!K<1!K\n\nName\n\n\n\nType\n\n\n\nDescription\n\n\n\nsimpleTree\n\n\n\nBoolean\n\n\n\nOptional. Flag that indicates the level of content to return.Valid values:\n\n- true: Returns a simplified JSON object of hierarchical key-values pairs, excluding all node metadata.\n- false: Returns a JSON object containing the node metadata and all its child nodes, and specifies where the entry node is the top node.\n\nDefault: false\n\n\n\nprettify\n\n\n\nBoolean\n\n\n\nOptional. Flag that indicates whether to return a formatted string instead of a JSON object.Valid values:\n\n- true: Return the content in a JSON object.\n- false: Return the content as a formatted string. Only use this option in UI and exporters as it adds new line and escape characters to the response.\n\nDefault: false\n\n\n|Type|Description|\n|----|-----------|\n|CdmQuery|CdmQuery object containing the specified query information.|\n\nThe following code example shows how to call the getTree\\(\\) method using the default settings. This returns a formatted string containing the node metadata and all its child nodes.\n\n```\nvar primarySnapshot = new sn_cdm.CdmQuery()\n .snapshotId(\"9f12a80047352150fd6ce977746d4364\")\n .query()\n .getTree();\n\ngs.info(JSON.stringify(primarySnapshot));\n```\n\nReturn results:\n\n```\n{\"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\n\nType\n\n\n\nDescription\n\n\n\nCdmQuery\n\n\n\nIf available, the CdmQuery object of the next node.If no additional nodes are available it returns a null or undefined.\n\n\nThe following code example shows how the next\\(\\) method to iterate through the available node.\n\n```\nvar cdmQuery = new sn_cdm.CdmQuery()\n .snapshotId(\"1a2fe2e6c3a27010cc0a259d7640dd59\")\n .decryptPassword(true)\n .query(); \n\nvar output = [];\nwhile(cdmQuery.next()) {\n var name = cdmQuery.getValue('name');\n var type = cdmQuery.getValue('type');\n if (type == 'sg_cdm_node_cdi' || type == 'sg_cdm_node_variable') {\n var value = cdmQuery.getValue('value');\n output.push(gs.getMessage(\"{0} : {1} [{2}]\", [name, value, type]));\n } else {\n output.push(gs.getMessage(\"{0} [{1}]\", [name, type]));\n }\t \n} \n```\n\nReturn results:\n\n```\n[\n \"test_login_service [sg_cdm_node_deployable]\",\n \"vars [sg_cdm_node_folder]\",\n \"service_password : service12345 [sg_cdm_node_variable]\",\n \"login_service [sg_cdm_node_linked]\",\n \"vars [sg_cdm_node_folder]\",\n \"core_component [sg_cdm_node_component]\",\n \"user_name : username [sg_cdm_node_cdi]\",\n \"user_password : service12345 [sg_cdm_node_cdi]\" \n]\n```\n\n## CdmQuery - query\\(\\)\n\nExecutes the specified query against the CDM database or the cache based on the settings, entry node, and filter settings.\n\n|Name|Type|Description|\n|----|----|-----------|\n|None| | |\n\n|Type|Description|\n|----|-----------|\n|CdmQuery|CdmQuery object.|\n\nThe following code example shows how to call the CdmQuery\\(\\) API and specify the deployable snapshot to query.\n\n```\nvar primarySnapshot = new sn_cdm.CdmQuery()\n.snapshotId(\"1a2fe2e6c3a27010cc0a259d7640dd59\")\n.decryptPassword(true)\n.query()\n.getTree();\n```\n\nReturn results:\n\n```\n{ \n \"_decryptPassword\": true,\n \"sys_id\": \"d73d6666c3a27010cc0a259d7640dde7\",\n \"type\": \"sg_cdm_node_deployable\",\n \"main_id\": \"731\",\n \"name\": \"test_login_service\",\n \"node_path\": \"!1+!1/!10\",\n \"effective_path\": \"!1+!1/!10\",\n \"main_id_encoded\": \"10\",\n \"node_classifier\": \"/application/deployables/dep:test_login_service\", \n \"status\": \"valid\", \n \"children\": [\n {\n \"_decryptPassword\": true,\n \"sys_id\": \"9f3d6666c3a27010cc0a259d7640dde7\",\n \"type\": \"sg_cdm_node_folder\",\n \"main_id\": \"732\",\n \"name\": \"vars\",\n \"node_path\": \"!1+!1/!10!11\",\n \"effective_path\": \"!1+!1/!10!11\",\n \"main_id_encoded\": \"11\",\n \"node_classifier\": \"/application/deployables/dep:test_login_service/vars\",\n \"status\": \"valid\",\n \"children\": [\n {\n \"_decryptPassword\": true,\n \"sys_id\": \"49dd2e66c3a27010cc0a259d7640ddf9\",\n \"type\": \"sg_cdm_node_variable\", \n \"main_id\": \"741\",\n \"name\": \"service_password\",\n \"node_path\": \"!1+!1/!10!11!1:\",\n \"value\": \"service12345\",\n \"effective_path\": \"!1+!1/!10!11!1:\",\n \"main_id_encoded\": \"1:\",\n \"node_classifier\": \"/application/deployables/dep:test_login_service/vars\",\n \"status\": \"valid\",\n \"children\": [],\n \"hasParent\": true \n }\n ], \n \"hasParent\": true \n }, \n {\n \"_decryptPassword\": true,\n \"sys_id\": \"26bd2e66c3a27010cc0a259d7640dd74\",\n \"type\": \"sg_cdm_node_linked\",\n \"main_id\": \"740\",\n \"name\": \"login_service\",\n \"node_path\": \"!1+!1/!10!19\",\n \"effective_path\": \"!1+!1/!10!19\",\n \"main_id_encoded\": \"19\",\n \"node_classifier\": \"/application/deployables/dep:test_login_service\",\n \"status\": \"valid\",\n \"children\": [\n {\n \"_decryptPassword\": true,\n \"sys_id\": \"eeadea66c3a27010cc0a259d7640dd8c\",\n \"type\": \"sg_cdm_node_folder\",\n \"main_id\": \"738\",\n \"name\": \"vars\",\n \"node_path\": \"!1+!1.!16!17\",\n \"effective_path\": \"!1+!1/!10!19!17\",\n \"main_id_encoded\": \"17\",\n \"node_classifier\": \"/application/collections/vars\",\n \"status\": \"valid\",\n \"children\": [],\n \"hasParent\": true \n },\n { \n \"_decryptPassword\": true,\n \"sys_id\": \"da1f22e6c3a27010cc0a259d7640dda2\",\n \"type\": \"sg_cdm_node_component\",\n \"main_id\": \"742\",\n \"name\": \"core_component\",\n \"node_path\": \"!1+!1/!10!19!1;\",\n \"effective_path\": \"!1+!1/!10!19!1;\",\n \"main_id_encoded\": \"1;\",\n \"node_classifier\": \"/application/deployables/dep:test_login_service\",\n \"status\": \"valid\",\n \"children\": [\n { \n \"_decryptPassword\": true,\n \"sys_id\": \"921f22e6c3a27010cc0a259d7640dda3\",\n \"type\": \"sg_cdm_node_cdi\",\n \"main_id\": \"743\",\n \"name\": \"user_name\",\n \"node_path\": \"!1+!1/!10!19!1;!1<\",\n \"value\": \"admin\",\n \"effective_path\": \"!1+!1/!10!19!1;!1<\",\n \"main_id_encoded\": \"1<\",\n \"node_classifier\": \"/application/deployables/dep:test_login_service\",\n \"status\": \"valid\",\n \"children\": [],\n \"hasParent\": true\n },\n { \n \"_decryptPassword\": true,\n \"sys_id\": \"5a1f22e6c3a27010cc0a259d7640dda3\",\n \"type\": \"sg_cdm_node_cdi\",\n \"main_id\": \"744\",\n \"name\": \"user_password\",\n \"node_path\": \"!1+!1/!10!19!1;!1?\",\n \"value\": \"service12345\",\n \"effective_path\": \"!1+!1/!10!19!1;!1?\",\n \"main_id_encoded\": \"1?\",\n \"node_classifier\": \"/application/deployables/dep:test_login_service\",\n \"status\": \"valid\",\n \"children\": [],\n \"hasParent\": true\n }\n ],\n \"hasParent\": true\n }\n ],\n \"hasParent\": true\n }\n ],\n \"hasParent\": false\n}\n```\n\n## CdmQuery - snapshotId\\(String snapshotSysID\\)\n\nSpecifies the entry node. The CdmQuery API limits its query to the entry node and its descendant nodes. Calling this method is mandatory.\n\n\n
\n\nName\n\n\n\nType\n\n\n\nDescription\n\n
\n\nsnapshotSysId\n\n\n\nString\n\n\n\nSys\\_id of the deployable snapshot to query.Internally it sets the sys\\_id of the changeset and the sys\\_id of the deployable node.\n\nTable: CDM Snapshot \\[sn\\_cdm\\_snapshot\\]\n\n
|Type|Description|\n|----|-----------|\n|None| |\n\nThe following code example shows how to call the CdmQuery\\(\\) API and specify the deployable snapshot to query.\n\n```\nvar primarySnapshot = new sn_cdm.CdmQuery()\n.snapshotId(\"1a2fe2e6c3a27010cc0a259d7640dd59\")\n.decryptPassword(true)\n.query()\n.getTree();\n```\n\nReturn results:\n\n```\n{ \n \"_decryptPassword\": true,\n \"sys_id\": \"d73d6666c3a27010cc0a259d7640dde7\",\n \"type\": \"sg_cdm_node_deployable\",\n \"main_id\": \"731\",\n \"name\": \"test_login_service\",\n \"node_path\": \"!1+!1/!10\",\n \"effective_path\": \"!1+!1/!10\",\n \"main_id_encoded\": \"10\",\n \"node_classifier\": \"/application/deployables/dep:test_login_service\", \n \"status\": \"valid\", \n \"children\": [\n {\n \"_decryptPassword\": true,\n \"sys_id\": \"9f3d6666c3a27010cc0a259d7640dde7\",\n \"type\": \"sg_cdm_node_folder\",\n \"main_id\": \"732\",\n \"name\": \"vars\",\n \"node_path\": \"!1+!1/!10!11\",\n \"effective_path\": \"!1+!1/!10!11\",\n \"main_id_encoded\": \"11\",\n \"node_classifier\": \"/application/deployables/dep:test_login_service/vars\",\n \"status\": \"valid\",\n \"children\": [\n {\n \"_decryptPassword\": true,\n \"sys_id\": \"49dd2e66c3a27010cc0a259d7640ddf9\",\n \"type\": \"sg_cdm_node_variable\", \n \"main_id\": \"741\",\n \"name\": \"service_password\",\n \"node_path\": \"!1+!1/!10!11!1:\",\n \"value\": \"service12345\",\n \"effective_path\": \"!1+!1/!10!11!1:\",\n \"main_id_encoded\": \"1:\",\n \"node_classifier\": \"/application/deployables/dep:test_login_service/vars\",\n \"status\": \"valid\",\n \"children\": [],\n \"hasParent\": true \n }\n ], \n \"hasParent\": true \n }, \n {\n \"_decryptPassword\": true,\n \"sys_id\": \"26bd2e66c3a27010cc0a259d7640dd74\",\n \"type\": \"sg_cdm_node_linked\",\n \"main_id\": \"740\",\n \"name\": \"login_service\",\n \"node_path\": \"!1+!1/!10!19\",\n \"effective_path\": \"!1+!1/!10!19\",\n \"main_id_encoded\": \"19\",\n \"node_classifier\": \"/application/deployables/dep:test_login_service\",\n \"status\": \"valid\",\n \"children\": [\n {\n \"_decryptPassword\": true,\n \"sys_id\": \"eeadea66c3a27010cc0a259d7640dd8c\",\n \"type\": \"sg_cdm_node_folder\",\n \"main_id\": \"738\",\n \"name\": \"vars\",\n \"node_path\": \"!1+!1.!16!17\",\n \"effective_path\": \"!1+!1/!10!19!17\",\n \"main_id_encoded\": \"17\",\n \"node_classifier\": \"/application/collections/vars\",\n \"status\": \"valid\",\n \"children\": [],\n \"hasParent\": true \n },\n { \n \"_decryptPassword\": true,\n \"sys_id\": \"da1f22e6c3a27010cc0a259d7640dda2\",\n \"type\": \"sg_cdm_node_component\",\n \"main_id\": \"742\",\n \"name\": \"core_component\",\n \"node_path\": \"!1+!1/!10!19!1;\",\n \"effective_path\": \"!1+!1/!10!19!1;\",\n \"main_id_encoded\": \"1;\",\n \"node_classifier\": \"/application/deployables/dep:test_login_service\",\n \"status\": \"valid\",\n \"children\": [\n { \n \"_decryptPassword\": true,\n \"sys_id\": \"921f22e6c3a27010cc0a259d7640dda3\",\n \"type\": \"sg_cdm_node_cdi\",\n \"main_id\": \"743\",\n \"name\": \"user_name\",\n \"node_path\": \"!1+!1/!10!19!1;!1<\",\n \"value\": \"admin\",\n \"effective_path\": \"!1+!1/!10!19!1;!1<\",\n \"main_id_encoded\": \"1<\",\n \"node_classifier\": \"/application/deployables/dep:test_login_service\",\n \"status\": \"valid\",\n \"children\": [],\n \"hasParent\": true\n },\n { \n \"_decryptPassword\": true,\n \"sys_id\": \"5a1f22e6c3a27010cc0a259d7640dda3\",\n \"type\": \"sg_cdm_node_cdi\",\n \"main_id\": \"744\",\n \"name\": \"user_password\",\n \"node_path\": \"!1+!1/!10!19!1;!1?\",\n \"value\": \"service12345\",\n \"effective_path\": \"!1+!1/!10!19!1;!1?\",\n \"main_id_encoded\": \"1?\",\n \"node_classifier\": \"/application/deployables/dep:test_login_service\",\n \"status\": \"valid\",\n \"children\": [],\n \"hasParent\": true\n }\n ],\n \"hasParent\": true\n }\n ],\n \"hasParent\": true\n }\n ],\n \"hasParent\": false\n}\n```\n\n## CdmQuery - substituteVariable\\(Boolean substitute\\)\n\nEnables you to specify whether to substitute variable references in configuration data item \\(CDI\\) nodes with the value of the referenced variable node.\n\n\n
\n\nName\n\n\n\nType\n\n\n\nDescription\n\n
\n\nsubstitute\n\n\n\nBoolean\n\n\n\nOptional. Flag that indicates whether to substitute variable references in CDI nodes with the value of the referenced variable node.Valid values:\n\n- true: Substitute variable references in CDI nodes with the value of the referenced variable node.\n- false: Do not substitute variable references in CDI nodes with the value of the referenced variable node.\n\nDefault: true\n\n
|Type|Description|\n|----|-----------|\n|None| |\n\nThe following code examples shows how to turn off substitution of variable references in CDI nodes.\n\n```\nvar primarySnapshot = new sn_cdm.CdmQuery()\n.snapshotId(\"20c365a2476c6110fd6ce977746d4336\")\n.substituteVariable(false)\n.query()\n.getTree(true, true);\n\ngs.info(primarySnapshot);\n```\n\nExample return results:\n\n```\n{\n \"paymentService-V1.1\": {\n \"featureToggles\": {\n \"paymentRefund\": \"enabled\",\n \"myPreferredPaymentMethods\": \"enabled\",\n \"invoicePrinting\": \"enabled\",\n \"payOnDelivery\": \"disabled\",\n \"payByVoucher\": \"enabled\"\n },\n \"vars\": {\n \"paymentService\": {\n \"database\": {\n \"dbName\": \"paymentX_dev2\",\n \"dbUserName\": \"root\",\n \"dbPassword\": \"admin123\",\n \"dbServer\": \"db22.paymentx.be\",\n \"dbPort\": \"8050\",\n \"dbIpAddress\": \"10.20.40.50\",\n \"backup\": {\n \"dbServer\": \"db23.paymentx.be\"\n }\n }\n },\n \"applicationSLA\": \"24x7\"\n },\n \"settings\": {\n \"merchantId\": \"10334\",\n \"paymentMethods\": \"1,3,5,6\",\n \"allowed.billing.countries\": \"74,76,88,136,139,176,197\",\n \"creditcards.cacf.type.ids\": \"43,44,45,46,48,49,50\",\n \"creditcards.oney.type.ids\": \"33,34,35\",\n \"included.availabilityids\": \"999\",\n \"included.warrantiestypeids.cacf\": \"19002,19005,19006,19009,19010,19011,19014,19016\",\n \"dbIPAddress\": \"@@paymentService/database/dbIpAddress@@\",\n \"dbPort\": \"@@paymentService/database/dbPort@@\",\n \"dbConnectionString\": \"@@paymentService/database/dbUserName@@:@@paymentService/database/dbPassword@@ @@paymentService/database/dbServer@@:@@paymentService/database/dbPort@@ @@paymentService/database/dbName@@\",\n \"dbConnectionStringBackup\": \"@@paymentService/database/dbUserName@@:@@paymentService/database/dbPassword@@ @@paymentService/database/backup/dbServer@@ @@paymentService/database/dbName@@\",\n \"paypal\": \"enabled\",\n \"applePay\": \"disabled\",\n \"ogone\": \"enabled\"\n }\n }\n}\n```\n\nThe following code examples shows how to turn on substitution of variable references in CDI nodes and the associated return results for the same record.\n\n```\nvar primarySnapshot = new sn_cdm.CdmQuery()\n.snapshotId(\"20c365a2476c6110fd6ce977746d4336\")\n.substituteVariable(true)\n.query()\n.getTree(false, true);\n\ngs.info(primarySnapshot);\n```\n\nExample return results:\n\n```\n{\n \"paymentService-V1.1\": {\n \"featureToggles\": {\n \"paymentRefund\": \"enabled\",\n \"myPreferredPaymentMethods\": \"enabled\",\n \"invoicePrinting\": \"enabled\",\n \"payOnDelivery\": \"disabled\",\n \"payByVoucher\": \"enabled\"\n },\n \"vars\": {\n \"paymentService\": {\n \"database\": {\n \"dbName\": \"paymentX_dev2\",\n \"dbUserName\": \"root\",\n \"dbPassword\": \"admin123\",\n \"dbServer\": \"db22.paymentx.be\",\n \"dbPort\": \"8050\",\n \"dbIpAddress\": \"10.20.40.50\",\n \"backup\": {\n \"dbServer\": \"db23.paymentx.be\"\n }\n }\n },\n \"applicationSLA\": \"24x7\"\n },\n \"settings\": {\n \"merchantId\": \"10334\",\n \"paymentMethods\": \"1,3,5,6\",\n \"allowed.billing.countries\": \"74,76,88,136,139,176,197\",\n \"creditcards.cacf.type.ids\": \"43,44,45,46,48,49,50\",\n \"creditcards.oney.type.ids\": \"33,34,35\",\n \"included.availabilityids\": \"999\",\n \"included.warrantiestypeids.cacf\": \"19002,19005,19006,19009,19010,19011,19014,19016\",\n \"dbIPAddress\": \"10.20.40.50\",\n \"dbPort\": \"8050\",\n \"dbConnectionString\": \"root:admin123 db22.paymentx.be:8050 paymentX_dev2\",\n \"dbConnectionStringBackup\": \"root:admin123 db23.paymentx.be paymentX_dev2\",\n \"paypal\": \"enabled\",\n \"applePay\": \"disabled\",\n \"ogone\": \"enabled\"\n }\n }\n}\n```\n\n## CdmQuery - useCache\\(Boolean useCache\\)\n\nEnables you to specify whether to retrieve data from the cache, if any, instead of querying the database.\n\n\n
\n\nName\n\n\n\nType\n\n\n\nDescription\n\n
\n\nuseCache\n\n\n\nBoolean\n\n\n\nOptional. Flag that indicates whether to retrieve data from the cache, if any, instead of querying the database.Valid values:\n\n- true: Retrieve data from the cache.\n- false: Query the database to retrieve the data.\n\nDefault: true\n\n
|Type|Description|\n|----|-----------|\n|None| |\n\nThe following code examples shows how to turn off using the cache to obtain data.\n\n```\nvar cdmQuery = new sn_cdm.CdmQuery()\n .snapshotId(\"1a2fe2e6c3a27010cc0a259d7640dd59\")\n .decryptPassword(true)\n .useCache(false)\n .query();\n```\n\n"}}