openapi: 3.2.0
info:
  title: Microsoft Azure Azure IoT Central Device Templates API
  description: Azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale.
  version: 2022-10-31-preview
servers:
- url: /api
security:
- azure_auth:
  - user_impersonation
tags:
- name: Device Templates
paths:
  /deviceTemplates:
    get:
      operationId: microsoftAzureDevicetemplatesList
      summary: Microsoft Azure Get The List Of Device Templates In An Application With Basic…
      x-ms-examples:
        List device templates:
          $ref: ./examples/devicetemplates_list.json
      parameters:
      - $ref: '#/components/parameters/Version'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/MaxPageSize'
      - $ref: '#/components/parameters/OrderBy'
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceTemplateCollection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      description: Needs a more full description created.
      tags:
      - Device Templates
  /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: '#/components/parameters/Version'
      - $ref: '#/components/parameters/DeviceTemplateId'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceTemplate'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      description: Needs a more full description created.
      tags:
      - Device Templates
    put:
      operationId: microsoftAzureDevicetemplatesCreate
      summary: Microsoft Azure Publish A New Device Template Default Views Will Be…
      x-ms-examples:
        Create a device template:
          $ref: ./examples/devicetemplates_create.json
      parameters:
      - $ref: '#/components/parameters/Version'
      - $ref: '#/components/parameters/DeviceTemplateId'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceTemplate'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      description: Needs a more full description created.
      tags:
      - Device Templates
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeviceTemplate'
        description: Device template body.
        required: true
    patch:
      operationId: microsoftAzureDevicetemplatesUpdate
      summary: Microsoft Azure Update The Cloud Properties And Overrides Of An Existing Device…
      x-ms-examples:
        Update a device template:
          $ref: ./examples/devicetemplates_update.json
      parameters:
      - $ref: '#/components/parameters/Version'
      - $ref: '#/components/parameters/DeviceTemplateId'
      - $ref: '#/components/parameters/IfMatch'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceTemplate'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      description: Needs a more full description created.
      tags:
      - Device Templates
      requestBody:
        content:
          application/json:
            schema:
              type: object
          application/merge-patch+json:
            schema:
              type: object
        description: Device template patch body.
        required: true
    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: '#/components/parameters/Version'
      - $ref: '#/components/parameters/DeviceTemplateId'
      responses:
        '204':
          description: Success
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Device Templates
components:
  parameters:
    MaxPageSize:
      in: query
      name: maxpagesize
      description: The maximum number of resources to return from one response.
      x-ms-parameter-location: method
      required: false
      schema:
        type: integer
        format: int32
        maximum: 100
        minimum: 1
    OrderBy:
      in: query
      name: orderby
      description: An expression that specify the order of the returned resources.
      x-ms-parameter-location: method
      required: false
      schema:
        type: string
    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
      required: false
      schema:
        type: string
    Version:
      in: query
      name: api-version
      description: The version of the API being called.
      x-ms-parameter-location: client
      required: true
      schema:
        type: string
    Filter:
      in: query
      name: filter
      description: An expression on the resource type that selects the resources to be returned.
      x-ms-parameter-location: method
      required: false
      schema:
        type: string
    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
      required: true
      schema:
        type: string
  schemas:
    Error:
      description: The response error definition.
      type: object
      properties:
        error:
          description: Error details for current request.
          $ref: '#/components/schemas/ErrorDetails'
      required:
      - error
    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
    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
    DeviceTemplateCollection:
      description: The paged results of device templates.
      type: object
      properties:
        value:
          description: The collection of device templates.
          type: array
          items:
            $ref: '#/components/schemas/DeviceTemplate'
        nextLink:
          description: URL to get the next page of device templates.
          type: string
      required:
      - value
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow
x-ms-parameterized-host:
  hostTemplate: '{subdomain}.{baseDomain}'
  parameters:
  - $ref: '#/components/parameters/BaseDomain'
  - $ref: '#/components/parameters/Subdomain'