04. Explore General Metdadata With APSToolkit

chuongmep · Mar 3, 2024 · 8fcc3ea · 8fcc3ea
1 parent 31e5f0d
commit 8fcc3ea
Show file tree

Hide file tree

Showing 3 changed files with 71 additions and 17 deletions.
diff --git a/APSToolkitPython/Tutorials/04. Explore General Metdadata With APSToolkit.ipynb b/APSToolkitPython/Tutorials/04. Explore General Metdadata With APSToolkit.ipynb
@@ -34,9 +34,16 @@
     "%pip install aps-toolkit --upgrade"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Auth"
+   ]
+  },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": 3,
    "metadata": {
     "ExecuteTime": {
      "end_time": "2024-03-02T14:12:22.214171Z",
@@ -51,7 +58,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 5,
    "metadata": {
     "ExecuteTime": {
      "end_time": "2024-03-02T14:12:23.004384Z",
@@ -65,7 +72,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 6,
    "metadata": {
     "ExecuteTime": {
      "end_time": "2024-03-02T14:12:23.009480Z",
@@ -77,9 +84,23 @@
     "urn = \"dXJuOmFkc2sud2lwcHJvZDpmcy5maWxlOnZmLjAtYnBtcEpXUWJTRUVNdUFac1VETWc_dmVyc2lvbj0yNQ\""
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Metadata"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "In this notebook, we able to get all metadata from the item in ACC ot bucket storage"
+   ]
+  },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 7,
    "metadata": {
     "ExecuteTime": {
      "end_time": "2024-03-02T14:12:31.994676Z",
@@ -92,18 +113,36 @@
     "prop_reader = PropReader(urn, token)"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Get Properties from DbId"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "DBID in Autodesk Forge refers to the Database ID. It's a unique identifier assigned to each object (like components or elements) in a model when it's translated into the viewer format by the Autodesk Forge Model Derivative service.\n",
+    "\n",
+    "When you load a model into the Forge Viewer, you can use these DBIDs to interact with specific objects in the model. For example, you can select, isolate, hide objects, or get properties of an object using its DBID. \n",
+    "\n",
+    "It's important to note that DBIDs are not persistent across different versions of the same model. If the model is updated and re-translated, the DBIDs may change."
+   ]
+  },
   {
    "cell_type": "code",
-   "execution_count": 12,
+   "execution_count": 8,
    "metadata": {},
    "outputs": [
     {
      "data": {
       "text/plain": [
-       "<aps_toolkit.PropReader.Property at 0x15b91e3cc10>"
+       "<aps_toolkit.PropReader.Property at 0x216ebf12010>"
       ]
      },
-     "execution_count": 12,
+     "execution_count": 8,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -115,7 +154,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 13,
+   "execution_count": 9,
    "metadata": {},
    "outputs": [
     {
@@ -139,7 +178,7 @@
        " 'Route Analysis Settings': ''}"
       ]
      },
-     "execution_count": 13,
+     "execution_count": 9,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -150,7 +189,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 14,
+   "execution_count": 10,
    "metadata": {},
    "outputs": [
     {
@@ -174,7 +213,7 @@
        " 'Route Analysis': [('Route Analysis Settings', '')]}"
       ]
      },
-     "execution_count": 14,
+     "execution_count": 10,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -185,7 +224,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 16,
+   "execution_count": 11,
    "metadata": {},
    "outputs": [
     {
@@ -194,7 +233,7 @@
        "2"
       ]
      },
-     "execution_count": 16,
+     "execution_count": 11,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -206,7 +245,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 17,
+   "execution_count": 12,
    "metadata": {},
    "outputs": [
     {
@@ -215,7 +254,7 @@
        "[]"
       ]
      },
-     "execution_count": 17,
+     "execution_count": 12,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -226,7 +265,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 18,
+   "execution_count": 13,
    "metadata": {},
    "outputs": [
     {
@@ -235,14 +274,21 @@
        "[]"
       ]
      },
-     "execution_count": 18,
+     "execution_count": 13,
      "metadata": {},
      "output_type": "execute_result"
     }
    ],
    "source": [
     "prop_reader.get_instance(1)"
    ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Congratulations! You have successfully retrieved the metadata of the item in the Autodesk Construction Cloud or BIM 360 storage. Now you can custom the metadata to your needs with diffrence file format uploaded to ACC or BIM 360 storage like : Dwg, Rvt, Nwd, Nwc, Nwf, IFC, etc."
+   ]
   }
  ],
  "metadata": {

diff --git a/Readme.md b/Readme.md
@@ -118,6 +118,7 @@ All Tutorials are available under Jupyter Notebook at [Python Tutorials](./APSTo
 - [01. Setup And Authentication](./APSToolkitPython/Tutorials/01.%20Setup%20And%20Authentication.ipynb)
 - [02. Explore Hubs - Projects - Items - URN](./APSToolkitPython/Tutorials/02.%20Explore%20Hubs%20-%20Projects%20-%20Items%20-%20URN.ipynb)
 - [03. Explore Versions Item and Derivative Urn](./APSToolkitPython/Tutorials/03.%20Explore%20Versions%20Item%20and%20Derivative%20Urn.ipynb)
+- [04. Explore General Metdadata With APSToolkit](./APSToolkitPython/Tutorials/04.%20Explore%20General%20Metdadata%20With%20APSToolkit.ipynb)
 
 ## License
 Thís project is licensed under the terms of the [MIT](LICENSE).

diff --git a/docs/Tutorials/04. Explore General Metdadata With APSToolkit.ipynb b/docs/Tutorials/04. Explore General Metdadata With APSToolkit.ipynb
@@ -485,6 +485,13 @@
    "source": [
     "dataTable.ExportToCsv(\"result.csv\")"
    ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Congratulations! You have successfully retrieved the metadata of the item in the Autodesk Construction Cloud or BIM 360 storage. Now you can custom the metadata to your needs with diffrence file format uploaded to ACC or BIM 360 storage like : Dwg, Rvt, Nwd, Nwc, Nwf, IFC, etc."
+   ]
   }
  ],
  "metadata": {