openapi: 3.0.3 info: description: Provides a set of endpoints to manage Devices, Things, Properties and Timeseries title: Arduino IoT Cloud binaries_v2 dashboards_v2 API version: '2.0' tags: - name: dashboards_v2 paths: /iot/v2/dashboards: get: description: Returns the list of dashboards operationId: dashboards_v2#list parameters: - description: The name of the dashboard in: query name: name schema: maxLength: 64 pattern: '[a-zA-Z0-9_.@-]+' type: string - description: The thing_id of the dashboard's properties in: query name: thing_id schema: type: string - description: The user_id of the dashboard's owner in: query name: user_id schema: type: string - in: header name: X-Organization schema: type: string responses: '200': content: application/vnd.arduino.dashboardv2+json; type=collection: schema: $ref: '#/components/schemas/ArduinoDashboardv2Collection' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/ArduinoDashboardv2Collection' description: OK '400': content: application/vnd.arduino.dashboardv2+json; type=collection: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Bad Request '401': content: application/vnd.arduino.dashboardv2+json; type=collection: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Unauthorized '403': content: application/vnd.arduino.dashboardv2+json; type=collection: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Forbidden '500': content: application/vnd.arduino.dashboardv2+json; type=collection: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Internal Server Error security: - oauth2: [] summary: list dashboards_v2 tags: - dashboards_v2 post: description: Create a new dashboard operationId: dashboards_v2#create parameters: - in: header name: X-Organization schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/dashboardv2' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/dashboardv2' description: DashboardV2Payload describes a dashboard required: true x-originalParamName: payload responses: '201': content: application/vnd.arduino.dashboardv2+json: schema: $ref: '#/components/schemas/ArduinoDashboardv2' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/ArduinoDashboardv2' description: Created '400': content: application/vnd.arduino.dashboardv2+json: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Bad Request '401': content: application/vnd.arduino.dashboardv2+json: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Unauthorized '403': content: application/vnd.arduino.dashboardv2+json: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Forbidden '500': content: application/vnd.arduino.dashboardv2+json: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Internal Server Error security: - oauth2: [] summary: create dashboards_v2 tags: - dashboards_v2 /iot/v2/dashboards/{id}: delete: description: Delete a dashboard operationId: dashboards_v2#delete parameters: - description: If true, hard delete the thing in: query name: force schema: default: false type: boolean - description: The id of the dashboard in: path name: id required: true schema: type: string - in: header name: X-Organization schema: type: string responses: '200': description: OK '400': content: application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' text/plain: schema: $ref: '#/components/schemas/error' description: Bad Request '401': content: application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' text/plain: schema: $ref: '#/components/schemas/error' description: Unauthorized '403': content: application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' text/plain: schema: $ref: '#/components/schemas/error' description: Forbidden '404': description: Not Found '500': content: application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' text/plain: schema: $ref: '#/components/schemas/error' description: Internal Server Error security: - oauth2: [] summary: delete dashboards_v2 tags: - dashboards_v2 get: description: Show a dashboard operationId: dashboards_v2#show parameters: - description: The id of the dashboard in: path name: id required: true schema: type: string - in: header name: X-Organization schema: type: string responses: '200': content: application/vnd.arduino.dashboardv2+json: schema: $ref: '#/components/schemas/ArduinoDashboardv2' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/ArduinoDashboardv2' description: OK '401': content: application/vnd.arduino.dashboardv2+json: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Unauthorized '403': content: application/vnd.arduino.dashboardv2+json: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Forbidden '404': description: Not Found '500': content: application/vnd.arduino.dashboardv2+json: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Internal Server Error security: - oauth2: [] summary: show dashboards_v2 tags: - dashboards_v2 patch: description: Updates an existing dashboard field without overwriting the existing data operationId: dashboards_v2#patch parameters: - description: The id of the dashboard in: path name: id required: true schema: type: string - in: header name: X-Organization schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/dashboardv2' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/dashboardv2' description: DashboardV2Payload describes a dashboard required: true x-originalParamName: payload responses: '200': content: application/vnd.arduino.dashboardv2+json: schema: $ref: '#/components/schemas/ArduinoDashboardv2' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/ArduinoDashboardv2' description: OK '400': content: application/vnd.arduino.dashboardv2+json: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Bad Request '401': content: application/vnd.arduino.dashboardv2+json: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Unauthorized '403': content: application/vnd.arduino.dashboardv2+json: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Forbidden '404': description: Not Found '500': content: application/vnd.arduino.dashboardv2+json: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Internal Server Error security: - oauth2: [] summary: patch dashboards_v2 tags: - dashboards_v2 put: description: Updates an existing dashboard operationId: dashboards_v2#update parameters: - description: The id of the dashboard in: path name: id required: true schema: type: string - in: header name: X-Organization schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/dashboardv2' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/dashboardv2' description: DashboardV2Payload describes a dashboard required: true x-originalParamName: payload responses: '200': content: application/vnd.arduino.dashboardv2+json: schema: $ref: '#/components/schemas/ArduinoDashboardv2' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/ArduinoDashboardv2' description: OK '400': content: application/vnd.arduino.dashboardv2+json: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Bad Request '401': content: application/vnd.arduino.dashboardv2+json: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Unauthorized '403': content: application/vnd.arduino.dashboardv2+json: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Forbidden '404': description: Not Found '500': content: application/vnd.arduino.dashboardv2+json: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Internal Server Error security: - oauth2: [] summary: update dashboards_v2 tags: - dashboards_v2 /iot/v2/dashboards/{id}/clone: put: description: Clone an existing dashboard operationId: dashboards_v2#clone parameters: - description: The id of the dashboard in: path name: id required: true schema: type: string - in: header name: X-Organization schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/clone' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/clone' required: true x-originalParamName: payload responses: '201': content: application/vnd.arduino.dashboardv2+json: schema: $ref: '#/components/schemas/ArduinoDashboardv2' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/ArduinoDashboardv2' description: Created '400': content: application/vnd.arduino.dashboardv2+json: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Bad Request '401': content: application/vnd.arduino.dashboardv2+json: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Unauthorized '403': content: application/vnd.arduino.dashboardv2+json: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Forbidden '404': description: Not Found '500': content: application/vnd.arduino.dashboardv2+json: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Internal Server Error security: - oauth2: [] summary: clone dashboards_v2 tags: - dashboards_v2 /iot/v2/dashboards/{id}/share_request: put: description: Request access to a dashboard operationId: dashboards_v2#requestAccess parameters: - description: The id of the dashboard in: path name: id required: true schema: type: string - in: header name: X-Organization schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/sharerequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/sharerequest' required: true x-originalParamName: payload responses: '200': description: OK '400': content: application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' text/plain: schema: $ref: '#/components/schemas/error' description: Bad Request '401': content: application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' text/plain: schema: $ref: '#/components/schemas/error' description: Unauthorized '403': content: application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' text/plain: schema: $ref: '#/components/schemas/error' description: Forbidden '404': description: Not Found '500': content: application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' text/plain: schema: $ref: '#/components/schemas/error' description: Internal Server Error security: - oauth2: [] summary: requestAccess dashboards_v2 tags: - dashboards_v2 /iot/v2/dashboards/{id}/shares: get: description: List of users the dashboard has been shared with operationId: dashboards_v2#listShares parameters: - description: The id of the dashboard in: path name: id required: true schema: type: string - in: header name: X-Organization schema: type: string responses: '200': content: application/vnd.arduino.dashboardshare+json; type=collection: schema: $ref: '#/components/schemas/ArduinoDashboardshareCollection' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/ArduinoDashboardshareCollection' description: OK '400': content: application/vnd.arduino.dashboardshare+json; type=collection: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Bad Request '401': content: application/vnd.arduino.dashboardshare+json; type=collection: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Unauthorized '403': content: application/vnd.arduino.dashboardshare+json; type=collection: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Forbidden '404': description: Not Found '500': content: application/vnd.arduino.dashboardshare+json; type=collection: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Internal Server Error security: - oauth2: [] summary: listShares dashboards_v2 tags: - dashboards_v2 put: description: Share a dashboard operationId: dashboards_v2#share parameters: - description: The id of the dashboard in: path name: id required: true schema: type: string - in: header name: X-Organization schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/dashboardshare' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/dashboardshare' required: true x-originalParamName: payload responses: '200': description: OK '400': content: application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' text/plain: schema: $ref: '#/components/schemas/error' description: Bad Request '401': content: application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' text/plain: schema: $ref: '#/components/schemas/error' description: Unauthorized '403': content: application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' text/plain: schema: $ref: '#/components/schemas/error' description: Forbidden '404': description: Not Found '500': content: application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' text/plain: schema: $ref: '#/components/schemas/error' description: Internal Server Error security: - oauth2: [] summary: share dashboards_v2 tags: - dashboards_v2 /iot/v2/dashboards/{id}/shares/{user_id}: delete: description: Delete a user the dashboard has been shared with operationId: dashboards_v2#deleteShare parameters: - description: The id of the dashboard in: path name: id required: true schema: type: string - description: The id of the user in: path name: user_id required: true schema: type: string - in: header name: X-Organization schema: type: string responses: '200': description: OK '400': content: application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' text/plain: schema: $ref: '#/components/schemas/error' description: Bad Request '401': content: application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' text/plain: schema: $ref: '#/components/schemas/error' description: Unauthorized '403': content: application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' text/plain: schema: $ref: '#/components/schemas/error' description: Forbidden '404': description: Not Found '500': content: application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' text/plain: schema: $ref: '#/components/schemas/error' description: Internal Server Error security: - oauth2: [] summary: deleteShare dashboards_v2 tags: - dashboards_v2 /iot/v2/dashboards/{id}/template: get: description: Get a template of the dashboard operationId: dashboards_v2#template parameters: - description: The id of the dashboard in: path name: id required: true schema: type: string - in: header name: X-Organization schema: type: string responses: '200': content: application/vnd.arduino.dashboardv2template+json: schema: $ref: '#/components/schemas/ArduinoDashboardv2template' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/ArduinoDashboardv2template' description: OK '400': content: application/vnd.arduino.dashboardv2template+json: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Bad Request '401': content: application/vnd.arduino.dashboardv2template+json: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Unauthorized '403': content: application/vnd.arduino.dashboardv2template+json: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Forbidden '404': description: Not Found '500': content: application/vnd.arduino.dashboardv2template+json: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Internal Server Error security: - oauth2: [] summary: template dashboards_v2 tags: - dashboards_v2 /iot/v2/dashboards/{id}/widgets/{widgetId}/variables: put: description: Link or detach widget variables operationId: dashboards_v2#link parameters: - description: The id of the dashboard in: path name: id required: true schema: type: string - description: The id of the widget in: path name: widgetId required: true schema: type: string - in: header name: X-Organization schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/widgetlink' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/widgetlink' required: true x-originalParamName: payload responses: '200': content: application/vnd.arduino.variableslinks+json: schema: $ref: '#/components/schemas/ArduinoVariableslinks' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/ArduinoVariableslinks' description: OK '400': content: application/vnd.arduino.variableslinks+json: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Bad Request '401': content: application/vnd.arduino.variableslinks+json: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Unauthorized '403': content: application/vnd.arduino.variableslinks+json: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Forbidden '404': description: Not Found '500': content: application/vnd.arduino.variableslinks+json: schema: $ref: '#/components/schemas/error' application/vnd.goa.error+json: schema: $ref: '#/components/schemas/error' description: Internal Server Error security: - oauth2: [] summary: link dashboards_v2 tags: - dashboards_v2 components: schemas: ArduinoWidgetv2templateCollection: description: ArduinoWidgetv2templateCollection is the media type for an array of ArduinoWidgetv2template (default view) items: $ref: '#/components/schemas/ArduinoWidgetv2template' title: 'Mediatype identifier: application/vnd.arduino.widgetv2template+json; type=collection; view=default' type: array ArduinoTimezone: description: ArduinoTimezone media type (default view) properties: name: description: Name of the time zone. type: string offset: description: Current UTC DST offset in seconds. format: int64 type: integer until: description: Date until the offset is valid. format: date-time type: string required: - name - offset - until title: 'Mediatype identifier: application/vnd.arduino.timezone+json; view=default' type: object ArduinoDashboardshareCollection: description: ArduinoDashboardshareCollection is the media type for an array of ArduinoDashboardshare (default view) items: $ref: '#/components/schemas/ArduinoDashboardshare' title: 'Mediatype identifier: application/vnd.arduino.dashboardshare+json; type=collection; view=default' type: array dashboardshare: properties: user_id: description: The userID of the user you want to share the dashboard with format: uuid type: string username: description: The username of the user you want to share the dashboard with type: string users: description: The list of users you want to share the dashboard with items: $ref: '#/components/schemas/usershare' type: array title: dashboardshare type: object ArduinoTemplatevariableCollection: description: ArduinoTemplatevariableCollection is the media type for an array of ArduinoTemplatevariable (default view) items: $ref: '#/components/schemas/ArduinoTemplatevariable' title: 'Mediatype identifier: application/vnd.arduino.templatevariable+json; type=collection; view=default' type: array ArduinoWidgetv2template: description: ArduinoWidgetv2template media type (default view) properties: height: description: Widget current height for desktop format: int64 type: integer height_mobile: description: Widget current height for mobile format: int64 type: integer name: description: The name of the widget type: string options: additionalProperties: true description: Widget options type: object type: description: The type of the widget type: string variables: $ref: '#/components/schemas/ArduinoTemplatevariableCollection' width: description: Widget current width for desktop format: int64 type: integer width_mobile: description: Widget current width for mobile format: int64 type: integer x: description: Widget x position for desktop format: int64 type: integer x_mobile: description: Widget x position for mobile format: int64 type: integer y: description: Widget y position for desktop format: int64 type: integer y_mobile: description: Widget y position for mobile format: int64 type: integer required: - type - width - height - x - y - options title: 'Mediatype identifier: application/vnd.arduino.widgetv2template+json; view=default' type: object ArduinoLinkedvariableCollection: description: ArduinoLinkedvariableCollection is the media type for an array of ArduinoLinkedvariable (default view) items: $ref: '#/components/schemas/ArduinoLinkedvariable' title: 'Mediatype identifier: application/vnd.arduino.linkedvariable+json; type=collection; view=default' type: array ArduinoDashboardv2: description: Dashboard is a collection of widgets (default view) properties: cover_image: description: The cover image of the dashboard maxLength: 1024 type: string created_by: $ref: '#/components/schemas/ArduinoDashboardowner' id: description: The friendly name of the dashboard format: uuid type: string name: description: The friendly name of the dashboard type: string organization_id: description: Id of the organization the dashboard belongs to format: uuid type: string shared_by: $ref: '#/components/schemas/ArduinoDashboardshare' shared_with: $ref: '#/components/schemas/ArduinoDashboardshareCollection' updated_at: description: Last update date format: date-time type: string widgets: $ref: '#/components/schemas/ArduinoWidgetv2Collection' required: - id - name - updated_at title: 'Mediatype identifier: application/vnd.arduino.dashboardv2+json; view=default' type: object widget: description: Widget describes a dashboard widget properties: height: description: Widget current height for desktop format: int64 type: integer height_mobile: description: Widget current height for mobile format: int64 type: integer id: description: The UUID of the widget, set by client format: uuid type: string name: description: The name of the widget type: string options: additionalProperties: true description: Widget options type: object type: description: The type of the widget type: string variables: items: format: uuid type: string type: array width: description: Widget current width for desktop format: int64 type: integer width_mobile: description: Widget current width for mobile format: int64 type: integer x: description: Widget x position for desktop format: int64 type: integer x_mobile: description: Widget x position for mobile format: int64 type: integer y: description: Widget y position for desktop format: int64 type: integer y_mobile: description: Widget y position for mobile format: int64 type: integer required: - id - type - width - height - x - y - options title: widget type: object usershare: properties: user_id: description: The userID of the user you want to share the dashboard with format: uuid type: string username: description: The username of the user you want to share the dashboard with type: string title: usershare type: object ArduinoVariableslinks: description: ArduinoVariableslinks media type (default view) properties: variables: description: The ids of the linked variables items: format: uuid type: string type: array required: - variables title: 'Mediatype identifier: application/vnd.arduino.variableslinks+json; view=default' type: object widgetlink: properties: variables: items: format: uuid type: string type: array title: widgetlink type: object ArduinoWidgetv2Collection: description: ArduinoWidgetv2Collection is the media type for an array of ArduinoWidgetv2 (default view) items: $ref: '#/components/schemas/ArduinoWidgetv2' title: 'Mediatype identifier: application/vnd.arduino.widgetv2+json; type=collection; view=default' type: array override: properties: new_thing_id: description: The id of the new thing to link format: uuid type: string old_thing_id: description: The id of the thing to override format: uuid type: string required: - old_thing_id - new_thing_id title: override type: object ArduinoDashboardv2Collection: description: ArduinoDashboardv2Collection is the media type for an array of ArduinoDashboardv2 (default view) items: $ref: '#/components/schemas/ArduinoDashboardv2' title: 'Mediatype identifier: application/vnd.arduino.dashboardv2+json; type=collection; view=default' type: array ArduinoTemplatevariable: description: ArduinoTemplatevariable media type (default view) properties: name: description: The name of the variable type: string permission: description: The permission of the linked variable type: string thing_id: description: The name of the related thing type: string thing_timezone: $ref: '#/components/schemas/ArduinoTimezone' type: description: The type of the variable type: string variable_id: description: The name of the variable in the code type: string required: - name - variable_id - thing_id - type - permission title: 'Mediatype identifier: application/vnd.arduino.templatevariable+json; view=default' type: object dashboardv2: description: DashboardV2Payload describes a dashboard properties: cover_image: description: The cover image of the dashboard maxLength: 1024 type: string name: description: The friendly name of the dashboard maxLength: 64 pattern: '[a-zA-Z0-9_.@-]+' type: string soft_deleted: default: false description: If false, restore the thing from the soft deletion type: boolean widgets: description: Widgets attached to this dashboard items: $ref: '#/components/schemas/widget' type: array title: dashboardv2 type: object ArduinoDashboardv2template: description: ArduinoDashboardv2template media type (default view) properties: cover_image: description: The cover image of the dashboard type: string id: description: The friendly ID of the dashboard type: string name: description: The friendly name of the dashboard type: string widgets: $ref: '#/components/schemas/ArduinoWidgetv2templateCollection' required: - name title: 'Mediatype identifier: application/vnd.arduino.dashboardv2template+json; view=default' type: object error: description: Error response media type (default view) properties: code: description: an application-specific error code, expressed as a string value. example: invalid_value type: string detail: description: a human-readable explanation specific to this occurrence of the problem. example: Value of ID must be an integer type: string id: description: a unique identifier for this particular occurrence of the problem. example: 3F1FKVRR type: string meta: additionalProperties: true description: a meta object containing non-standard meta-information about the error. example: timestamp: 1458609066 type: object status: description: the HTTP status code applicable to this problem, expressed as a string value. example: '400' type: string title: 'Mediatype identifier: application/vnd.goa.error+json; view=default' type: object sharerequest: properties: message: description: The message the user want to send to the dashboard owner type: string title: sharerequest type: object ArduinoLinkedvariable: description: ArduinoLinkedvariable media type (default view) properties: id: description: The id of the linked variable format: uuid type: string last_value: description: Last value of the linked property last_value_updated_at: description: Update date of the last value format: date-time type: string name: description: The name of the variable type: string permission: description: The permission of the linked variable type: string thing_id: description: The id of the related thing format: uuid type: string thing_name: description: The name of the related thing type: string thing_timezone: $ref: '#/components/schemas/ArduinoTimezone' type: description: The type of the variable type: string variable_name: description: The name of the variable in the code type: string required: - id - name - variable_name - thing_id - thing_name - type - permission title: 'Mediatype identifier: application/vnd.arduino.linkedvariable+json; view=default' type: object ArduinoWidgetv2: description: ArduinoWidgetv2 media type (default view) properties: has_permission_incompatibility: description: True if the linked variables permissions are incompatible with the widget type: boolean has_type_incompatibility: description: True if the linked variables types are incompatible with the widget type: boolean has_unlinked_variable: description: If it's true the widget is linked to a soft-deleted variable type: boolean height: description: Widget current height for desktop format: int64 type: integer height_mobile: description: Widget current height for mobile format: int64 type: integer id: description: The UUID of the widget, set by client format: uuid type: string name: description: The name of the widget type: string options: additionalProperties: true description: Widget options type: object type: description: The type of the widget type: string variables: $ref: '#/components/schemas/ArduinoLinkedvariableCollection' width: description: Widget current width for desktop format: int64 type: integer width_mobile: description: Widget current width for mobile format: int64 type: integer x: description: Widget x position for desktop format: int64 type: integer x_mobile: description: Widget x position for mobile format: int64 type: integer y: description: Widget y position for desktop format: int64 type: integer y_mobile: description: Widget y position for mobile format: int64 type: integer required: - id - type - width - height - x - y - options title: 'Mediatype identifier: application/vnd.arduino.widgetv2+json; view=default' type: object ArduinoDashboardowner: description: ArduinoDashboardowner media type (default view) properties: user_id: description: The userID of the user who created the dashboard format: uuid type: string username: description: The username of the user who created the dashboard type: string required: - user_id title: 'Mediatype identifier: application/vnd.arduino.dashboardowner+json; view=default' type: object ArduinoDashboardshare: description: ArduinoDashboardshare media type (default view) properties: user_id: description: The userID of the user you want to share the dashboard with format: uuid type: string username: description: The username of the user you want to share the dashboard with type: string required: - user_id title: 'Mediatype identifier: application/vnd.arduino.dashboardshare+json; view=default' type: object clone: properties: overrides: description: 'The overrides to apply to the cloned dashboard. An override is a tuple of ids: the id of the thing to override and the id of the new thing to link' items: $ref: '#/components/schemas/override' type: array title: clone type: object externalDocs: description: See docs on Confluence url: https://arduino.atlassian.net/wiki/spaces/FTWEB/pages/91160610/Arduino+IoT+Cloud