openapi: 3.2.0
info:
  title: Fenergo Import Session API
  version: '1.0'
  description: 'Operations tagged ImportSession 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: ImportSession
paths:
  /api/import-session:
    post:
      tags:
      - ImportSession
      summary: Create new ImportSession
      description: 'This method will create a new ImportSession.

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


        Required permissions:

        Following permissions are required: ConfigurationExchangeEdit'
      operationId: CreateImportSession
      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.ImportSessionDto to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportSessionCreationDtoServiceRequest'
      responses:
        '202':
          description: Success. ImportSession created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportSessionDtoServiceResponse'
        '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:
      - ImportSession
      summary: Get basic details for all import sessions
      description: 'Returns a list of all Import Sessions for a given tenant


        Required permissions:

        Following permissions are required: ConfigurationExchangeAccess'
      operationId: GetAllImportSessionSummaries
      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 Import Sessions is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportSessionSummaryDtoIEnumerableServiceResponse'
        '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-session/{sessionId}/log:
    patch:
      tags:
      - ImportSession
      summary: Adds logs to an import session
      description: 'This method add new logs to an import session


        Required permissions:

        Following permissions are required: ConfigurationExchangeEdit'
      operationId: AddSessionLogs
      parameters:
      - name: sessionId
        in: path
        description: The id of the import session
        required: true
        schema:
          type: string
          format: uuid
      - 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: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportSessionAddLogsDtoServiceRequest'
      responses:
        '202':
          description: Success. Logs added
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '500':
          description: Internal server error
        '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
        '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:
      - ImportSession
      summary: Get session logs
      description: 'Returns logs for a given import session


        Required permissions:

        Following permissions are required: ConfigurationExchangeAccess'
      operationId: GetLogs
      parameters:
      - name: sessionId
        in: path
        description: Unique Identifier of the ImportSession
        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. Logs returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportSessionLogEntryDtoIEnumerableServiceResponse'
        '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. No logs associated with the given session id
                  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: /configexchangecommand
  /api/import-session/{sessionId}/phase/current/close:
    put:
      tags:
      - ImportSession
      summary: Close import phase
      description: 'This method will close import phase.

        The current ImportSession phase will be closed with the data provided in the DTO.


        Required permissions:

        Following permissions are required: ConfigurationExchangeEdit'
      operationId: CloseImportPhase
      parameters:
      - name: sessionId
        in: path
        description: The id of the import session
        required: true
        schema:
          type: string
          format: uuid
      - 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.ImportSessionDto to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloseImportPhaseRequestDtoServiceRequest'
      responses:
        '202':
          description: Success. ImportSession created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloseImportPhaseResponseDtoServiceResponse'
        '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-session/{id}:
    get:
      tags:
      - ImportSession
      summary: Get an ImportSession
      description: 'Returns an ImportSession for a given ID


        Required permissions:

        Following permissions are required: ConfigurationExchangeAccess'
      operationId: GetImportSession
      parameters:
      - name: id
        in: path
        description: Unique Identifier of the ImportSession
        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 ImportSession is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportSessionDtoServiceResponse'
        '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. ImportSession 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:
    CloseImportPhaseResponseDto:
      type: object
      properties:
        sessionId:
          type: string
          description: Unique Identifier of the import session
          format: uuid
          example: 2920b7a7-7336-4fb1-82b7-1d691b8367fa
        nextPhaseIndex:
          type:
          - integer
          - 'null'
          description: Identifier of next phase
          format: int32
          example: 777
      additionalProperties: false
    CloseImportPhaseRequestDtoServiceRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CloseImportPhaseRequestDto'
      additionalProperties: false
    ImportItemType:
      enum:
      - Selection
      - Dependency
      type: string
    CloseImportPhaseRequestDto:
      type: object
      properties:
        sessionId:
          type: string
          description: Unique Identifier of the import session
          format: uuid
          example: 2920b7a7-7336-4fb1-82b7-1d691b8367fa
        currentPhaseIndex:
          type: integer
          description: Identifier of current phase
          format: int32
          example: 0
        nextPhaseType:
          $ref: '#/components/schemas/ImportPhaseType'
        description:
          type:
          - string
          - 'null'
          description: The description of the import session
          example: Description of the Import Session 23/04/22
        importInPublishedState:
          type: boolean
          description: The state of the import in a published state toggle
          example: true
        configAsOfDate:
          type: string
          description: The current configuration as-of value
          format: date-time
          example: '2019-01-06T17:16:40'
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ImportItem'
          description: Selected items
        closeDate:
          type: string
          description: Close date
          format: date-time
          example: '2019-01-06T17:16:40'
      additionalProperties: false
    ImportItemStatus:
      enum:
      - None
      - Invalid
      - MissingDependency
      - LoadingError
      - ImportError
      - Pending
      - NewDraftCreated
      - Created
      - Published
      - Updated
      - NoChange
      - PermissionError
      type: string
    ImportSessionAddLogsDtoServiceRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ImportSessionAddLogsDto'
      additionalProperties: false
    ImportSessionStatus:
      enum:
      - Open
      - InProgress
      - Failed
      - Completed
      type: string
    ImportSessionCreationDto:
      type: object
      properties:
        sourceTenant:
          type:
          - string
          - 'null'
          description: The id of the source tenant for the import session
          example: 3920c7a7-7836-5fb1-83b2-1d641c8337fa
        sourceTenantName:
          type:
          - string
          - 'null'
          description: The id of the source tenant for the import session
          example: tenant-name
        description:
          type:
          - string
          - 'null'
          description: The description of the import session
          example: Description of the Import Session
        importInPublishedState:
          type: boolean
          description: The state of the import in a published state toggle
          example: true
        configAsOfDate:
          type: string
          description: The current configuration as-of value
          format: date-time
          example: '2019-01-06'
        configEnvironmentId:
          type:
          - string
          - 'null'
          description: The source config environment id
          format: uuid
          example: 3920c7a7-7836-5fb1-83b2-1d641c8337fa
      additionalProperties: false
    ImportItemVersion:
      type: object
      properties:
        versionNumber:
          type: integer
          format: int32
        targetVersionNumber:
          type:
          - integer
          - 'null'
          format: int32
        isManuallySelected:
          type: boolean
        notes:
          type:
          - string
          - 'null'
        publicationDate:
          type: string
          format: date-time
      additionalProperties: false
    CloseImportPhaseResponseDtoServiceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CloseImportPhaseResponseDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    LogType:
      enum:
      - None
      - RefreshingCache
      - AsOfDateChanged
      - ErrorWhileRemovingConfig
      - AsOfDateChangeError
      - ErrorWhileChangingSelectedItemVersion
      - ErrorWhileChangingDependencyVersion
      - ErrorWhileRefreshingAuthToken
      - AuthTokenRefreshRetry
      - ErrorDuringDependencyCheck
      - GlobalSessionImportError
      - MissingDependencyError
      - ErrorLoadingDependencies
      - MissingPermissionsError
      - UnexpectedLoadingError
      - MissingApiClient
      - DependentTypeDisabled
      - ConfigsFailedToLoadForSelection
      - SourceModelFailedToLoad
      - ImportStarted
      - ImportCompleted
      - UnexpectedImportEngineError
      - MissingImporter
      - DependentImportCanceled
      - SourceRawVersionLoadingError
      - ErrorPreparingNewVersion
      - ErrorPreparingNewVersionedConfig
      - NewVersionImportError
      - NewVersionedConfigImportError
      - PublishError
      - NewVersionedConfigCreated
      - NewVersionCreated
      - NewVersionPublished
      - NonVersionedConfigLoadingError
      - ErrorPreparingNonVersionedConfigUpdate
      - ErrorPreparingNonVersionedConfigCreation
      - NonVersionedConfigUpdateError
      - NonVersionedConfigCreationError
      - NewNonVersionedConfigCreated
      - NewNonVersionedConfigUpdated
      - ImportSkippedByDeepComparison
      - ImportSkippedBySmartImport
      - DependencyUpdateSkipped
      - ExternalDataImportError
      - NewExtDataMappingUpdated
      - MissingPolicyForRegime
      - InvalidScheduleConditionField
      - MissingScheduleConditonField
      - ScheduleConditionFieldIndexing
      - MissingPolicyDataKeysForSDT
      - ErrorLoadingPolicyForSDT
      - InvalidSDTUpdate
      - TeamSkippedAsDependency
      - ErrorLoadingUserScopes
      - InvalidDPRegimeUpdate
      - ErrorRequestingIndirectDependency
      - VersionedDependencyMissingActiveVersion
      - MissingPolicyProviderInSource
      - MissingPolicyProviderInTarget
      - DependencyVersionConflict
      - ErrorLoadingPolicyForAD
      - AdvancedDashboardMissingPolicyDataKeys
      - ErrorDuringClosePhase
      - IntegrationFlowGlobalVariableNoChange
      - RPSRImportSkippedDraftExists
      - RPSRTaskReferenceUpdated
      - RPSRTaskReferenceUnresolved
      - RPSRTaskReferenceMappingStarted
      - RPSRTaskReferenceMappingCompleted
      - RPSRTargetTenantLoadFailed
      - ScreeningProviderConfigurationNoChange
      - SecondaryIdentifierImported
      - RPSRSourceTenantLoadFailed
      - RiskAmbiguousSourceDuplicateNames
      type: string
    ImportPhaseType:
      enum:
      - Selection
      - DependencyCheck
      - Import
      - Retry
      type: string
    ImportSessionLogEntryDto:
      type: object
      properties:
        resultParameters:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
          description: Log result parameters to be injected in the log's main result message
        errorMessage:
          type:
          - string
          - 'null'
          description: Optional error message to be added after the log result
          example: Failure to load configuration from source tenant
        resultBulletPoints:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
          description: Non-localized bullet points to be added at the end of the log result
        logStatus:
          $ref: '#/components/schemas/LogStatus'
        sourceConfigId:
          type:
          - string
          - 'null'
          description: The id of source config for which the log was created, when available
          example: 668c50eb-9480-4e7d-9706-036fbbf3be57
        configType:
          type:
          - string
          - 'null'
          description: The type of config for which the log was created, when available
          example: JourneySchema
        configName:
          type:
          - string
          - 'null'
          description: The name of config item for which the log was created, when available
          example: Client Onboarding
        logType:
          $ref: '#/components/schemas/LogType'
        date:
          type: string
          description: The date that the log entry was created
          format: date-time
          example: '2023-05-03T08:44:55.265Z'
      additionalProperties: false
      description: The details of an import log
    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
    LogStatus:
      enum:
      - None
      - Invalid
      - MissingDependency
      - LoadingError
      - ImportError
      - PermissionError
      - ImplementationError
      - Pending
      - NewDraftCreated
      - Created
      - Published
      - Updated
      - NoChange
      - Info
      - IdentityError
      - Warning
      - Imported
      type: string
    ImportSessionDto:
      type: object
      properties:
        id:
          type: string
          description: Unique Identifier of the import session
          format: uuid
          example: 2920b7a7-7336-4fb1-82b7-1d691b8367fa
        sourceTenant:
          type:
          - string
          - 'null'
          description: The id of the source tenant for the import session
          example: 3920c7a7-7836-5fb1-83b2-1d641c8337fa
        sourceTenantName:
          type:
          - string
          - 'null'
          description: The name of the source tenant for the import session
          example: example-name
        name:
          type:
          - string
          - 'null'
          description: The name of the import session
          example: '1081'
        description:
          type:
          - string
          - 'null'
          description: The description of the import session
          example: Description of the Import Session
        status:
          $ref: '#/components/schemas/ImportSessionStatus'
        importInPublishedState:
          type: boolean
          description: The state of the import in a published state toggle
          example: true
        configAsOfDate:
          type: string
          description: The current configuration as-of value
          format: date-time
          example: '2019-01-06T17:16:40'
        createdOn:
          type: string
          description: The date the session was created
          format: date-time
          example: '2019-01-06T17:16:40'
        lastImportDate:
          type:
          - string
          - 'null'
          description: The last date an import took place
          format: date-time
          example: '2019-01-06T17:16:40'
        currentPhaseIndex:
          type: integer
          description: The index of the current active phase
          format: int32
          example: 1
        currentPhaseType:
          $ref: '#/components/schemas/ImportPhaseType'
        changedBy:
          type:
          - string
          - 'null'
          description: The id of the user that performed the latest action
          example: Selection
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ImportItem'
          description: The list of ImportItems
        configEnvironmentId:
          type:
          - string
          - 'null'
          description: The source config environment id
          format: uuid
          example: 3920c7a7-7836-5fb1-83b2-1d641c8337fa
      additionalProperties: false
      description: The details of an import session
    ImportItem:
      type: object
      properties:
        configId:
          type:
          - string
          - 'null'
        targetConfigId:
          type:
          - string
          - 'null'
        configVersion:
          $ref: '#/components/schemas/ImportItemVersion'
        configType:
          type:
          - string
          - 'null'
        type:
          $ref: '#/components/schemas/ImportItemType'
        status:
          $ref: '#/components/schemas/ImportItemStatus'
        name:
          type:
          - string
          - 'null'
        equivalentIdentifierSnapshot:
          type:
          - string
          - 'null'
        errorMessage:
          type:
          - string
          - 'null'
      additionalProperties: false
    ImportSessionDtoServiceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ImportSessionDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ImportSessionAddLogsDto:
      type: object
      properties:
        sessionId:
          type: string
          description: Unique Identifier of the import session
          format: uuid
          example: 2920b7a7-7336-4fb1-82b7-1d691b8367fa
        entries:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ImportSessionLogEntryDto'
          description: The name of the import session
      additionalProperties: false
      description: The details of an import log update
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    ImportSessionCreationDtoServiceRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ImportSessionCreationDto'
      additionalProperties: false
    ImportSessionLogEntryDto_2:
      type: object
      properties:
        resultParameters:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
          description: Log result parameters to be injected in the log's main result message
        errorMessage:
          type:
          - string
          - 'null'
          description: Optional error message to be added after the log result
          example: Failure to load configuration from source tenant
        resultBulletPoints:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
          description: Non-localized bullet points to be added at the end of the log result
        logStatus:
          $ref: '#/components/schemas/LogStatus'
        sourceConfigId:
          type:
          - string
          - 'null'
          description: The id of source config for which the log was created, when available
          example: 668c50eb-9480-4e7d-9706-036fbbf3be57
        configType:
          type:
          - string
          - 'null'
          description: The type of config for which the log was created
          example: JourneySchema
        configName:
          type:
          - string
          - 'null'
          description: The name of config item for which the log was created
          example: Client Onboarding
        logType:
          $ref: '#/components/schemas/LogType'
        date:
          type: string
          description: The date that the log entry was created
          format: date-time
          example: '2023-05-03T08:44:55.265Z'
      additionalProperties: false
      description: The details of an import log
    ImportSessionDto_2:
      type: object
      properties:
        id:
          type: string
          description: Unique Identifier of the import session
          format: uuid
          example: 2920b7a7-7336-4fb1-82b7-1d691b8367fa
        sourceTenant:
          type:
          - string
          - 'null'
          description: The id of the source tenant for the import session
          example: 3920c7a7-7836-5fb1-83b2-1d641c8337fa
        sourceTenantName:
          type:
          - string
          - 'null'
          description: The name of the source tenant for the import session
          example: example-name
        name:
          type:
          - string
          - 'null'
          description: The name of the import session
          example: '1081'
        description:
          type:
          - string
          - 'null'
          description: The description of the import session
          example: Description of the Import Session 23/04/22
        status:
          $ref: '#/components/schemas/ImportSessionStatus'
        importInPublishedState:
          type: boolean
          description: The state of the import in a published state toggle
          example: true
        configAsOfDate:
          type: string
          description: The current configuration as-of value
          format: date-time
          example: '2019-01-06T17:16:40'
        createdOn:
          type: string
          description: The date the session was created
          format: date-time
          example: '2019-01-06T17:16:40'
        lastImportDate:
          type:
          - string
          - 'null'
          description: The last date an import took place
          format: date-time
          example: '2019-01-06T17:16:40'
        currentPhaseIndex:
          type: integer
          description: The index of the current active phase
          format: int32
          example: 1
        currentPhaseType:
          $ref: '#/components/schemas/ImportPhaseType'
        changedBy:
          type:
          - string
          - 'null'
          description: The id of the user that performed the latest action
          example: Selection
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ImportItem'
          description: The list of ImportItems
        configEnvironmentId:
          type:
          - string
          - 'null'
          description: The source config environment id
          format: uuid
          example: 3920c7a7-7836-5fb1-83b2-1d641c8337fa
        configEnvironmentName:
          type:
          - string
          - 'null'
          description: The source config environment name
          example: 3920c7a7-7836-5fb1-83b2-1d641c8337fa
      additionalProperties: false
      description: The details of an import session
    ImportSessionSummaryDtoIEnumerableServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ImportSessionSummaryDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ImportSessionSummaryDto:
      type: object
      properties:
        sessionId:
          type: string
          description: Unique Identifier of the import session
          format: uuid
          example: 2920b7a7-7336-4fb1-82b7-1d691b8367fa
        sessionName:
          type:
          - string
          - 'null'
          description: The name of the import session
          example: '1081'
        sourceTenantId:
          type:
          - string
          - 'null'
          description: The id of the source tenant
          format: uuid
          example: 383Ghts-4536-4585-82b7-1d694509jfdl
        sourceTenantName:
          type:
          - string
          - 'null'
          description: The name of the source tenant for the import session
          example: example-name
        sourceEnvironmentId:
          type:
          - string
          - 'null'
          description: The id of the source environment
          format: uuid
          example: dT45b7a7-7336-4585-82b7-1d691b8367fa
        sourceEnvironmentName:
          type:
          - string
          - 'null'
          description: The name of the source environment
          example: example-name
        configAsOfDate:
          type: string
          description: The current configuration as-of value
          format: date-time
          example: '2019-01-06T17:16:40'
        lastImportDate:
          type:
          - string
          - 'null'
          description: The last date an import took place
          format: date-time
          example: '2019-01-06T17:16:40'
        description:
          type:
          - string
          - 'null'
          description: The description of the import session
          example: Description of the Import Session 23/04/22
        status:
          $ref: '#/components/schemas/ImportSessionStatus'
        lastImportedBy:
          type:
          - string
          - 'null'
          description: Id of the user who last clicked 'Import'/'Retry' for this session
          example: 7a8ab37d-9cd5-48ef-8028-0e7c4a606570
      additionalProperties: false
      description: The basic details of an import session
    ImportSessionLogEntryDtoIEnumerableServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ImportSessionLogEntryDto_2'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
  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