notebooks/cl-mas-monitor-discover-api-cp4d-template.ipynb

{"cells": [{"metadata": {"id": "3b81286b37574490bd9d5c82d5607564"}, "cell_type": "markdown", "source": "<a id='toc'></a>\n# Discover & play with MAS Monitor API v2 (using Cloud Pak for Data)\n**Last Updated:** 08 May 2024 **Author:** Christophe Lucas <br>\n**Disclaimer:** This code is delivered as-is and is NOT formal IBM documentation in any way\n<a id='toc'></a>\n## Table of Contents\n\n- [**ON YOUR MARK - Read the tutorial**](#tutorial)\n- [**GET SET - Get & Set your MAS Monitor ENV Details**](#getenv)\n- [**GO ! - Play with 17 Sample API Calls**](#game)\n    - [**Manage core resources**](#core)\n        - [**DeviceType**](#devicetype)\n            - [**Device Type Management**](#devicetypemgt)\n                - [1. POST - List DeviceTypes - /api/v2/core/deviceTypes/search](#listdevicetypes)\n                - [2. GET - DeviceType by ID - /api/v2/core/deviceTypes/{deviceTypeId}](#getbyid)\n                - [3. GET - DeviceType Data Items - /api/v2/core/deviceTypes/{deviceTypeId}/dataItems](#getbyiddi)\n                - [4. GET - DeviceType Data Item Details - /api/v2/core/deviceTypes/{deviceTypeId}/dataItems/{dataItemId}](#getbyiddid)               \n            - [**Device Type Dimension Management**](#devicetypedimensiom)\n                - [5. GET - DeviceType Dimensions - /api/v2/core/deviceTypes/{deviceTypeId}/dimensions](#getdimension)\n                - [6. POST - Add Dimension to DeviceType - /api/v2/core/deviceTypes/{deviceTypeId}/dimensions](#adddimension)\n                - [7. PUT - Update Dimension of DeviceType - /api/v2/core/deviceTypes/{deviceTypeId}/dimensions/{dimensionName}](#updatedimension)                 \n        - [**DeviceType -> Device**](#device)\n            - [**Device Management**](#devicemgt)\n                - [8. GET - List Devices of DeviceType - /api/v2/core/deviceTypes/{deviceTypeId}/devices](#listdevices)\n    - [**Query data**](#query)\n        - [**DeviceType**](#querydevicetype)\n            - [**Device Type Alert Management**](#devicetypealertmgt)\n                - [9. POST - List Alerts of DeviceType - /api/v2/datalake/deviceTypes/{deviceTypeId}/alerts/search](#returndevicetypealerts)\n        - [**DeviceType -> Device**](#querydevice)\n           - [**Devices Management**](#devicesmgt)\n                - [10. POST - List Devices of DeviceType - /api/v2/datalake/data/deviceTypes/{deviceTypeId}/devices/search](#listdevices2)\n           - [**Alert Management**](#devicealertmgt)\n                - [11. POST - List Alerts of Device - /api/v2/datalake/deviceTypes/{deviceTypeId}/devices/{deviceId}/alerts/search](#listdevicealerts)\n           - [**Devices Dimension Management**](#devicedimensionmgt)\n                - [12. GET - Get Dimensions of Device - /api/v2/datalake/data/deviceTypes/{deviceTypeId}/devices/{deviceId}/dimensions](#listdevicedimensions)"}, {"metadata": {"id": "52415f8ea01e4e1395fabaf9c2157d1f"}, "cell_type": "markdown", "source": "<a id='tutorial'></a>\n# ON YOUR MARK - Read the tutorial"}, {"metadata": {"id": "54afdaecd55642758bef05bb052eb9b3"}, "cell_type": "markdown", "source": "Make sure you study this tutorial before proceeding any further: \n<a href=\"https://github.com/IBM/mas-monitor-discover-api/tree/main\" target=\"_blank\">Discover & play with MAS Monitor API v2</a>"}, {"metadata": {"id": "9c990fcea0374724808cd78242b24592"}, "cell_type": "markdown", "source": "<a id='getenv'></a>\n# GET SET - Get & Set your MAS Monitor ENV Details"}, {"metadata": {"id": "83a2c36852cc4b1bbbf85c22dd57cd1e"}, "cell_type": "markdown", "source": "You **MUST** first run the below cell for any of the subsequent calls of this Notebook call to work.<br>\nReplace`X-api-key`, `X-api-token`, `tenantId`, `mam_user_email` + `SERVER_URL`, `HTTPS_CONNECTION` in below cell with your Monitor instance values as per <a href=\"https://github.com/IBM/mas-monitor-discover-api/tree/0cf0b8fdb1173d7e48578b0a57fd9f9cc52343b9?tab=readme-ov-file#credentials\" target=\"_blank\">Discover & play with MAS Monitor API v2 - Get Monitor {X-api-key, X-api-token, tenantId, mam_user_email} & Server URL</a> section.\n"}, {"metadata": {"id": "0ff2777e-6548-44f0-9e64-ae3913c583ed"}, "cell_type": "code", "source": "import requests\nimport json\n\nheaders = {'X-api-key':'YOUR-X-api-key',\n           'X-api-token':'YOUR-X-api-token',\n           'tenantId':'YOUR-tenandtId',\n           'mam_user_email': 'YOUR-mam_user_email',\n           'Content-Type': 'application/json'\n          }\nSERVER_URL = \"https://YOUR-SERVER_URL\"\nHTTPS_CONNECTION = \"YOUR-HTTPS_CONNECTION\" # = SERVER_URL without https://\n\nprint(\"===headers=\",headers)\nprint(\"===SERVER_URL=\",SERVER_URL)\nprint(\"===HTTPS_CONNECTION=\",HTTPS_CONNECTION)", "execution_count": null, "outputs": []}, {"metadata": {"id": "40cf9b642c1a4bb6af75410d622c319d"}, "cell_type": "markdown", "source": "<a id='game'></a>\n# GO ! Play with Sample API Calls"}, {"metadata": {"id": "5b60e97c70e74aff90943d8a7849d328"}, "cell_type": "markdown", "source": "<a id='core'></a>\n# Manage core resources API"}, {"metadata": {"id": "c791a43560784b3f9a66bb356d42a048"}, "cell_type": "markdown", "source": "<a id='devicetype'></a>\n# DeviceType"}, {"metadata": {"id": "5f88c4f0980949e6b25d908ceab77a4b"}, "cell_type": "markdown", "source": "<a id='devicetypemgt'></a>\n# DeviceType Management"}, {"metadata": {"id": "f921dbf6f48940f58817c8341f139ea2"}, "cell_type": "markdown", "source": "<a id='listdevicetypes'></a>\n## 1. POST - List DeviceTypes - /api/v2/core/deviceTypes/search"}, {"metadata": {"id": "a99ef0ba889f48ee9848c84f4589afab"}, "cell_type": "markdown", "source": "- **What this call does:** This POST call returns the list of *DeviceTypes* in your MAS Monitor instance.<br>\n- **Your action:** Run this cell and in the returned output, find-copy the `uuid` of your `XY-Robot` and use-paste it as `deviceTypeID` parameter in subsequent calls.<br>\n- Back to [Table of Contents](#toc)"}, {"metadata": {"id": "2338e5d4def945a4804c0664ae32e909"}, "cell_type": "code", "source": "import http.client\nconn = http.client.HTTPSConnection(HTTPS_CONNECTION)\n\n# ======================================================================================\n# === PARAMETERS (Required)  - NONE ====================================================\n# === PARAMETERS (Optional) ============================================================\nstatus = \"ACTIVE\"\noffset = 0\nlimit = 100\n# === REQUEST BODY =====================================================================\nrequest_body = ''\n# === API CALL URL =====================================================================\n# url = \"/api/v2/core/deviceTypes/search\"\nurl = f\"/api/v2/core/deviceTypes/search?status={status}&offset={offset}&limit={limit}\"\n# ======================================================================================\n\n#=== EXECUTE API CALL ==================================================================\nconn.request(\"POST\", url, request_body, headers)\nres = conn.getresponse()\nprint(f\"=== HTTP Response Code: {res.status}\",\"===\")\n# ======================================================================================\n\n#=== PRINT RESULTS =====================================================================\ndata = res.read()\njson_data = json.loads(data)\nprint(json.dumps(json_data, indent=2))\n# ======================================================================================", "execution_count": null, "outputs": []}, {"metadata": {"id": "dcbc1e4a007d46118a4af7f6f1ab5894"}, "cell_type": "markdown", "source": "<a id='getbyid'></a>\n## 2. GET - DeviceType by ID - /api/v2/core/deviceTypes/{deviceTypeId}"}, {"metadata": {"id": "77e955f4f56949548be94b466cbe2a54"}, "cell_type": "markdown", "source": "- **What this call does:** This GET call returns the details of 1 *Device* of a given *DeviceType*.<br>\n- **Your action:** In this call, replace `deviceTypeID` by the value that was returned for your `XY-Robot` in the [1. POST List DeviceTypes](#listdevicetypes) call. Run this cell and observe the output.<br>\n- Back to [Table of Contents](#toc)"}, {"metadata": {"id": "c05a708694c2427783dc0c863fbfab56"}, "cell_type": "code", "source": "import http.client\nconn = http.client.HTTPSConnection(HTTPS_CONNECTION)\n\n# ========================================================================================\n# === PARAMETERS (Required) ==============================================================\ndeviceTypeId = 'eea1df90-37c5-43eb-a4ab-8da6885d98df' # replace by `uuid` of your XY-Robot\n# === PARAMETERS (Optional) - NONE =======================================================\n# === REQUEST BODY =======================================================================\nrequest_body = ''\n# === API CALL URL =====================================================================\nurl = f\"/api/v2/core/deviceTypes/{deviceTypeId}\"\n# ======================================================================================\n\n#=== EXECUTE API CALL ==================================================================\nconn.request(\"GET\", url, request_body, headers) # SAMPLE\nres = conn.getresponse()\nprint(f\"=== HTTP Status Code: {res.status}\",\"===\")\n\n#=== PRINT RESULTS =====================================================================\ndata = res.read()\njson_data = json.loads(data)\nprint(json.dumps(json_data, indent=2))", "execution_count": null, "outputs": []}, {"metadata": {"id": "e562f3f4c1564bdb85b70cb84a79d15d"}, "cell_type": "markdown", "source": "<a id='getbyiddi'></a>\n## 3. GET DeviceType Data Items - /api/v2/core/deviceTypes/{deviceTypeId}/dataItems"}, {"metadata": {"id": "6e6dd6e90d9c43528ab58447391a8b3b"}, "cell_type": "markdown", "source": "- **What this call does:** This GET call returns the list of *DataItems* associated to a given *DeviceType*.<br>\n- **Your action:** In this call, replace `deviceTypeID` by the value that was returned for your `XY-Robot` in the [1. POST List DeviceTypes](#listdevicetypes) call. Run this cell and in the returned output, find-copy the `uuid` of the `SPEED` ( of `\"type\": \"METRIC\"`) *DataItem* and use-paste it as `dataItemId` parameter in next call.<br>\n- Back to [Table of Contents](#toc)"}, {"metadata": {"id": "2a2946e34c3f48248d024f9eb9eb40f7"}, "cell_type": "code", "source": "import http.client\nconn = http.client.HTTPSConnection(HTTPS_CONNECTION)\n\n# ========================================================================================\n# === PARAMETERS (Required) ==============================================================\ndeviceTypeId = 'eea1df90-37c5-43eb-a4ab-8da6885d98df' # replace by `uuid` of your XY-Robot\n# === PARAMETERS (Optional) ==============================================================\n# === REQUEST BODY =======================================================================\nrequest_body = ''\n# === API CALL URL =======================================================================\nurl = f\"/api/v2/core/deviceTypes/{deviceTypeId}/dataItems\"\n# ========================================================================================\n\n#=== EXECUTE API CALL ====================================================================\nconn.request(\"GET\", url, request_body, headers)\nres = conn.getresponse()\nprint(f\"=== HTTP Status Code: {res.status}\",\"===\")\n\n#=== PRINT RESULTS =======================================================================\ndata = res.read()\njson_data = json.loads(data)\nprint(json.dumps(json_data, indent=2))\n# ========================================================================================", "execution_count": null, "outputs": []}, {"metadata": {"id": "77f82fbf58744f3487efb5936d80098f"}, "cell_type": "markdown", "source": "<a id='getbyiddid'></a>\n## 4. GET DeviceType Data Item Details - /api/v2/core/deviceTypes/{deviceTypeId}/dataItems/{dataItemId}"}, {"metadata": {"id": "55387501074746378de0e9216f85da1b"}, "cell_type": "markdown", "source": "- **What this call does:** This GET call returns the details of a given *DataItem* associated to a given *DeviceType*.<br>\n- **Your action:**  In this call, replace `deviceTypeID` by the value that was returned for your `XY-Robot` in the [1. POST List DeviceTypes](#listdevicetypes) call. Replace `dataItemId` by the value found in previous [3. GET DeviceType Data Items - /api/v2/core/deviceTypes/{deviceTypeId}/dataItems](#getbyiddi). Run this cell and observe the returned output.<br>\n- Back to [Table of Contents](#toc)"}, {"metadata": {"id": "939dd62ac284460bb2eb960a634e8ac0"}, "cell_type": "code", "source": "import http.client\nconn = http.client.HTTPSConnection(HTTPS_CONNECTION)\n\n# ========================================================================================\n# === PARAMETERS (Required) ==============================================================\ndeviceTypeId = 'eea1df90-37c5-43eb-a4ab-8da6885d98df' # replace by `uuid` of your XY_Robot\ndataItemId = '7cb55327-2d7e-4fc3-9dc5-0f7aa4dc07a4'\n# === PARAMETERS (Optional) ==============================================================\n# === REQUEST BODY =======================================================================\nrequest_body = ''\n# === API CALL URL =======================================================================\nurl = f\"/api/v2/core/deviceTypes/{deviceTypeId}/dataItems/{dataItemId}\"\n# ========================================================================================\n\n#=== EXECUTE API CALL ====================================================================\nconn.request(\"GET\", url, request_body, headers) # SAMPLE\nres = conn.getresponse()\nprint(f\"=== HTTP Status Code: {res.status}\",\"===\")\n\n#=== PRINT RESULTS =======================================================================\ndata = res.read()\njson_data = json.loads(data)\nprint(json.dumps(json_data, indent=2))\n# ========================================================================================", "execution_count": null, "outputs": []}, {"metadata": {"id": "f120d0e386654d3dbe92c5f8798404bc"}, "cell_type": "markdown", "source": "<a id='devicetypedimensiom'></a>\n# DeviceType Dimension Management"}, {"metadata": {"id": "446b74a1c694491c8ab8feb96e793c15"}, "cell_type": "markdown", "source": "<a id='getdimension'></a>\n## 5. GET Get DeviceType Dimensions - /api/v2/core/deviceTypes/{deviceTypeId}/dimensions"}, {"metadata": {"id": "2e58b191c177403cbbff7741e522e8d2"}, "cell_type": "markdown", "source": "- **What this call does:** This GET call returns the *Dimensions* of a given *DeviceType*.<br>\n- **Your action:**  In this call, replace `deviceTypeID` by the value that was returned for your `XY-Robot` in the [1. POST List DeviceTypes](#listdevicetypes) call. Run this cell and in the returned output, find-copy the `uuid` of the `manufacturer` *Dimension* and use-paste it as `dimensionName` parameter in [7. PUT Update Dimension of DeviceType](#updatedimension) calls.<br>\n- Back to [Table of Contents](#toc)"}, {"metadata": {"id": "11c1563e9e854bd88c44d81f474db679"}, "cell_type": "code", "source": "import http.client\nconn = http.client.HTTPSConnection(HTTPS_CONNECTION)\n\n# ========================================================================================\n# === PARAMETERS (Required) ==============================================================\ndeviceTypeId = 'eea1df90-37c5-43eb-a4ab-8da6885d98df' # replace by `uuid` of your XY_Robot\n# === PARAMETERS (Optional) ==============================================================\n# === REQUEST BODY =======================================================================\nrequest_body = ''\n# === API CALL URL =======================================================================\nurl = f\"/api/v2/core/deviceTypes/{deviceTypeId}/dimensions\"\n# ========================================================================================\n\n#=== EXECUTE API CALL ====================================================================\nconn.request(\"GET\", url, request_body, headers)\nres = conn.getresponse()\nprint(f\"=== HTTP Status Code: {res.status}\",\"===\")\n\n#=== PRINT RESULTS =======================================================================\ndata = res.read()\njson_data = json.loads(data)\nprint(json.dumps(json_data, indent=2))", "execution_count": null, "outputs": []}, {"metadata": {"id": "93e367eae13b42bf9df921793e483947"}, "cell_type": "markdown", "source": "<a id='adddimension'></a>\n## 6. POST Add Dimension to DeviceType - /api/v2/core/deviceTypes/{deviceTypeID}/dimensions"}, {"metadata": {"id": "4c3edbe09ba6437381c9205fd2e72fde"}, "cell_type": "markdown", "source": "- **What this call does:** This POST call adds a new *Dimension* to a given *DeviceType*.<br>\n- **Your action:** In this call, (1) replace `deviceTypeID` by the value that was returned for your **XY-Robot** in the [1. POST List DeviceTypes](#listdevices) call, (2) in the `request_body` of the cell, enter the `\"name\"` and `\"defaultValue\"` you want the Dimension to be created to have. Run the cell.<br>\n- **Note:** Note this cal will only return a `=== HTTP Status Code: 200 ===` output, nothing else. After you have run this call, go to your Monitor `Setup` menu, find your `XY-Robot`, open its `Identity` tab and observe that the new *Dimension* has been added. Note this cal will only return a `=== HTTP Status Code: 200 ===` output.<br>\n- Back to [Table of Contents](#toc)"}, {"metadata": {"id": "7dfb49e99344470f89d6004aac156dc5"}, "cell_type": "code", "source": "import http.client\nconn = http.client.HTTPSConnection(HTTPS_CONNECTION)\n\n# ========================================================================================\n# === PARAMETERS (Required) ==============================================================\ndeviceTypeId = 'eea1df90-37c5-43eb-a4ab-8da6885d98df' # replace by `uuid` of your XY_Robot\n# === PARAMETERS (Optional) ==============================================================\n# === REQUEST BODY =======================================================================\nrequest_body = json.dumps([\n  {\n    \"name\": \"APIDimension001\",\n    \"columnType\": \"LITERAL\",\n    \"defaultValue\": \"PerthAPI\",\n    \"overrideExistingValue\": False\n  }\n])\n# === API CALL URL =======================================================================\nurl = f\"/api/v2/core/deviceTypes/{deviceTypeId}/dimensions\"\n# ========================================================================================\n    \n#=== EXECUTE API CALL ====================================================================\nconn.request(\"POST\", url, request_body, headers)\nres = conn.getresponse()\nprint(f\"=== HTTP Status Code: {res.status}\",\"===\")", "execution_count": null, "outputs": []}, {"metadata": {"id": "0ff1a1adbbd74d51bfdc33d7b94357c2"}, "cell_type": "markdown", "source": "<a id='updatedimension'></a>\n## 7. PUT Update Dimension of DeviceType - /api/v2/core/deviceTypes/{deviceTypeId}/dimensions/{dimensionName}"}, {"metadata": {"id": "ee7a7975fecf4a8ba2f78764623bbaa8"}, "cell_type": "markdown", "source": "- **What this call does:** This PUT call updates the given *Dimension* of a given *DeviceType*.<br>\n- **Your action:** In this call, (1) replace `deviceTypeID` by the value that was returned for your **XY-Robot** in the [1. POST List DeviceTypes](#listdevices) call, and (2) observe the `dimensionName` being `manufacturer` (1 *Dimension* returned by [5. GET Get DeviceType Dimensions ](#getdimension)). In the `request_body` of the cell, enter the new `name` you want the *Dimension* to have, and set its desired new `defaultValue`. Run the cell.<br>\n- **Note:** Note this cal will only return a `=== HTTP Status Code: 200 ===` output, nothing else. After you have run this call, go to your Monitor `Setup` menu, find your `XY-Robot`, open its `Identity` tab and observe that the `manufacturer` *Dimension* has been updated.\n- Back to [Table of Contents](#toc)"}, {"metadata": {"id": "dac2d1c232b747fa97be4b8578713d01"}, "cell_type": "code", "source": "import http.client\nconn = http.client.HTTPSConnection(HTTPS_CONNECTION)\n\n# ========================================================================================\n# === PARAMETERS (Required) ==============================================================\ndeviceTypeId = 'eea1df90-37c5-43eb-a4ab-8da6885d98df' # replace by `uuid` of your XY_Robot\ndimensionName = 'manufacturer'\n# === PARAMETERS (Optional) ==============================================================\n\n# === REQUEST BODY =======================================================================\nrequest_body = json.dumps({\n  \"name\": \"manufacturer\",\n  \"columnType\": \"LITERAL\",\n  \"defaultValue\": \"manufacturer002\",\n  \"overrideExistingValue\": True\n})\n\n# === API CALL URL =======================================================================\nurl = f\"/api/v2/core/deviceTypes/{deviceTypeId}/dimensions/{dimensionName}\"\n# ========================================================================================\n    \n#=== EXECUTE API CALL ====================================================================\nconn.request(\"PUT\", url, request_body, headers)\nres = conn.getresponse()\nprint(f\"=== HTTP Status Code: {res.status}\",\"===\")", "execution_count": null, "outputs": []}, {"metadata": {"id": "f21f790e461d4fdea2c57fcfc804d1c1"}, "cell_type": "markdown", "source": "<a id='device'></a>\n# DeviceType -> Device"}, {"metadata": {"id": "dff4b20dfa694638834650b0bf826772"}, "cell_type": "markdown", "source": "<a id='devicemgt'></a>\n# Device Management"}, {"metadata": {"id": "0ca3f9f460974c228b79c35a7015f024"}, "cell_type": "markdown", "source": "<a id='listdevices'></a>\n## 8. GET List Devices of DeviceType - /api/v2/core/deviceTypes/{deviceTypeId}/devices"}, {"metadata": {"id": "e4ae12c1e7a445998369c49e3fa14d9b"}, "cell_type": "markdown", "source": "- **What this call does:** This GET call returns the List of *Devices* of a given *DeviceType*<br>\n- **Your action:** In this call, replace `deviceTypeID` by the value that was returned for your **XY-Robot** in the [1. POST List DeviceTypes](#listdevices) call. Run the cell and in the returned output, take note of the `name` value of your **73000** Robot.<br>\n- Back to [Table of Contents](#toc)"}, {"metadata": {"id": "bb2e70b871964b8e8a7ebd12ebd499ab"}, "cell_type": "code", "source": "import http.client\nconn = http.client.HTTPSConnection(HTTPS_CONNECTION)\n\n# ========================================================================================\n# === PARAMETERS (Required) ==============================================================\ndeviceTypeId = 'eea1df90-37c5-43eb-a4ab-8da6885d98df' # replace by `uuid` of your XY-Robot\n# === PARAMETERS (Optional) - NONE =======================================================\n# === REQUEST BODY =======================================================================\nrequest_body = ''\n# === API CALL URL =====================================================================\nurl = f\"/api/v2/core/deviceTypes/{deviceTypeId}/devices\"\n# ======================================================================================\n\n#=== EXECUTE API CALL ==================================================================\nconn.request(\"GET\", url, request_body, headers) # SAMPLE\nres = conn.getresponse()\nprint(f\"=== HTTP Status Code: {res.status}\",\"===\")\n\n#=== PRINT RESULTS =====================================================================\ndata = res.read()\njson_data = json.loads(data)\nprint(json.dumps(json_data, indent=2))", "execution_count": null, "outputs": []}, {"metadata": {"id": "e02702d87cc44d879593f994be0d054d"}, "cell_type": "markdown", "source": "<a id='query'></a>\n# Query data"}, {"metadata": {"id": "df0bf2438dc042cd8a1e740d1a87a978"}, "cell_type": "markdown", "source": "<a id='querydevicetype'></a>\n# DeviceType"}, {"metadata": {"id": "0d598cabc2e54a038ae02e7db6c0843e"}, "cell_type": "markdown", "source": "<a id='returndevicetypealerts'></a>\n# Device Type Alert Management"}, {"metadata": {"id": "23121c22eb7d46828a669f4da1107a78"}, "cell_type": "markdown", "source": "<a id='returndevicetypedata'></a>\n## 9. POST - List Alerts of DeviceType - /api/v2/datalake/deviceTypes/{deviceTypeId}/alerts/search"}, {"metadata": {"id": "56122188f8c74ec1bd108020202021ed"}, "cell_type": "markdown", "source": "- **What this call does:** This POST call returns the list of given *Alerts* of a given *DeviceType*<br>\n- **Your action:** In this call, replace `deviceTypeId` by the value that was returned for your **XY-Robot** in the [1. POST List DeviceTypes](#listdevices) call. In the `\"search\"`, select the name of the `alert_speed_7` of the in the tutorial TODO. Set `\"tsBegin\"` & `\"tsEnd\"` to the time range you want to list the Alerts for. Run the cell and observe the output.<br>\n- Back to [Table of Contents](#toc)"}, {"metadata": {"id": "e0c2c2f642774c078178836b1d6ccc6d", "scrolled": true}, "cell_type": "code", "source": "import http.client\nconn = http.client.HTTPSConnection(HTTPS_CONNECTION)\n\n# ========================================================================================\n# === PARAMETERS (Required) ==============================================================\ndeviceTypeId = 'eea1df90-37c5-43eb-a4ab-8da6885d98df' # replace by `uuid` of your XY-Robot\n# === PARAMETERS (Optional) - NONE =======================================================\n# === REQUEST BODY =======================================================================\nrequest_body = json.dumps({\n  \"search\": \"alert_speed_7\",\n  \"tsBegin\": \"2024-04-29T07:31:57.893Z\",\n  \"tsEnd\": \"2024-05-01T07:31:57.893Z\"\n})\n# === API CALL URL =====================================================================\nurl = f\"/api/v2/datalake/deviceTypes/{deviceTypeId}/alerts/search\"\n# ======================================================================================\n\n#=== EXECUTE API CALL ==================================================================\nconn.request(\"POST\", url, request_body, headers) # SAMPLE\nres = conn.getresponse()\nprint(f\"=== HTTP Status Code: {res.status}\",\"===\")\n\n#=== PRINT RESULTS =====================================================================\ndata = res.read()\njson_data = json.loads(data)\nprint(json.dumps(json_data, indent=2))", "execution_count": null, "outputs": []}, {"metadata": {"id": "4f7c9e3a014f40fc97168de6333e8bcd"}, "cell_type": "code", "source": "import http.client\nconn = http.client.HTTPSConnection(HTTPS_CONNECTION)\n\n# ========================================================================================\n# === PARAMETERS (Required) ==============================================================\ndeviceTypeId = 'eea1df90-37c5-43eb-a4ab-8da6885d98df' # replace by `uuid` of your XY-Robot\n# === PARAMETERS (Optional) - NONE =======================================================\n# === REQUEST BODY =======================================================================\nrequest_body = json.dumps({\n  \"search\": \"alert_speed_7\",\n  \"tsBegin\": \"2024-04-29T07:31:57.893Z\",\n  \"tsEnd\": \"2024-05-01T07:31:57.893Z\",\n  \"groupByField\": \"Severity\"  \n})\n# === API CALL URL =====================================================================\nurl = f\"/api/v2/datalake/deviceTypes/{deviceTypeId}/alerts/totalCount\"\n# ======================================================================================\n\n#=== EXECUTE API CALL ==================================================================\nconn.request(\"POST\", url, request_body, headers) # SAMPLE\nres = conn.getresponse()\nprint(f\"=== HTTP Status Code: {res.status}\",\"===\")\n\n#=== PRINT RESULTS =====================================================================\ndata = res.read()\njson_data = json.loads(data)\nprint(json.dumps(json_data, indent=2))", "execution_count": null, "outputs": []}, {"metadata": {"id": "5988f47f709e4efc84336793dc721304"}, "cell_type": "markdown", "source": "<a id='querydevice'></a>\n# DeviceType -> Device"}, {"metadata": {"id": "8e0952e0c194461aaece0d0d8ab7fbc8"}, "cell_type": "markdown", "source": "<a id='devicesmgt'></a>\n# Devices Management"}, {"metadata": {"id": "d66fa7ad4e7d4dc48cd857b71a466c78"}, "cell_type": "markdown", "source": "<a id='listdevices2'></a>\n## 10. POST - List Devices of DeviceType - /api/v2/datalake/data/deviceTypes/{deviceTypeId}/devices/search"}, {"metadata": {"id": "79ad31e940234dad92b8b07fa0c84f4a"}, "cell_type": "markdown", "source": "- **What this call does:** This POST call returns the list of *Devices* of a given *DeviceType*<br>\n- **Your action:** In this call, replace `deviceTypeID` by the value that was returned for your **XY-Robot** in the [1. POST List DeviceTypes](#listdevices) call. Run the cell and observe the output.<br>\n- Back to [Table of Contents](#toc)"}, {"metadata": {"id": "1574716356094aa3bf914df50e04caab"}, "cell_type": "code", "source": "import http.client\nconn = http.client.HTTPSConnection(HTTPS_CONNECTION)\n\n# ========================================================================================\n# === PARAMETERS (Required) ==============================================================\ndeviceTypeId = 'eea1df90-37c5-43eb-a4ab-8da6885d98df' # replace by `uuid` of your XY-Robot\n# === PARAMETERS (Optional) - NONE =======================================================\n# === REQUEST BODY =======================================================================\nrequest_body = ''\n# === API CALL URL =====================================================================\nurl = f\"/api/v2/datalake/data/deviceTypes/{deviceTypeId}/devices/search\"\n# ======================================================================================\n\n#=== EXECUTE API CALL ==================================================================\nconn.request(\"POST\", url, request_body, headers) # SAMPLE\nres = conn.getresponse()\nprint(f\"=== HTTP Status Code: {res.status}\",\"===\")\n\n#=== PRINT RESULTS =====================================================================\ndata = res.read()\njson_data = json.loads(data)\nprint(json.dumps(json_data, indent=2))", "execution_count": null, "outputs": []}, {"metadata": {"id": "7f8d4cf7afc34d0a88a59ead658efab3"}, "cell_type": "markdown", "source": "<a id='devicealertmgt'></a>\n# Alert Management"}, {"metadata": {"id": "a7266570d1604597bab387f61acebfe0"}, "cell_type": "markdown", "source": "<a id='listdevicealerts'></a>\n## 11. POST - List Alerts of Device - /api/v2/datalake/deviceTypes/{deviceTypeId}/devices/{deviceId}/alerts/search"}, {"metadata": {"id": "e111a61cb16e46948c7c1dacd4899940"}, "cell_type": "markdown", "source": "- **What this call does:** This POST call returns the list of *Alerts* of the given *Device* of a given *DeviceType*<br>\n- **Your action:** In this call, replace `deviceTypeID` by the value that was returned for your **XY-Robot** in the [1. POST List DeviceTypes](#listdevices) call. Leave the `deviceId` to `73000` which corresponds to 1 of your Robots. In the `\"search\"`, select the name of the `alert_speed_7` of the in the tutorial TODO. Set `\"tsBegin\"` & `\"tsEnd\"` to the time range you want to list the Alerts forRun the cell and observe the output.<br>\n- Back to [Table of Contents](#toc)"}, {"metadata": {"id": "1626b30dbac146028d44c27548dfcde1", "scrolled": true}, "cell_type": "code", "source": "import http.client\nconn = http.client.HTTPSConnection(HTTPS_CONNECTION)\n\n# ========================================================================================\n# === PARAMETERS (Required) ==============================================================\ndeviceTypeId = 'eea1df90-37c5-43eb-a4ab-8da6885d98df' # replace by `uuid` of your XY-Robot\ndeviceId = '73000'\n# === PARAMETERS (Optional) - NONE =======================================================\n# === REQUEST BODY =======================================================================\nrequest_body = json.dumps({\n  \"search\": \"alert_speed_7\",\n  \"tsBegin\": \"2024-04-29T07:31:57.893Z\",\n  \"tsEnd\": \"2024-05-01T07:31:57.893Z\"\n})\n# === API CALL URL =====================================================================\nurl = f\"/api/v2/datalake/deviceTypes/{deviceTypeId}/devices/{deviceId}/alerts/search\"\n# ======================================================================================\n\n#=== EXECUTE API CALL ==================================================================\nconn.request(\"POST\", url, request_body, headers) # SAMPLE\nres = conn.getresponse()\nprint(f\"=== HTTP Status Code: {res.status}\",\"===\")\n\n#=== PRINT RESULTS =====================================================================\ndata = res.read()\njson_data = json.loads(data)\nprint(json.dumps(json_data, indent=2))", "execution_count": null, "outputs": []}, {"metadata": {"id": "5fec6d06d8cc4c9a98fbc0667712b91d"}, "cell_type": "markdown", "source": "<a id='devicdimensionmgt'></a>\n# Devices Dimension Management"}, {"metadata": {"id": "b32d80afdeb148528d64409b7a218394"}, "cell_type": "markdown", "source": "<a id='listdevicedimensions'></a>\n## 12. GET - Get Dimensions of Device - /api/v2/datalake/data/deviceTypes/{deviceTypeId}/devices/{deviceId}/dimensions"}, {"metadata": {"id": "84dc210de90c47469a76f10ca38e8d5a"}, "cell_type": "markdown", "source": "- **What this call does:** This GET call returns the list of *Dimensions* of the given *Device* of a given *DeviceType*<br>\n- **Your action:** In this call, replace `deviceTypeID` by the value that was returned for your **XY-Robot** in the [1. POST List DeviceTypes](#listdevices) call. Leave the `deviceId` to `73000` which corresponds to 1 of your Robots. In the `\"search\"`, select the name of the `alert_speed_7` of the in the tutorial TODO. Set `\"tsBegin\"` & `\"tsEnd\"` to the time range you want to list the Alerts forRun the cell and observe the output.<br>\n- Back to [Table of Contents](#toc)"}, {"metadata": {"id": "c43778bd477949c3ab28dd5f0d3d518f"}, "cell_type": "code", "source": "import http.client\nconn = http.client.HTTPSConnection(HTTPS_CONNECTION)\n\n# ========================================================================================\n# === PARAMETERS (Required) ==============================================================\ndeviceTypeId = 'eea1df90-37c5-43eb-a4ab-8da6885d98df' # replace by `uuid` of your XY-Robot\ndeviceId = '73000'\n# === PARAMETERS (Optional) - NONE =======================================================\n# === REQUEST BODY =======================================================================\nrequest_body = ''\n# === API CALL URL =====================================================================\nurl = f\"/api/v2/datalake/data/deviceTypes/{deviceTypeId}/devices/{deviceId}/dimensions\"\n# ======================================================================================\n\n#=== EXECUTE API CALL ==================================================================\nconn.request(\"GET\", url, request_body, headers) # SAMPLE\nres = conn.getresponse()\nprint(f\"=== HTTP Status Code: {res.status}\",\"===\")\n\n#=== PRINT RESULTS =====================================================================\ndata = res.read()\njson_data = json.loads(data)\nprint(json.dumps(json_data, indent=2))", "execution_count": null, "outputs": []}], "metadata": {"kernelspec": {"name": "python3", "display_name": "Python 3.10", "language": "python"}, "language_info": {"name": "python", "version": "3.10.6", "mimetype": "text/x-python", "codemirror_mode": {"name": "ipython", "version": 3}, "pygments_lexer": "ipython3", "nbconvert_exporter": "python", "file_extension": ".py"}}, "nbformat": 4, "nbformat_minor": 1}