openapi: 3.2.0
info:
  title: Fenergo Import Record API
  version: '1.0'
  description: 'Operations tagged ImportRecord across 2 of this provider''s published API definitions: fenergo-configexchangecommand-v1-0-openapi.json, fenergo-configexchangequery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /configexchangecommand
- url: /configexchangequery
security:
- Bearer: []
tags:
- name: ImportRecord
paths:
  /api/import-history:
    post:
      tags:
      - ImportRecord
      summary: Create new ImportRecord
      description: 'This method will create a new ImportRecord.

        The ImportRecord will initialize with the data provided in the DTO.


        Required permissions:

        Following permissions are required: ConfigurationExchangeEdit'
      operationId: CreateImportRecord
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: ServiceRequest with the Fenergo.Nebula.ConfigExchange.Command.Application.Dto.ImportRecordDto to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportRecordDtoServiceRequest'
      responses:
        '202':
          description: Success. ImportRecord created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportRecordDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    get:
      tags:
      - ImportRecord
      summary: Get all ImportRecords
      description: 'Returns a list of all ImportRecords for a given tenant


        Required permissions:

        Following permissions are required: ConfigurationExchangeAccess'
      operationId: GetAllImportRecords
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. The list of ImportRecords is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportRecordDtoIEnumerableServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /configexchangecommand
  /api/import-history/{id}:
    get:
      tags:
      - ImportRecord
      summary: Get an ImportRecord
      description: 'Returns an ImportRecord for a given ID


        Required permissions:

        Following permissions are required: ConfigurationExchangeAccess'
      operationId: GetImportRecordById
      parameters:
      - name: id
        in: path
        description: Unique Identifier of the ImportRecord
        required: true
        schema:
          type: string
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. An ImportRecord is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportRecordDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. ImportRecord with given ID does not exist
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /configexchangequery
components:
  schemas:
    ServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ImportRecordDtoServiceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ImportRecordDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ImportStatus:
      enum:
      - 0
      - 1
      type: integer
      format: int32
    ImportRecordDto:
      type: object
      properties:
        id:
          type: string
          description: Unique Identifier of the import record
          format: uuid
          example: 2920b7a7-7336-4fb1-82b7-1d691b8367fa
        sourceTenantId:
          type:
          - string
          - 'null'
          description: The tenant id of the target tenant
          example: 3840b7a7-7326-4fb1-78b7-1d691b83676b
        importStatus:
          $ref: '#/components/schemas/ImportStatus'
      additionalProperties: false
      description: The details of an import record
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    ImportRecordDtoServiceRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ImportRecordDto'
      additionalProperties: false
    ObjectServiceResponse:
      type: object
      properties:
        data: {}
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    StringServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ImportRecordDtoIEnumerableServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ImportRecordDto_2'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ImportRecordDto_2:
      type: object
      properties:
        id:
          type: string
          description: Unique Identifier of the import record
          format: uuid
          example: 2920b7a7-7336-4fb1-82b7-1d691b8367fa
        targetTenantId:
          type:
          - string
          - 'null'
          description: The tenant id of the target tenant
          example: 4340b7a7-126-4cd2-73b4-1d691b83577e
        sourceTenantId:
          type:
          - string
          - 'null'
          description: The tenant id of the source tenant
          example: 3840b7a7-7326-4fb1-78b7-1d691b83676b
        importStatus:
          $ref: '#/components/schemas/ImportStatus'
      additionalProperties: false
      description: The details of an import record
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header
x-refined-from:
- fenergo-configexchangecommand-v1-0-openapi.json
- fenergo-configexchangequery-v1-0-openapi.json