{"id":1542172,"date":"2022-04-07T13:41:29","date_gmt":"2022-04-07T20:41:29","guid":{"rendered":"https:\/\/www.esri.com\/arcgis-blog\/?post_type=blog&p=1542172"},"modified":"2022-04-19T11:25:47","modified_gmt":"2022-04-19T18:25:47","slug":"rest-is-up-to-the-task","status":"publish","type":"blog","link":"https:\/\/www.esri.com\/arcgis-blog\/products\/js-api-arcgis\/developers\/rest-is-up-to-the-task","title":{"rendered":"Rest is up to the task"},"author":7451,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"open","ping_status":"closed","template":"","format":"standard","meta":{"_acf_changed":false,"_searchwp_excluded":""},"categories":[738191],"tags":[764672,96582,27491,34741,29571],"industry":[],"product":[36831,36601],"class_list":["post-1542172","blog","type-blog","status-publish","format-standard","hentry","category-developers","tag-amd","tag-arcgis-api-for-javascript","tag-jsapi4","tag-rest","tag-tasks","product-js-api-arcgis","product-developers"],"acf":{"short_description":"Tasks have been deprecated since 4.20. They will be removed at 4.24.","flexible_content":[{"acf_fc_layout":"content","content":"

At version 4.20 of the ArcGIS API for JavaScript, we deprecated Tasks<\/a> in favor of using more modular classes and objects found inside the esri\/rest<\/code> folder. At version<\/strong> 4.24<\/strong> (summer release) of the ArcGIS API for JavaScript, we will be removing<\/strong> support for Tasks.<\/p>\n"},{"acf_fc_layout":"image","image":{"ID":1544332,"id":1544332,"title":"\"esri\/rest\" folder","filename":"all-REST-toc.png","filesize":1093477,"url":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2022\/04\/all-REST-toc.png","link":"https:\/\/www.esri.com\/arcgis-blog\/products\/js-api-arcgis\/developers\/rest-is-up-to-the-task\/all-rest-toc","alt":"\"esri\/rest\" folder","author":"7451","description":"\"esri\/rest\" folder","caption":"\"esri\/rest\" folder","name":"all-rest-toc","status":"inherit","uploaded_to":1542172,"date":"2022-04-06 21:03:00","modified":"2022-04-06 21:03:40","menu_order":0,"mime_type":"image\/png","type":"image","subtype":"png","icon":"https:\/\/www.esri.com\/arcgis-blog\/wp-includes\/images\/media\/default.png","width":3226,"height":1810,"sizes":{"thumbnail":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2022\/04\/all-REST-toc-213x200.png","thumbnail-width":213,"thumbnail-height":200,"medium":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2022\/04\/all-REST-toc.png","medium-width":464,"medium-height":261,"medium_large":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2022\/04\/all-REST-toc.png","medium_large-width":768,"medium_large-height":431,"large":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2022\/04\/all-REST-toc.png","large-width":1920,"large-height":1077,"1536x1536":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2022\/04\/all-REST-toc-1536x862.png","1536x1536-width":1536,"1536x1536-height":862,"2048x2048":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2022\/04\/all-REST-toc-2048x1149.png","2048x2048-width":2048,"2048x2048-height":1149,"card_image":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2022\/04\/all-REST-toc-826x463.png","card_image-width":826,"card_image-height":463,"wide_image":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2022\/04\/all-REST-toc-1920x1077.png","wide_image-width":1920,"wide_image-height":1077}},"image_position":"center","orientation":"horizontal","hyperlink":"https:\/\/developers.arcgis.com\/javascript\/latest\/api-reference\/esri-rest-closestFacility.html"},{"acf_fc_layout":"content","content":"

These changes are already available for our users to test using next<\/code> via CDN and NPM: https:\/\/github.com\/Esri\/feedback-js-api-next<\/a><\/p>\n

Why did we do this? This will make it easier to incorporate your code into a more modular app design, and also reduce unnecessary dependencies (you only import what you want). The new rest modules are functions, which do not require constructors, so you can use their methods immediately.<\/p>\n

Also, because of the more modular design, you can import just one or more methods of a rest module, instead of having to import the whole module. There is one caveat to that statement though, and we’ll discuss that after we see some code examples.<\/p>\n"},{"acf_fc_layout":"content","content":"

Now, let’s look at a couple of examples. First, this is how we used to handle querying using Tasks:<\/p>\n

\/\/ example of using deprecated QueryTask<\/span>\r\nrequire<\/span>([\r\n  \"esri\/tasks\/QueryTask\"<\/span>, \"esri\/tasks\/support\/Query\"<\/span>, ...\r\n], function<\/span>(QueryTask, Query, ...){\r\n\r\n  \/\/ URL to the layer of interest to query<\/span>\r\n  let<\/span> queryUrl = \"https:\/\/sampleserver6.arcgisonline.com\/arcgis\/rest\/services\/Census\/MapServer\/3\"<\/span>;\r\n\r\n  \/\/ create a new QueryTask with URL from above<\/span>\r\n  let<\/span> queryTask = new<\/span> QueryTask({\r\n    url: queryUrl\r\n  });\r\n\r\n  \/\/ create the Query object<\/span>\r\n  let<\/span> queryObject = new<\/span> Query();\r\n  queryObject.where = \"STATE_NAME = 'Washington'\"<\/span>;\r\n  queryObject.outSpatialReference = { wkid:4269<\/span> };\r\n  queryObject.returnGeometry = true<\/span>;\r\n  queryObject.outFields = [ \"HOUSEHOLDS\"<\/span> ];\r\n\r\n  \/\/ when resolved, returns features and graphics that satisfy the query<\/span>\r\n  queryTask.execute(queryObject).then(function<\/span>(results){\r\n    console<\/span>.log(results.features);\r\n  });\r\n});\r\n<\/code><\/pre>\n"},{"acf_fc_layout":"content","content":"
\/\/ same example, but using \"esri\/rest\/query\"<\/span>\r\nrequire<\/span>([\r\n  \"esri\/rest\/query\"<\/span>, \"esri\/rest\/support\/Query\"<\/span>, ...\r\n], function<\/span>(query, Query, ... ) {\r\n\r\n  \/\/ URL to the layer of interest to query<\/span>\r\n  let<\/span> queryUrl = \"https:\/\/sampleserver6.arcgisonline.com\/arcgis\/rest\/services\/Census\/MapServer\/3\"<\/span>;\r\n\r\n  \/\/ create the Query object<\/span>\r\n  let<\/span> queryObject = new<\/span> Query();\r\n  queryObject.where = \"STATE_NAME = 'Washington'\"<\/span>;\r\n  queryObject.outSpatialReference = { wkid:4269<\/span> };\r\n  queryObject.returnGeometry = true<\/span>;\r\n  queryObject.outFields = [ \"HOUSEHOLDS\"<\/span> ];\r\n\r\n  \/\/ when resolved, returns features and graphics that satisfy the query<\/span>\r\n  query.executeQueryJSON(queryUrl, queryObject).then(function<\/span>(results){\r\n    console<\/span>.log(results.features);\r\n  });\r\n});\r\n<\/code><\/pre>\n"},{"acf_fc_layout":"content","content":"
And here we have the same example as above, but we can also use @arcgis\/core<\/a> ES modules to import @arcgis\/core\/rest\/query\/executeQueryJSON<\/code> so we don’t have to waste resources with loading the rest of the esri\/rest\/query<\/code> methods:<\/p>\n
\/\/ same example, but only load the query method of interest with ES Modules<\/span>\r\nimport<\/span> { executeQueryJSON } from<\/span> \"@arcgis\/core\/rest\/query\"<\/span>;\r\nimport<\/span> Query from<\/span> \"@arcgis\/core\/rest\/support\/Query\"<\/span>;\r\n\r\n\/\/ URL to the layer of interest to query<\/span>\r\nlet<\/span> queryUrl =\r\n  \"https:\/\/sampleserver6.arcgisonline.com\/arcgis\/rest\/services\/Census\/MapServer\/3\"<\/span>;\r\n\r\n\/\/ create the Query object<\/span>\r\nlet<\/span> queryObject = new<\/span> Query({\r\n    where: \"STATE_NAME = 'Washington'\"<\/span>,\r\n    outSpatialReference: { wkid: 4269<\/span> },\r\n    returnGeometry: true<\/span>,\r\n    outFields: [\"HOUSEHOLDS\"<\/span>]\r\n});\r\n\r\n\/\/ when resolved, returns features and graphics that satisfy the query<\/span>\r\nexecuteQueryJSON(queryUrl, queryObject).then((results) => {\r\n  console<\/span>.log(results.features);\r\n});\r\n\r\n<\/code><\/pre>\n"},{"acf_fc_layout":"content","content":"
It should also be noted, that rather than using the query modules directly, you should probably be using the query methods on the Layer<\/a>. This would include methods like queryFeatures<\/a>, queryRelatedFeatures<\/a>, and more. These query methods will take into account the capabilities of the backing service so you don’t have to.<\/p>\n
One last thing to note about this change is that we also deprecated the Portal helper methods<\/a> at version 4.21, and are removing<\/strong> these five Task-based functions at 4.24<\/strong> as well:<\/p>\n
Notice that the code also looks super similar? The main difference is that when tree-shaking<\/a> is enabled in your build tools, the app avoids loading the other 6 querying methods, which reduces load time and the resources consumed.<\/p>\n
Notice that the code looks super similar? In this case (and in almost every case, actually) migrating from Tasks to rest is simple and straightforward and, thankfully, well documented. Here, we had to rename the modules in the require<\/code> statement, and move the URL from the QueryTask constructor into the\u00a0executeQueryJSON()<\/a> method parameter.<\/p>\n
This is the same example as above, but using esri\/rest\/query<\/code><\/a>:<\/p>\n