swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector deviceTemplates API
schemes:
- https
tags:
- name: deviceTemplates
paths:
  /deviceTemplates:
    get:
      operationId: microsoftAzureDevicetemplatesList
      summary: 'Microsoft Azure Get The List Of Device Templates In An Application With Basic Odata Support Maxpagesize, Filter, Orderby , [more Details] Https: Aka Ms Iotcentralodatasupport'
      x-ms-examples:
        List device templates:
          $ref: ./examples/devicetemplates_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/DeviceTemplateCollection'
        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:
      - deviceTemplates
  /deviceTemplates/{deviceTemplateId}:
    get:
      operationId: microsoftAzureDevicetemplatesGet
      summary: Microsoft Azure Get A Device Template By Id
      x-ms-examples:
        Get a device template by ID:
          $ref: ./examples/devicetemplates_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceTemplateId'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceTemplate'
        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:
      - deviceTemplates
    put:
      operationId: microsoftAzureDevicetemplatesCreate
      summary: Microsoft Azure Publish A New Device Template Default Views Will Be Automatically Generated For New Device Templates Created This Way
      x-ms-examples:
        Create a device template:
          $ref: ./examples/devicetemplates_create.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceTemplateId'
      - in: body
        name: body
        description: Device template body.
        schema:
          $ref: '#/definitions/DeviceTemplate'
        required: true
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceTemplate'
        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:
      - deviceTemplates
    patch:
      operationId: microsoftAzureDevicetemplatesUpdate
      summary: Microsoft Azure Update The Cloud Properties And Overrides Of An Existing Device Template Via Patch
      x-ms-examples:
        Update a device template:
          $ref: ./examples/devicetemplates_update.json
      consumes:
      - application/json
      - application/merge-patch+json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceTemplateId'
      - in: body
        name: body
        description: Device template patch body.
        schema:
          type: object
        required: true
      - $ref: '#/parameters/IfMatch'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceTemplate'
        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:
      - deviceTemplates
    delete:
      operationId: microsoftAzureDevicetemplatesRemove
      summary: Microsoft Azure Delete A Device Template
      description: Delete an existing device template by device ID.
      x-ms-examples:
        Delete a device template by ID:
          $ref: ./examples/devicetemplates_delete.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceTemplateId'
      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'
      tags:
      - deviceTemplates
definitions:
  DeviceTemplateCollection:
    description: The paged results of device templates.
    type: object
    properties:
      value:
        description: The collection of device templates.
        type: array
        items:
          $ref: '#/definitions/DeviceTemplate'
      nextLink:
        description: URL to get the next page of device templates.
        type: string
    required:
    - value
  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
  DeviceTemplate:
    description: The device template definition.
    type: object
    properties:
      '@id':
        description: Unique ID of the device template.
        type: string
        readOnly: true
      '@type':
        description: The JSON-LD types of this device template.
        type: array
        items:
          type: string
      etag:
        description: ETag used to prevent conflict in device template updates.
        type: string
      displayName:
        description: Display name of the device template.
        type: string
      description:
        description: Detailed description of the device template.
        type: string
      capabilityModel:
        description: The capability model utilized by this device template.
        type: object
    required:
    - '@type'
    - capabilityModel
  Error:
    description: The response error definition.
    type: object
    properties:
      error:
        description: Error details for current request.
        $ref: '#/definitions/ErrorDetails'
    required:
    - error
parameters:
  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
  DeviceTemplateId:
    in: path
    name: deviceTemplateId
    description: Unique [Digital Twin Model Identifier](https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/dtdlv2.md#digital-twin-model-identifier) of the device template.
    x-ms-parameter-location: method
    type: string
    required: true
  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'