Merge pull request #2136 from Esri/NA/guides_16

Update OGC Sample

Author: jyaistMap

samples/05_content_publishers/publish_ogc_services.ipynb

@@ -32,65 +32,12 @@
    "outputs": [],
    "source": [
     "from arcgis.gis import GIS\n",
-    "from arcgis.mapping.ogc import WMTSLayer, WMSLayer, OGCFeatureService\n",
-    "from arcgis.mapping import WebMap\n",
+    "from arcgis.mapping.layers import WMTSLayer, WMSLayer\n",
+    "from arcgis.map import Map\n",
     "\n",
     "gis = GIS(\"home\")"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "We can take a look at how many service types are supported by the `ogc` module in the Python API."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "['CSVLayer',\n",
-       " 'GeoJSONLayer',\n",
-       " 'GeoRSSLayer',\n",
-       " 'KMLLayer',\n",
-       " 'OGCCollection',\n",
-       " 'OGCFeatureService',\n",
-       " 'WMSLayer',\n",
-       " 'WMTSLayer',\n",
-       " '__all__',\n",
-       " '__builtins__',\n",
-       " '__cached__',\n",
-       " '__doc__',\n",
-       " '__file__',\n",
-       " '__loader__',\n",
-       " '__name__',\n",
-       " '__package__',\n",
-       " '__path__',\n",
-       " '__spec__',\n",
-       " '_base',\n",
-       " '_csv',\n",
-       " '_geojson',\n",
-       " '_georss',\n",
-       " '_kml',\n",
-       " '_service',\n",
-       " '_wms',\n",
-       " 'wmts']"
-      ]
-     },
-     "execution_count": 2,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "from arcgis.mapping import ogc\n",
-    "dir(ogc)"
-   ]
-  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -245,7 +192,7 @@
    ],
    "source": [
     "m = gis.map()\n",
-    "m.add_layer(WMTSLayer(url=wmts_url))\n",
+    "m.content.add(wmts_lyr)\n",
     "m"
    ]
   },
@@ -271,6 +218,13 @@
     "print(webmap_item.title)"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "The ``get_data`` method retrieves the data associated with the Web Map item, and we can see it contains `operationalLayers` and `baseMap`."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 39,
@@ -489,15 +443,15 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "The ``get_data`` method retrieves the data associated with the WebMap item, and we can see it contains `operationalLayers` and `baseMap`."
+    "We'll delete this web map since it's for illustration:"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 42,
+   "execution_count": null,
    "metadata": {},
    "outputs": [
-    {
+       {
      "data": {
       "text/plain": [
        "True"
@@ -509,7 +463,7 @@
     }
    ],
    "source": [
-    "webmap_item.delete()"
+    "webmap_item.delete(permanent=True)"
    ]
   },
   {
@@ -528,7 +482,7 @@
    "outputs": [],
    "source": [
     "import json\n",
-    "\n",
+    "root_folder = gis.content.folders.get()\n",
     "dictItemData =  {\n",
     "        'title': 'World Imagery (Wayback)', \n",
     "        'tags': ['imagery', 'wayback', 'esri_imagery', 'community basemap', 'world', 'community', 'satellite', 'orthophotos', 'baseimagery', 'general availability', 'esri_basemap', 'aerial'], \n",
@@ -540,14 +494,7 @@
     "        'type': 'WMTS', \n",
     "        'typeKeywords': ['Data', 'OGC', 'Service', 'Web Map Tile Service']\n",
     "    }\n",
-    "item = gis.content.add(item_properties=dictItemData, upload_size=2836)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Here, the `upload_size` is an optional parameter, specifying the minimum default value for the size of the file when uploading by parts (float. The default value is 1e7 bytes or ~10 MBs). For more info, please check [add](https://developers.arcgis.com/python/api-reference/arcgis.gis.toc.html#arcgis.gis.ContentManager.add)."
+    "item = root_folder.add(item_properties=dictItemData).result()"
    ]
   },
   {
@@ -707,24 +654,29 @@
     "Compared to the response of `get_data` retrieved from a WMTS Layer, we can see that that of a WMTS service serves as a subset to the former."
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "We'll delete this:"
+   ]
+  },
   {
    "cell_type": "code",
-   "execution_count": 8,
+   "execution_count": null,
    "metadata": {},
-   "outputs": [
-    {
+   "outputs": [{
      "data": {
       "text/plain": [
        "True"
       ]
      },
-     "execution_count": 8,
+     "execution_count": 43,
      "metadata": {},
      "output_type": "execute_result"
-    }
-   ],
+    }],
    "source": [
-    "item.delete()"
+    "item.delete(permanent=True)"
    ]
   },
   {
@@ -883,7 +835,7 @@
    ],
    "source": [
     "m1 = gis.map()\n",
-    "m1.add_layer(wms_lyr)\n",
+    "m1.content.add(wms_lyr)\n",
     "m1"
    ]
   },
@@ -923,7 +875,7 @@
     "        'type': 'WMS', \n",
     "        'typeKeywords': ['Data', 'OGC', 'Service', 'Web Map Service']\n",
     "    }\n",
