swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Dashboards API
schemes:
- https
tags:
- name: Dashboards
paths:
  /dashboards:
    get:
      operationId: microsoftAzureDashboardsList
      summary: Microsoft Azure Get The List Of Dashboards In An Application
      x-ms-examples:
        List dashboards:
          $ref: ./examples/dashboards_list.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/Filter'
      - $ref: '#/parameters/MaxPageSize'
      - $ref: '#/parameters/OrderBy'
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DashboardCollection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      description: Needs a more full description created.
      tags:
      - Dashboards
  /dashboards/{dashboardId}:
    get:
      operationId: microsoftAzureDashboardsGet
      summary: Microsoft Azure Get A Dashboard By Id
      x-ms-examples:
        Get a dashboard by ID:
          $ref: ./examples/dashboards_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DashboardId'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Dashboard'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      description: Needs a more full description created.
      tags:
      - Dashboards
    put:
      operationId: microsoftAzureDashboardsCreate
      summary: Microsoft Azure Create A Dashboard
      x-ms-examples:
        Create or update a dashboard:
          $ref: ./examples/dashboards_create.json
        Create or update a dashboard with KPI tile:
          $ref: ./examples/dashboards_create_kpi.json
        Create or update a dashboard with LKV tile:
          $ref: ./examples/dashboards_create_lkv.json
        Create or update a dashboard with bar chart tile:
          $ref: ./examples/dashboards_create_bar.json
        Create or update a dashboard with count tile:
          $ref: ./examples/dashboards_create_count.json
        Create or update a dashboard with event history tile:
          $ref: ./examples/dashboards_create_event_history.json
        Create or update a dashboard with event tile:
          $ref: ./examples/dashboards_create_event.json
        Create or update a dashboard with heatmap chart tile:
          $ref: ./examples/dashboards_create_heatmap.json
        Create or update a dashboard with line chart tile:
          $ref: ./examples/dashboards_create_line.json
        Create or update a dashboard with map tile:
          $ref: ./examples/dashboards_create_map.json
        Create or update a dashboard with pie chart tile:
          $ref: ./examples/dashboards_create_pie.json
        Create or update a dashboard with state history tile:
          $ref: ./examples/dashboards_create_state_history.json
        Create or update a dashboard with state tile:
          $ref: ./examples/dashboards_create_state.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DashboardId'
      - in: body
        name: body
        description: Dashboard definition.
        schema:
          $ref: '#/definitions/Dashboard'
        required: true
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Dashboard'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      description: Needs a more full description created.
      tags:
      - Dashboards
    patch:
      operationId: microsoftAzureDashboardsUpdate
      summary: Microsoft Azure Update A Dashboard
      x-ms-examples:
        Update a dashboard:
          $ref: ./examples/dashboards_update.json
      consumes:
      - application/merge-patch+json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DashboardId'
      - in: body
        name: body
        description: Dashboard definition.
        schema:
          type: object
        required: true
      - $ref: '#/parameters/IfMatch'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Dashboard'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      description: Needs a more full description created.
      tags:
      - Dashboards
    delete:
      operationId: microsoftAzureDashboardsRemove
      summary: Microsoft Azure Delete A Dashboard
      x-ms-examples:
        Delete a dashboard:
          $ref: ./examples/dashboards_delete.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DashboardId'
      responses:
        '204':
          description: Success
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      description: Needs a more full description created.
      tags:
      - Dashboards
definitions:
  Dashboard:
    type: object
    properties:
      id:
        description: Unique ID of the dashboard.
        type: string
        readOnly: true
      displayName:
        description: Display name of the dashboard.
        type: string
        minLength: 1
      tiles:
        description: The tiles displayed by the dashboard.
        type: array
        items:
          $ref: '#/definitions/Tile'
        maxItems: 100
      personal:
        description: Whether the dashboard is personal and can only be viewed by the current user.
        type: boolean
        default: false
        readOnly: true
      favorite:
        description: Whether the dashboard is favorited or not
        type: boolean
        default: false
      etag:
        description: Etag to prevent conflict when updating the dashboard.
        type: string
      organizations:
        description: The organization the dashboard belongs to. If not present, the dashboard is root-level or personal. only one organization is supported today, multiple organizations will be supported soon.
        type: array
        items:
          type: string
    required:
    - displayName
  TileConfiguration:
    description: Configuration specifying information about a tile.
    type: object
    properties:
      type:
        description: The type of widget the tile renders
        type: string
    discriminator: type
    required:
    - type
  ErrorDetails:
    description: The detail information of the error.
    type: object
    properties:
      code:
        type: string
        description: Error code.
      message:
        type: string
        description: Error message details.
      requestId:
        type: string
        description: Correlation Id for current request.
      time:
        type: string
        format: date-time-rfc1123
        description: The time that error request failed.
    required:
    - code
    - message
  DashboardCollection:
    description: The paged results of dashboards.
    type: object
    properties:
      value:
        description: The collection of dashboards.
        type: array
        items:
          $ref: '#/definitions/Dashboard'
      nextLink:
        description: URL to get the next page of dashboards.
        type: string
    required:
    - value
  Error:
    description: The response error definition.
    type: object
    properties:
      error:
        description: Error details for current request.
        $ref: '#/definitions/ErrorDetails'
    required:
    - error
  Tile:
    description: Configuration specifying tile object, including the layout, display name and configuration.
    type: object
    properties:
      id:
        description: Unique ID of the tile.
        type: string
        readOnly: true
      displayName:
        description: Display name of the tile.
        type: string
      configuration:
        $ref: '#/definitions/TileConfiguration'
        description: The configuration for the tile
      height:
        type: number
        description: Height of the tile
        minimum: 1
        maximum: 10
      width:
        type: number
        description: Width of the tile
        minimum: 1
        maximum: 10
      x:
        type: number
        description: Horizontal position of the tile
        minimum: 0
        maximum: 100
      y:
        type: number
        description: Vertical position of the tile
        minimum: 0
        maximum: 100
    required:
    - displayName
    - configuration
    - height
    - width
    - x
    - y
parameters:
  DashboardId:
    in: path
    name: dashboardId
    description: Unique ID for the dashboard.
    x-ms-parameter-location: method
    type: string
    maxLength: 128
    pattern: ^[a-zA-Z0-9:;]*$
    required: true
  Filter:
    in: query
    name: filter
    description: An expression on the resource type that selects the resources to be returned.
    x-ms-parameter-location: method
    type: string
    required: false
  MaxPageSize:
    in: query
    name: maxpagesize
    description: The maximum number of resources to return from one response.
    x-ms-parameter-location: method
    type: integer
    format: int32
    minimum: 1
    maximum: 100
    required: false
  Version:
    in: query
    name: api-version
    description: The version of the API being called.
    x-ms-parameter-location: client
    type: string
    required: true
  OrderBy:
    in: query
    name: orderby
    description: An expression that specify the order of the returned resources.
    x-ms-parameter-location: method
    type: string
    required: false
  IfMatch:
    in: header
    name: If-Match
    description: Only perform the operation if the entity's etag matches one of the etags provided or * is provided.
    x-ms-parameter-location: method
    type: string
    required: false
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'