api v9.1.19

changelog/tagoio-api/2026-01-07-v9-1-17.md

@@ -0,0 +1,19 @@
+---
+title: "TagoIO API v9.1.17"
+description: "Introduced a full Profile Backup system for disaster recovery, allowing customers to backup and restore all resources and files of the profile."
+slug: "/tagoio-api/v9-1-17"
+product: "tagoio-api"
+version: "v9.1.17"
+---
+
+## Highlights
+
+- Introduced a full Profile Backup system for disaster recovery, allowing customers to backup and restore all resources and files of the profile.
+
+## Breaking Changes
+
+- None
+
+## Upgrade Notes
+
+- No special actions required

changelog/tagoio-api/2026-01-14-v9-1-19.md

@@ -0,0 +1,19 @@
+---
+title: "TagoIO API v9.1.19"
+description: "Introduced Entity Data Export."
+slug: "/tagoio-api/v9-1-19"
+product: "tagoio-api"
+version: "v9.1.19"
+---
+
+## Highlights
+
+- Introduced Entity Data Export.
+
+## Breaking Changes
+
+- None
+
+## Upgrade Notes
+
+- No special actions required

docs/api/export-entity-data.api.mdx

@@ -0,0 +1,72 @@
+---
+id: export-entity-data
+title: "Export Entity Data"
+description: "Export data from the entity to a file in the Files."
+sidebar_label: "Export Entity Data"
+hide_title: true
+hide_table_of_contents: true
+api: eJy1V21v2zYQ/isE+6GbIdmJY+dFHwpkTbYFK9ogLyiG2GjP4tliI5MqSdkxDP/34UjJluKmK4bOX2xLx7vnHj53PK65g5nlyQO/VE66FbsAB3wccYE2NbJwUiue8MunQhvHBDhgU6PnzGXIMKxwmgGbyhyZVP757zJH2x0pHnFdoAHycSV4wtF7CYF8nIgXYGCODg1hWHMFcyRDb/JJCh5xSfELcBmPuMGvpTQoeOJMiRG3aYZz4Mmau1VBC60zUs34Zg9/gHp1wTfj4Aat+02LFa1NtXKoHP2Eoshl6hH3vlhaut4PoidfMHUE3lB+TqKlt0TBJxDCoLX7kCKOTzAvcnrUm68+EZW9QEg3tQv+HPE1uKxFKPFsYYGB+rCQEs0QhKdvG3GidY6gmiEDXe0IHzN0GRryK1WalwJZ5auOu42yaVL/0M50vNmE97bQygYq+gcH9PUtDUk18zLi0c/i3aAtc/d/749P0jpw5Q9QvQmfiM/RZZqkX2jrEZGOE94LAu+tt0Lf9HzACaSPZcEjbtEs6qIoTc4TnjlX2KTXg0J2SxvjYdfBTHel5pvoWzZYxsuGzZh8pqWRbuWdXhtNhNzpR1Q8eRg3DW6J+UDaBS5kinFlts0bCvkXrvZEe86a9sxl4Ji0rFTya4kktJUuDRPepsv+QEXdARkw5+0nKwZpitaSSLxpcPfasgJm2OVR3SBasKoeEcTLI/4U77ZyiIf9o8EQYnFyAPEA+yKenB6JeJge+BfHJ6dnVEXv0S21efzxRKsF7LuZVkZddu7TYlfK4Sw0RMvebH28CV58ic+ekzLVpu1sx8JL6V9IW+Sweh+s2qm16ZmK4eAMRD8+PTxK44E4Po4n05N+PDw4xeHk7BSmeET0VGr5cXqqBVUOL9BD6jfIimDbEIRUwQDSVJfKMYuOGodt5N5G9D0JwOEQYYgQC9EX8SA9PopPzwbD+Kw/GQ4EDE5O+uBbHDWem93RcFl7eN46Xujf20bsOwAhmmpPlXQexx3M9NUHdn59tcfXq1evXrFO50+9JG5KS01eWiZ0Ws5ROS+YTmek7jJsPyRSbZFLR7WzzGSaVYyvdPnaIKu7du22auzVAdhlbKQqWIXRCynQsgETcjpFg8oFXzYZqZh1Os2a63QSRmAqidJE0CjtqIKy0iVLQbEZut3UIFolPVKMEQoK0NpSinCeW80elV4ysFRCpIXwtsv+1uXOr49dyWgrlv0ArUqgAFfWQ3qexbZsP6h8xWABMocJzTfTmle9VGiYnvrlqirjWrWyWeV7IM4V5CsrbUCRdDrfJBIqq6gZPmxe/ap2HcfxSHkF3YbMvdX59RW7VKLQUjl2gzOp1Uh9zFCxOTySEdQqIG3Qip0+I79z89I6BrQFtsBUTlchekGnqpFUpsa7hZxhFajL3mZaW2RaYc3OVOe5XlLE2sqyCVgUTFd8zVDPDBSZTCGvfCYjFdi6V9KhYLcOHFp2CdaxQ+KMBUrv61KpfbNlhnXz2M0UVCYhZj3ZgHVoFGu579ZeO537m3cU5fOLh27vc3NPL0uaNNhH/AnwyAlBCz7/BVPrkCdMAQ9tJbvAIterLRoqGJvpMhe+E3gMeqm8UO5v3m17dEtv4RDWc5DKMoupR1ttLAUJMagt07QSmtlh96B7UI13kNJgRs2VBqA5+LOj6uDVnaJ573jWFxuj+X++gVQHlcMn1ytykIqOMz8tratp7KG6bvCIJ82LRzWlViPZOOIZzXDJA1+vabPuTb7Z0OOvJRqaqcYRX4CRRJ2fsIS09FvwZAq5fT5+N3P75aZq07+y3UXlBej1wasI7wLykv7xiD/iqnVx2oy3dwOPJrx/G2LGd+Rlt35v/KaRMqygyaVw37UdN+bc6w+3d0RadbWaa0FrDCzp9gbLgFV7DsLwTs/WPAc1K2FGtsEnff4BI+/+uQ==
+sidebar_class_name: "post api-method"
+info_path: docs/api/tagoio-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+
+<Heading
+  as={"h1"}
+  className={"openapi__heading"}
+  children={"Export Entity Data"}
+>
+</Heading>
+
+<MethodEndpoint
+  method={"post"}
+  path={"/entity/{entity_id}/data/backup"}
+  context={"endpoint"}
+>
+
+</MethodEndpoint>
+
+
+
+Export data from the entity to a file in the Files.
+
+
+<Heading
+  id={"request"}
+  as={"h2"}
+  className={"openapi-tabs__heading"}
+  children={"Request"}
+>
+</Heading>
+
+<ParamsDetails
+  parameters={[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string"},"description":"Entity ID"}]}
+>
+
+</ParamsDetails>
+
+<RequestSchema
+  title={"Body"}
+  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"file_address":{"type":"string","example":"/my_data/export.csv","description":"Path in the Files to save the export."},"headers":{"type":"boolean","example":true,"description":"Whether to include headers in the export."}},"required":["file_address"]}}}}}
+>
+
+</RequestSchema>
+
+<StatusCodes
+  id={undefined}
+  label={undefined}
+  responses={{"200":{"description":"Exporting data","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"file_address":{"type":"string","example":"/my_data/export.csv"}}},"status":{"type":"boolean","example":true}}}}}}}}
+>
+
+</StatusCodes>
+
+
+

docs/api/sidebar/api-sidebar.ts

@@ -775,6 +775,12 @@ const sidebar: SidebarsConfig = {
               label: "Delete Entity Data",
               className: "api-method delete",
             },
+            {
+              type: "doc",
+              id: "api/export-entity-data",
+              label: "Export Entity Data",
+              className: "api-method post",
+            },
           ],
         },
       ],

specs/tagoio-api.yaml

@@ -4869,6 +4869,54 @@ paths:
           type: string
           example: (Type an entity ID)
     description: Entity ID
+  /entity/{entity_id}/data/backup:
+    post:
+      tags:
+        - Entity Data
+      summary: Export Entity Data
+      description: |
+        Export data from the entity to a file in the Files.
+      operationId: exportEntityData
+      parameters:
+        - name: entity_id
+          in: path
+          required: true
+          schema:
+            type: string
+          description: Entity ID
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                file_address:
+                  type: string
+                  example: /my_data/export.csv
+                  description: Path in the Files to save the export.
+                headers:
+                  type: boolean
+                  example: true
+                  description: Whether to include headers in the export.
+              required:
+                - file_address
+      responses:
+        '200':
+          description: Exporting data
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  result:
+                    type: object
+                    properties:
+                      file_address:
+                        type: string
+                        example: /my_data/export.csv
+                  status:
+                    type: boolean
+                    example: true
   /dashboard/{dashboardID}/widget/{widgetID}:
     get:
       tags: