openapi: 3.2.0
info:
  version: 2023-02-27-preview
  title: Microsoft Azure Azure Digital Twins Import Jobs API
  description: A service for managing and querying digital twins and digital twin models.
servers:
- url: https://digitaltwins-hostname
security:
- oauth2: []
tags:
- name: Import Jobs
paths:
  /jobs/imports:
    parameters:
    - $ref: '#/components/parameters/traceparent'
    - $ref: '#/components/parameters/tracestate'
    get:
      tags:
      - Import Jobs
      operationId: microsoftAzureImportjobsList
      description: 'Retrieves all import jobs.

        Status codes:

        * 200 OK'
      x-ms-examples:
        Get all import jobs:
          $ref: ./examples/ImportJobList.json
      parameters:
      - $ref: '#/components/parameters/max-items-per-page'
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportJobCollection'
        default:
          description: Default response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Jobs Imports
  /jobs/imports/{id}:
    parameters:
    - $ref: '#/components/parameters/traceparent'
    - $ref: '#/components/parameters/tracestate'
    put:
      tags:
      - Import Jobs
      operationId: microsoftAzureImportjobsAdd
      description: 'Creates an import job.

        Status codes:

        * 201 Created

        * 400 Bad Request

        * JobLimitReached - The maximum number of import jobs allowed has been reached.

        * ValidationFailed - The import job request is not valid.'
      x-ms-examples:
        Add a job:
          $ref: ./examples/ImportJobPut.json
      parameters:
      - $ref: '#/components/parameters/importJobId'
      - $ref: '#/components/parameters/api-version'
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportJob'
        default:
          description: Default response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Microsoft Azure Put Jobs Imports Id
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportJob'
        description: The import job being added.
        required: true
    get:
      tags:
      - Import Jobs
      operationId: microsoftAzureImportjobsGetbyid
      description: 'Retrieves an import job.

        Status codes:

        * 200 OK

        * 404 Not Found

        * ImportJobNotFound - The import job was not found.'
      x-ms-examples:
        Get an import job by id:
          $ref: ./examples/ImportJobGet.json
      parameters:
      - $ref: '#/components/parameters/importJobId'
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportJob'
        default:
          description: Default response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Microsoft Azure Get Jobs Imports Id
    delete:
      tags:
      - Import Jobs
      operationId: microsoftAzureImportjobsDelete
      description: 'Deletes an import job.

        Status codes:

        * 204 No Content

        * 400 Bad Request

        * ValidationFailed - The import job request is not valid.'
      x-ms-examples:
        Delete an import job:
          $ref: ./examples/ImportJobDelete.json
      parameters:
      - $ref: '#/components/parameters/importJobId'
      - $ref: '#/components/parameters/api-version'
      responses:
        '204':
          description: Success
        default:
          description: Default response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Microsoft Azure Delete Jobs Imports Id
  /jobs/imports/{id}/cancel:
    parameters:
    - $ref: '#/components/parameters/traceparent'
    - $ref: '#/components/parameters/tracestate'
    post:
      tags:
      - Import Jobs
      operationId: microsoftAzureImportjobsCancel
      description: 'Cancels an import job.

        Status codes:

        * 200 Request Accepted

        * 400 Bad Request

        * ValidationFailed - The import job request is not valid.'
      x-ms-examples:
        Cancel a job:
          $ref: ./examples/ImportJobCancel.json
      parameters:
      - $ref: '#/components/parameters/importJobId'
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportJob'
        default:
          description: Default response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Microsoft Azure Post Jobs Imports Id Cancel
components:
  schemas:
    ErrorResponse:
      description: Error response.
      required:
      - error
      properties:
        error:
          $ref: '#/components/schemas/Error'
          description: The error details.
    ImportJob:
      description: A job which contains a reference to the operations to perform, results, and execution metadata.
      type: object
      required:
      - inputBlobUri
      - outputBlobUri
      properties:
        id:
          description: The identifier of the import job.
          type: string
          readOnly: true
        inputBlobUri:
          description: The path to the input Azure storage blob that contains file(s) describing the operations to perform in the job.
          type: string
        outputBlobUri:
          description: The path to the output Azure storage blob that will contain the errors and progress logs of import job.
          type: string
        status:
          description: Status of the job.
          enum:
          - notstarted
          - running
          - failed
          - succeeded
          - cancelling
          - cancelled
          type: string
          readOnly: true
          x-ms-enum:
            name: status
            modelAsExtensible: true
            modelAsString: false
        createdDateTime:
          description: 'Start time of the job. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.'
          type: string
          format: date-time
          readOnly: true
        lastActionDateTime:
          description: 'Last time service performed any action from the job. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.'
          type: string
          format: date-time
          readOnly: true
        finishedDateTime:
          description: 'End time of the job. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.'
          type: string
          format: date-time
          readOnly: true
        purgeDateTime:
          description: 'Time at which job will be purged by the service from the system. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.'
          type: string
          format: date-time
          readOnly: true
        error:
          $ref: '#/components/schemas/Error'
          description: Details of the error(s) that occurred executing the import job.
    InnerError:
      description: A more specific error description than was provided by the containing error.
      properties:
        code:
          description: A more specific error code than was provided by the containing error.
          type: string
        innererror:
          description: An object containing more specific information than the current object about the error.
          $ref: '#/components/schemas/InnerError'
    Error:
      description: Error definition.
      properties:
        code:
          description: Service specific error code which serves as the substatus for the HTTP error code.
          type: string
          readOnly: true
        message:
          description: A human-readable representation of the error.
          type: string
          readOnly: true
        details:
          description: Internal error details.
          type: array
          items:
            $ref: '#/components/schemas/Error'
          readOnly: true
        innererror:
          description: An object containing more specific information than the current object about the error.
          $ref: '#/components/schemas/InnerError'
    ImportJobCollection:
      description: A collection of import job objects.
      type: object
      required:
      - value
      properties:
        value:
          description: The list of import job objects.
          type: array
          items:
            $ref: '#/components/schemas/ImportJob'
        nextLink:
          description: A URI to retrieve the next page of results.
          type: string
  parameters:
    api-version:
      name: api-version
      in: query
      description: The requested API version.
      required: true
      schema:
        type: string
        minLength: 1
    importJobId:
      name: id
      in: path
      description: The id for the import job. The id is unique within the service and case sensitive.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    traceparent:
      name: traceparent
      in: header
      description: Identifies the request in a distributed tracing system.
      required: false
      x-ms-parameter-location: method
      x-ms-parameter-grouping:
        postfix: Options
      schema:
        type: string
    tracestate:
      name: tracestate
      in: header
      description: Provides vendor-specific trace identification information and is a companion to traceparent.
      required: false
      x-ms-parameter-location: method
      x-ms-parameter-grouping:
        postfix: Options
      schema:
        type: string
    max-items-per-page:
      name: max-items-per-page
      in: header
      description: The maximum number of items to retrieve per request. The server may choose to return less than the requested number.
      required: false
      x-ms-client-name: MaxItemsPerPage
      x-ms-parameter-location: method
      x-ms-parameter-grouping:
        postfix: Options
      schema:
        type: integer
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        implicit:
          scopes: {}
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize?resource=0b07f429-9f4b-4714-9392-cc5e8e80c8b0