-    "wms_item = gis.content.add(item_properties=dictItemData)\n",
+    "wms_item = root_folder.add(item_properties=dictItemData).result()\n",
     "wms_item.type"
    ]
   },
@@ -993,7 +945,7 @@
     }
    ],
    "source": [
-    "wms_item.delete()"
+    "wms_item.delete(permanent=True)"
    ]
   },
   {
@@ -1015,7 +967,7 @@
    "source": [
     "### WFS Service\n",
     "\n",
-    "For example, the `West Virginia Geological and Economic Survey (WVGES)`, which investigates and reports on West Virginia's geology and disseminates information, provides `WFS` endpoints at [WFS GetCapabilities](https://atlas2.wvgs.wvnet.edu/server/services/Hosted/Reference_Quadrangles/MapServer/WFSServer?request=GetCapabilities&service=WFS). With the WFS data support, we can see a simple example below that query the `Reference Boundaries for the State of West Virginia: 3.75' Quarter Quadrangles, 7.5' Quadrangles, 15' Quadrangles, 100k Quadrangles, 250k Quadrangles` layer to create WFS service, and add to a WebMap item:"
+    "For example, the `West Virginia Geological and Economic Survey (WVGES)`, which investigates and reports on West Virginia's geology and disseminates information, provides `WFS` endpoints at [WFS GetCapabilities](https://atlas2.wvgs.wvnet.edu/server/services/Hosted/Reference_Quadrangles/MapServer/WFSServer?request=GetCapabilities&service=WFS). With the WFS data support, we can see a simple example below that queries the `Reference Boundaries for the State of West Virginia: 3.75' Quarter Quadrangles, 7.5' Quadrangles, 15' Quadrangles, 100k Quadrangles, 250k Quadrangles` layer to create a WFS service, and then add it to a Web Map item:"
    ]
   },
   {
@@ -1154,8 +1106,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Then, use the `add(item_properties, data=None, thumbnail=None, metadata=None, owner=None, folder=None, item_id=None, **kwargs)` method defined in `arcgis.gis` module to add content to the GIS by creating an `WFS` service, with parameters set as:\n",
-    " - item_properties: Required dictionary. See [table](https://developers.arcgis.com/python/api-reference/arcgis.gis.toc.html#arcgis.gis.ContentManager.add) for the keys and values."
+    "Then, use the [`add()`](/python/latest/api-reference/arcgis.gis.toc.html#arcgis.gis._impl._content_manager.Folder.add) method on a [_Folder_](/python/latest/api-reference/arcgis.gis.toc.html#folder) object to add content to the GIS by creating an `WFS` service. The _item_properties_ argument can be an [ItemProperties](/python/api-reference/arcgis.gis.toc.html#arcgis.gis._impl._dataclasses.ItemProperties) object or a dictionary you create. \n",
+    "See the [Items and item types](/rest/users-groups-and-items/items-and-item-types/) rest documentation for detailed description on various items, and the [addItem](/rest/users-groups-and-items/add-item/#request-parameters) documentation for detailed descriptions of the properties."
    ]
   },
   {
@@ -1188,7 +1140,9 @@
     "        'type': 'WFS', \n",
     "        'typeKeywords': ['Data', 'OGC', 'Service', 'Web Feature Service']\n",
     "    }\n",
-    "wfs_item = gis.content.add(item_properties=dictItemData)\n",
+    "\n",
+    "root_folder = gis.content.folders.get()\n",
+    "wfs_item = root_folder.add(item_properties=dictItemData).result()\n",
     "wfs_item.type    "
    ]
   },
@@ -1212,26 +1166,6 @@
     "wfs_item.get_data()['layerType']"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": 16,
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "True"
-      ]
-     },
-     "execution_count": 16,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "wfs_item.delete()"
-   ]
-  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -1272,14 +1206,14 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "wfs_item = gis.content.add(\n",
+    "wfs_item = root_folder.add(\n",
     "                item_properties={\n",
     "                    \"title\": \"Sample WFS Map\",\n",
     "                    \"type\": \"Web Map\",\n",
     "                    \"tags\": \"erase, me\",\n",
     "                    \"text\": json.dumps(wm2),\n",
     "                }\n",
-    "           )"
+    "           ).result()"
    ]
   },
   {
@@ -1295,7 +1229,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "wm_obj2 = WebMap(wfs_item)\n",
+    "wm_obj2 = Map(item=wfs_item)\n",
     "printed_file_url = wm_obj2.print(file_format='JPG', \n",
     "                                 extent={\"xmin\":-10909090.288200358,\"ymin\":2331023.6145840986,\"xmax\":-6203015.330739876,\"ymax\":6401142.496712082,\"spatialReference\":{\"wkid\":102100,\"latestWkid\":3857}})"
    ]
@@ -1324,26 +1258,6 @@
     "Image(printed_file_url)"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": 42,
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "True"
-      ]
-     },
-     "execution_count": 42,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "wfs_item.delete()"
-   ]
-  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -1372,9 +1286,9 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.11"
+   "version": "3.11.10"
   }
  },
  "nbformat": 4,
- "nbformat_minor": 2
+ "nbformat_minor": 4
 }