{"id":317,"date":"2025-04-01T12:50:23","date_gmt":"2025-04-01T12:50:23","guid":{"rendered":"http:\/\/www2.gimasi.com\/?docs=giot-portal\/api\/use-api"},"modified":"2025-04-01T12:50:23","modified_gmt":"2025-04-01T12:50:23","slug":"use-api","status":"publish","type":"docs","link":"https:\/\/www.gimasi.com\/?docs=giot-documentation\/api\/use-api","title":{"rendered":"Use Cases API"},"content":{"rendered":"<p>[vc_row][vc_column][vc_column_text css=\\&#8221;\\&#8221;]<\/p>\n<style>\n  h3 {<br \/>    color: #0A3D62; \/* Blu scuro *\/<br \/>    font-weight: bold;<br \/>  }<\/p>\n<p>  strong, b {<br \/>    color: #0A3D62; \/* Blu scuro *\/<br \/>  }<br \/><\/style>\n<p>To interact with the API, you\u2019ll need the generated <strong>API key<\/strong>. This key can be included in your requests in the following ways:<\/p>\n<ul>\n<li>Header Authentication: Add the key as a header for more secure access.<br \/>\nExample of Header Authentication:<\/li>\n<\/ul>\n<pre>GET https:\/\/dev.giot.api.gimasi.com\/api\/v1\/events\/by_id?id=6e9f3d2e-a37d49ab-9369-3bb1474839b4\\\" -H \\\"accept: application\/json\\\" -H \u201capi-key:\n\n3uoUPTpZ9pEquHMho6ynvqNRvLHY2aJZ4gglGAHGJWs=\\\"<\/pre>\n<h4>Handling Authentication Errors<\/h4>\n<p>The API returns error codes to help you troubleshoot authentication issues:<br \/>\n<strong>401 Unauthorized:<\/strong> Your key is missing, expired, or invalid.<br \/>\n<strong>403 Forbidden:<\/strong> Your key doesn\u2019t have the right permissions.<\/p>\n<h3>API Endpoints<\/h3>\n<blockquote><p>Lists all alarms of all devices in the tenant. &gt; API Request<\/p><\/blockquote>\n<pre>GET https:\/\/tenant_url\/api\/v1\/alarms?request_parameters<\/pre>\n<p>Request Parameters &gt; Optional Parameters:<\/p>\n<ul>\n<li>page_number: Number of the page to view<\/li>\n<li>field_to_orderd: Field to order results by.<\/li>\n<li>order: Sorting order of the results.<\/li>\n<li>tenant_id: Filter results by tenant_id. Only for API keys configured to access all tenants.<\/li>\n<li>status: Filter results by alarm status.<\/li>\n<li>start_date: Filter results by alarm start date.<\/li>\n<li>end_date: Filter results by alarm end date.<\/li>\n<\/ul>\n<p>Note:<br \/>\nAPI Key with Read permission is required.<\/p>\n<h5>Example API Request:<\/h5>\n<pre>GET http:\/\/ dev.giot.api.gimasi.com\/api\/v1\/alarms?\npage_number=1&amp;field_to_order=id&amp;order=desc&amp;status=ON&amp;start_date=20\n24-11-11&amp;end_date=2024-12-11\\\"<\/pre>\n<p>Example Response:<\/p>\n<pre>JSON List in the following format:\n{\n\\\"items\\\": [\n\\\"confirmed_at\\\": null,\n\\\"device_id\\\": \\\"7e89800a-3a58-47f7-95e0-088497ed341a\\\",\n\\\"device_name\\\": \\\"Name FOTA Test\\\",\n\\\"device_serial\\\": \\\"901405800168258\\\",\n\\\"events\\\": [\n{\n\\\"event\\\": \\\"ON\\\",\n\\\"inserted_at\\\": \\\"2024-12-11T13:03:45\\\",\n\\\"params\\\": {\n\\\"tamper_state\\\": \\\"INTACT\\\"\n}\n}\n],\n\\\"id\\\": \\\"1a87b2a4-de3c-4abe-ada1-ad12c77bfd10\\\",\n\\\"inserted_at\\\": \\\"2025-03-11T13:03:45\\\",\n\\\"label\\\": \\\"device-tamper-alarm\\\",\n\\\"level\\\": \\\"warning\\\",\n\\\"params\\\": {\n\\\"tamper_state\\\": \\\"INTACT\\\"\n},\n\\\"resolved_at\\\": null,\n\\\"status\\\": \\\"ON\\\",\n\\\"triggered_at\\\": \\\"2024-12-11T13:03:45.917377Z\\\",\n\\\"type\\\": \\\"multiple\\\",\n\\\"updated_at\\\": \\\"2024-12-11T13:03:45\\\"\n}<\/pre>\n<p>[\/vc_column_text][\/vc_column][\/vc_row]<\/p>\n","protected":false},"featured_media":0,"parent":314,"menu_order":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"_uag_custom_page_level_css":"","site-sidebar-layout":"default","site-content-layout":"","ast-site-content-layout":"default","site-content-style":"default","site-sidebar-style":"default","ast-global-header-display":"","ast-banner-title-visibility":"","ast-main-header-display":"","ast-hfb-above-header-display":"","ast-hfb-below-header-display":"","ast-hfb-mobile-header-display":"","site-post-title":"","ast-breadcrumbs-content":"","ast-featured-img":"","footer-sml-layout":"","ast-disable-related-posts":"","theme-transparent-header-meta":"","adv-header-id-meta":"","stick-header-meta":"","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","astra-migrate-meta-layouts":"default","ast-page-background-enabled":"default","ast-page-background-meta":{"desktop":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"ast-content-background-meta":{"desktop":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"footnotes":""},"doc_tag":[],"class_list":["post-317","docs","type-docs","status-publish","hentry"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v27.2 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>Use Cases API -<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.gimasi.com\/?docs=giot-documentation\/api\/use-api\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Use Cases API -\" \/>\n<meta property=\"og:description\" content=\"[vc_row][vc_column][vc_column_text css=&#8221;&#8221;] To interact with the API, you\u2019ll need the generated API key. This key can be included in your requests in the following ways: Header Authentication: Add the key as a header for more secure access. Example of Header Authentication: GET https:\/\/dev.giot.api.gimasi.com\/api\/v1\/events\/by_id?id=6e9f3d2e-a37d49ab-9369-3bb1474839b4&quot; -H &quot;accept: application\/json&quot; -H \u201capi-key: 3uoUPTpZ9pEquHMho6ynvqNRvLHY2aJZ4gglGAHGJWs=&quot; Handling Authentication Errors The API returns error codes to help you troubleshoot authentication issues: 401 Unauthorized: Your key is missing, expired, or invalid. 403 Forbidden: Your key doesn\u2019t have the right permissions. API Endpoints Lists all alarms of all devices in the tenant. &gt; API Request GET https:\/\/tenant_url\/api\/v1\/alarms?request_parameters Request Parameters &gt; Optional Parameters: page_number: Number of the page to view field_to_orderd: Field to order results by. order: Sorting order of the results. tenant_id: Filter results by tenant_id. Only for API keys configured to access all tenants. status: Filter results by alarm status. start_date: Filter results by alarm start date. end_date: Filter results by alarm end date. Note: API Key with Read permission is required. Example API Request: GET http:\/\/ dev.giot.api.gimasi.com\/api\/v1\/alarms? page_number=1&amp;field_to_order=id&amp;order=desc&amp;status=ON&amp;start_date=20 24-11-11&amp;end_date=2024-12-11&quot; Example Response: JSON List in the following format: { &quot;items&quot;: [ &quot;confirmed_at&quot;: null, &quot;device_id&quot;: &quot;7e89800a-3a58-47f7-95e0-088497ed341a&quot;, &quot;device_name&quot;: &quot;Name FOTA Test&quot;, &quot;device_serial&quot;: &quot;901405800168258&quot;, &quot;events&quot;: [ { &quot;event&quot;: &quot;ON&quot;, &quot;inserted_at&quot;: &quot;2024-12-11T13:03:45&quot;, &quot;params&quot;: { &quot;tamper_state&quot;: &quot;INTACT&quot; } } ], &quot;id&quot;: &quot;1a87b2a4-de3c-4abe-ada1-ad12c77bfd10&quot;, &quot;inserted_at&quot;: &quot;2025-03-11T13:03:45&quot;, &quot;label&quot;: &quot;device-tamper-alarm&quot;, &quot;level&quot;: &quot;warning&quot;, &quot;params&quot;: { &quot;tamper_state&quot;: &quot;INTACT&quot; }, &quot;resolved_at&quot;: null, &quot;status&quot;: &quot;ON&quot;, &quot;triggered_at&quot;: &quot;2024-12-11T13:03:45.917377Z&quot;, &quot;type&quot;: &quot;multiple&quot;, &quot;updated_at&quot;: &quot;2024-12-11T13:03:45&quot; } [\/vc_column_text][\/vc_column][\/vc_row]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.gimasi.com\/?docs=giot-documentation\/api\/use-api\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.gimasi.com\/?docs=giot-documentation\/api\/use-api\",\"url\":\"https:\/\/www.gimasi.com\/?docs=giot-documentation\/api\/use-api\",\"name\":\"Use Cases API -\",\"isPartOf\":{\"@id\":\"https:\/\/www.gimasi.com\/#website\"},\"datePublished\":\"2025-04-01T12:50:23+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/www.gimasi.com\/?docs=giot-documentation\/api\/use-api#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.gimasi.com\/?docs=giot-documentation\/api\/use-api\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.gimasi.com\/?docs=giot-documentation\/api\/use-api#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.gimasi.com\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"GIOT Portal\",\"item\":\"https:\/\/www.gimasi.com\/?docs=giot-documentation\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"API\",\"item\":\"https:\/\/www.gimasi.com\/?docs=giot-documentation\/api\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Use Cases API\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.gimasi.com\/#website\",\"url\":\"https:\/\/www.gimasi.com\/\",\"name\":\"www2.gimasi.com\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\/\/www.gimasi.com\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.gimasi.com\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/www.gimasi.com\/#organization\",\"name\":\"Gimasi SA\",\"url\":\"https:\/\/www.gimasi.com\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.gimasi.com\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/www.gimasi.com\/wp-content\/uploads\/2025\/04\/cropped-gimasilogo.png\",\"contentUrl\":\"https:\/\/www.gimasi.com\/wp-content\/uploads\/2025\/04\/cropped-gimasilogo.png\",\"width\":170,\"height\":33,\"caption\":\"Gimasi SA\"},\"image\":{\"@id\":\"https:\/\/www.gimasi.com\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.linkedin.com\/company\/gimasi-sa\/\"]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Use Cases API -","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.gimasi.com\/?docs=giot-documentation\/api\/use-api","og_locale":"en_US","og_type":"article","og_title":"Use Cases API -","og_description":"[vc_row][vc_column][vc_column_text css=&#8221;&#8221;] To interact with the API, you\u2019ll need the generated API key. This key can be included in your requests in the following ways: Header Authentication: Add the key as a header for more secure access. Example of Header Authentication: GET https:\/\/dev.giot.api.gimasi.com\/api\/v1\/events\/by_id?id=6e9f3d2e-a37d49ab-9369-3bb1474839b4\" -H \"accept: application\/json\" -H \u201capi-key: 3uoUPTpZ9pEquHMho6ynvqNRvLHY2aJZ4gglGAHGJWs=\" Handling Authentication Errors The API returns error codes to help you troubleshoot authentication issues: 401 Unauthorized: Your key is missing, expired, or invalid. 403 Forbidden: Your key doesn\u2019t have the right permissions. API Endpoints Lists all alarms of all devices in the tenant. &gt; API Request GET https:\/\/tenant_url\/api\/v1\/alarms?request_parameters Request Parameters &gt; Optional Parameters: page_number: Number of the page to view field_to_orderd: Field to order results by. order: Sorting order of the results. tenant_id: Filter results by tenant_id. Only for API keys configured to access all tenants. status: Filter results by alarm status. start_date: Filter results by alarm start date. end_date: Filter results by alarm end date. Note: API Key with Read permission is required. Example API Request: GET http:\/\/ dev.giot.api.gimasi.com\/api\/v1\/alarms? page_number=1&amp;field_to_order=id&amp;order=desc&amp;status=ON&amp;start_date=20 24-11-11&amp;end_date=2024-12-11\" Example Response: JSON List in the following format: { \"items\": [ \"confirmed_at\": null, \"device_id\": \"7e89800a-3a58-47f7-95e0-088497ed341a\", \"device_name\": \"Name FOTA Test\", \"device_serial\": \"901405800168258\", \"events\": [ { \"event\": \"ON\", \"inserted_at\": \"2024-12-11T13:03:45\", \"params\": { \"tamper_state\": \"INTACT\" } } ], \"id\": \"1a87b2a4-de3c-4abe-ada1-ad12c77bfd10\", \"inserted_at\": \"2025-03-11T13:03:45\", \"label\": \"device-tamper-alarm\", \"level\": \"warning\", \"params\": { \"tamper_state\": \"INTACT\" }, \"resolved_at\": null, \"status\": \"ON\", \"triggered_at\": \"2024-12-11T13:03:45.917377Z\", \"type\": \"multiple\", \"updated_at\": \"2024-12-11T13:03:45\" } [\/vc_column_text][\/vc_column][\/vc_row]","og_url":"https:\/\/www.gimasi.com\/?docs=giot-documentation\/api\/use-api","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/www.gimasi.com\/?docs=giot-documentation\/api\/use-api","url":"https:\/\/www.gimasi.com\/?docs=giot-documentation\/api\/use-api","name":"Use Cases API -","isPartOf":{"@id":"https:\/\/www.gimasi.com\/#website"},"datePublished":"2025-04-01T12:50:23+00:00","breadcrumb":{"@id":"https:\/\/www.gimasi.com\/?docs=giot-documentation\/api\/use-api#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.gimasi.com\/?docs=giot-documentation\/api\/use-api"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.gimasi.com\/?docs=giot-documentation\/api\/use-api#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.gimasi.com\/"},{"@type":"ListItem","position":2,"name":"GIOT Portal","item":"https:\/\/www.gimasi.com\/?docs=giot-documentation"},{"@type":"ListItem","position":3,"name":"API","item":"https:\/\/www.gimasi.com\/?docs=giot-documentation\/api"},{"@type":"ListItem","position":4,"name":"Use Cases API"}]},{"@type":"WebSite","@id":"https:\/\/www.gimasi.com\/#website","url":"https:\/\/www.gimasi.com\/","name":"www2.gimasi.com","description":"","publisher":{"@id":"https:\/\/www.gimasi.com\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.gimasi.com\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/www.gimasi.com\/#organization","name":"Gimasi SA","url":"https:\/\/www.gimasi.com\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.gimasi.com\/#\/schema\/logo\/image\/","url":"https:\/\/www.gimasi.com\/wp-content\/uploads\/2025\/04\/cropped-gimasilogo.png","contentUrl":"https:\/\/www.gimasi.com\/wp-content\/uploads\/2025\/04\/cropped-gimasilogo.png","width":170,"height":33,"caption":"Gimasi SA"},"image":{"@id":"https:\/\/www.gimasi.com\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.linkedin.com\/company\/gimasi-sa\/"]}]}},"uagb_featured_image_src":{"full":false,"thumbnail":false,"medium":false,"medium_large":false,"large":false,"1536x1536":false,"2048x2048":false},"uagb_author_info":{"display_name":"admin","author_link":"https:\/\/www.gimasi.com\/?author=0"},"uagb_comment_info":0,"uagb_excerpt":"[vc_row][vc_column][vc_column_text css=\\&#8221;\\&#8221;] To interact with the API, you\u2019ll need the generated API key. This key can be included in your requests in the following ways: Header Authentication: Add the key as a header for more secure access. Example of Header Authentication: GET https:\/\/dev.giot.api.gimasi.com\/api\/v1\/events\/by_id?id=6e9f3d2e-a37d49ab-9369-3bb1474839b4\\\" -H \\\"accept: application\/json\\\" -H \u201capi-key: 3uoUPTpZ9pEquHMho6ynvqNRvLHY2aJZ4gglGAHGJWs=\\\" Handling Authentication Errors The API returns&hellip;","comment_count":0,"_links":{"self":[{"href":"https:\/\/www.gimasi.com\/index.php?rest_route=\/wp\/v2\/docs\/317","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.gimasi.com\/index.php?rest_route=\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/www.gimasi.com\/index.php?rest_route=\/wp\/v2\/types\/docs"}],"replies":[{"embeddable":true,"href":"https:\/\/www.gimasi.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=317"}],"version-history":[{"count":0,"href":"https:\/\/www.gimasi.com\/index.php?rest_route=\/wp\/v2\/docs\/317\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/www.gimasi.com\/index.php?rest_route=\/wp\/v2\/docs\/314"}],"next":[{"title":"API RESTFul","link":"https:\/\/www.gimasi.com\/?docs=giot-documentation\/api\/api-restful","href":"https:\/\/www.gimasi.com\/index.php?rest_route=\/wp\/v2\/docs\/454"}],"wp:attachment":[{"href":"https:\/\/www.gimasi.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=317"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/www.gimasi.com\/index.php?rest_route=%2Fwp%2Fv2%2Fdoc_tag&post=317"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}