{"id":31131,"date":"2022-03-23T11:55:36","date_gmt":"2022-03-23T06:25:36","guid":{"rendered":"https:\/\/www.inogic.com\/blog\/?p=31131"},"modified":"2022-03-23T13:22:17","modified_gmt":"2022-03-23T07:52:17","slug":"validate-fetchxml-by-using-validatefetchxmlexpression-webapi-function-in-the-script","status":"publish","type":"post","link":"https:\/\/www.inogic.com\/blog\/2022\/03\/validate-fetchxml-by-using-validatefetchxmlexpression-webapi-function-in-the-script\/","title":{"rendered":"Validate FetchXml by using ValidateFetchXmlExpression WebAPI function in the script"},"content":{"rendered":"

Introduction: <\/strong><\/h1>\n

In a recent project, we retrieved Dynamics 365 CRM data using WebAPI and fetchXml expressions. In most cases, we create fetchXml expressions, where we add attributes and filter conditions dynamically in the fetchXml.\u00a0 When we execute our dynamically created fetchXml expressions, it fails with \u00a0different error messages. Here we had come across a requirement where we needed to validate the fetchXml expressions to get the proper error message before calling the retrieve WebAPI function. We had achieved this by using Dynamics 365 CRM ValidateFetchXmlExpression WebAPI function.<\/p>\n

Please find the ValidateFetchXmlExpression WebAPI function example below, where we have passed fetchXml as input parameter with the wrong attribute name (testfield).<\/p>\n

var fetchXml = '<fetch version=\"1.0\" output-format=\"xml-platform\" mapping=\"logical\" distinct=\"false\">'+\r\n\r\n'<entity name=\"account\">'+\r\n\r\n'<attribute name=\"name\" \/>'+\r\n\r\n'<attribute name=\"testfield\" \/>'+\r\n\r\n'<attribute name=\"primarycontactid\" \/>'+\r\n\r\n'<attribute name=\"accountid\" \/>'+\r\n\r\n'<order attribute=\"name\" descending=\"false\" \/>'+\r\n\r\n'<\/entity>'+\r\n\r\n'<\/fetch>';\r\n\r\n\/\/variable declartion\r\n\r\nvar requestUrl = \"\";\r\n\r\nvar serverUrl = Xrm.Utility.getGlobalContext().getClientUrl();\r\n\r\n\/\/generate Web API request\r\n\r\nrequestUrl += serverUrl + \"\/api\/data\/v9.2\/ValidateFetchXmlExpression(FetchXml=@p1)?@p1='\"+ fetchXml + \"'\";\r\n\r\n\/\/create ajax request\r\n\r\nvar jqxhr = $.ajax({\r\n\r\ntype: \"GET\",\r\n\r\ncontentType: \"application\/json; charset=utf-8\",\r\n\r\ndatatype: \"json\",\r\n\r\nasync: false,\r\n\r\nurl: requestUrl,\r\n\r\nbeforeSend: function (xhr) {\r\n\r\n\/\/Specifying this header ensures that the results will be returned as JSON.\r\n\r\nxhr.setRequestHeader(\"Accept\", \"application\/json\");\r\n\r\nxhr.setRequestHeader(\"Content-Type\", \"application\/json; odata.metadata=minimal\");\r\n\r\nxhr.setRequestHeader(\"OData-MaxVersion\", \"4.0\");\r\n\r\nxhr.setRequestHeader(\"OData-Version\", \"4.0\");\r\n\r\nxhr.setRequestHeader(\"Prefer\", \"odata.include-annotations=*\");\r\n\r\n}\r\n\r\n});\r\n\r\n\/\/check response of request\r\n\r\nif (jqxhr.responseJSON != undefined) {\r\n\r\n\/\/get respose in object format\r\n\r\nvar response = { valid: jqxhr.statusText, data: jqxhr.responseJSON };\r\n\r\n\/\/check for error\r\n\r\nif (jqxhr.responseJSON.error != undefined) {\r\n\r\nalert(jqxhr.responseJSON.error.message);\r\n\r\n} else {\r\n\r\n\/\/get actual result with message\r\n\r\nvar result = response.data;\r\n\r\n}\r\n\r\n}\r\n\r\n<\/pre>\n
Please find the response of WebAPI in the screenshot below:<\/p>\n
\"WebAPI<\/p>\n
Conclusion: <\/strong><\/h2>\n
In this way, with the help of ValidateFetchXmlExpression WebAPI function, we can easily validate fetchXml expressions.<\/p>\n
\"\"<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"
Introduction: In a recent project, we retrieved Dynamics 365 CRM data using WebAPI and fetchXml expressions. In most cases, we create fetchXml expressions, where we add attributes and filter conditions dynamically in the fetchXml.\u00a0 When we execute our dynamically created fetchXml expressions, it fails with \u00a0different error messages. Here we had come across a requirement\u2026 Read More: Validate FetchXml by using ValidateFetchXmlExpression WebAPI function in the script »<\/a><\/span><\/p>\n","protected":false},"author":13,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[2361,65],"tags":[795,2582],"class_list":["post-31131","post","type-post","status-publish","format-standard","hentry","category-technical","category-webapi","tag-fetchxml","tag-webapi-function"],"aioseo_notices":[],"aioseo_head":"\n\t\t\n\t\n\t\n\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t