openapi: 3.0.3
info:
  description: Provides a set of endpoints to manage Devices, Things, Properties and Timeseries
  title: Arduino IoT Cloud binaries_v2 compact_dashboards_v2 API
  version: '2.0'
tags:
- name: compact_dashboards_v2
paths:
  /iot/v2/compact_dashboards:
    get:
      description: Returns the list of dashboards with basic information only
      operationId: compact_dashboards_v2#listCompact
      parameters:
      - description: Filter by deletion date
        in: query
        name: deleted_after
        schema:
          type: string
      - description: If true, shows the extended information of the dashboard
        in: query
        name: extended
        schema:
          default: false
          type: boolean
      - description: Filter only the desired dashboards
        in: query
        name: ids
        schema:
          items:
            type: string
          type: array
      - description: The name of the dashboard
        in: query
        name: name_filter
        schema:
          maxLength: 64
          pattern: '[a-zA-Z0-9_.@-]+'
          type: string
      - description: If true, shows the soft deleted things
        in: query
        name: show_deleted
        schema:
          default: false
          type: boolean
      - in: header
        name: X-Organization
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.arduino.compact_dashboard_v2+json; type=collection:
              schema:
                $ref: '#/components/schemas/ArduinoCompact_dashboard_v2Collection'
            application/vnd.goa.error+json:
              schema:
                $ref: '#/components/schemas/ArduinoCompact_dashboard_v2Collection'
          description: OK
        '400':
          content:
            application/vnd.arduino.compact_dashboard_v2+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.compact_dashboard_v2+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.compact_dashboard_v2+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.compact_dashboard_v2+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: listCompact compact_dashboards_v2
      tags:
      - compact_dashboards_v2
components:
  schemas:
    ArduinoCompact_dashboard_v2:
      description: Dashboard is a collection of widgets (default view)
      properties:
        cover_image:
          description: The cover image of the dashboard
          maxLength: 1024
          type: string
        created_at:
          description: Creation date
          format: date-time
          type: string
        deleted_at:
          description: Delete date
          format: date-time
          type: string
        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
        pages:
          $ref: '#/components/schemas/ArduinoPageCollection'
        shared_by:
          $ref: '#/components/schemas/ArduinoDashboardshare'
        shared_with:
          $ref: '#/components/schemas/ArduinoDashboardshareCollection'
        updated_at:
          description: Last update date
          format: date-time
          type: string
        user_id:
          description: The user id of the owner
          format: uuid
          type: string
      required:
      - id
      - name
      - user_id
      title: 'Mediatype identifier: application/vnd.arduino.compact_dashboard_v2+json; view=default'
      type: object
    ArduinoPageCollection:
      description: ArduinoPageCollection is the media type for an array of ArduinoPage (default view)
      items:
        $ref: '#/components/schemas/ArduinoPage'
      title: 'Mediatype identifier: application/vnd.arduino.page+json; type=collection; view=default'
      type: array
    ArduinoCompact_dashboard_v2Collection:
      description: ArduinoCompact_dashboard_v2Collection is the media type for an array of ArduinoCompact_dashboard_v2 (default view)
      items:
        $ref: '#/components/schemas/ArduinoCompact_dashboard_v2'
      title: 'Mediatype identifier: application/vnd.arduino.compact_dashboard_v2+json; type=collection; view=default'
      type: array
    ArduinoPage:
      description: Page describes a dashboard page (default view)
      properties:
        icon:
          description: The icon of the Page
          type: string
        id:
          description: The id of the Page
          type: string
        name:
          description: The name of the Page
          type: string
        position:
          description: The position of the Page
          format: int64
          type: integer
      required:
      - id
      - name
      - position
      title: 'Mediatype identifier: application/vnd.arduino.page+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
    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
    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
externalDocs:
  description: See docs on Confluence
  url: https://arduino.atlassian.net/wiki/spaces/FTWEB/pages/91160610/Arduino+IoT+Cloud