openapi: 3.2.0
info:
  title: Fenergo Extraction API
  version: '1.0'
  description: 'Operations tagged Extraction across 2 of this provider''s published API definitions: fenergo-policyagent-v1-0-openapi.json, fenergo-smartdocs-v1-0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /policyagent
- url: /smartdocs
security:
- Bearer: []
tags:
- name: Extraction
paths:
  /api/v1/extraction:
    post:
      tags:
      - Extraction
      summary: Create Extraction
      description: Endpoint for creating policy agent extraction
      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:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AddExtractionRequest'
        required: true
      responses:
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/HttpValidationProblemDetails'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddExtractionResponse'
        '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
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '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
      operationId: postApiV1Extraction
      x-operation-id-source: derived
    get:
      tags:
      - Extraction
      summary: Get All Extractions
      description: Endpoint for getting all policy agent extractions
      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:
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/HttpValidationProblemDetails'
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ExtractionDto'
        '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
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '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
      operationId: getApiV1Extraction
      x-operation-id-source: derived
    servers:
    - url: /policyagent
  /api/v1/extraction/{id}:
    delete:
      tags:
      - Extraction
      summary: Delete Extraction
      description: Endpoint for deleting a policy agent extraction by id
      parameters:
      - name: id
        in: path
        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
      responses:
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/HttpValidationProblemDetails'
        '204':
          description: No Content
        '404':
          description: Not Found
        '409':
          description: Conflict
        '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
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '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
      operationId: deleteApiV1ExtractionById
      x-operation-id-source: derived
    get:
      tags:
      - Extraction
      summary: Get Extraction
      description: Endpoint for getting policy agent extraction by id
      parameters:
      - name: id
        in: path
        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
      responses:
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/HttpValidationProblemDetails'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtractionDto'
        '404':
          description: Not Found
        '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
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '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
      operationId: getApiV1ExtractionById
      x-operation-id-source: derived
    servers:
    - url: /policyagent
  /api/v1/extraction/history:
    get:
      tags:
      - Extraction
      summary: Get Extraction History
      description: Endpoint for getting policy agent extraction history with document details
      parameters:
      - name: page
        in: query
        schema:
          type: integer
          format: int32
          default: 1
      - name: pageSize
        in: query
        schema:
          type: integer
          format: int32
          default: 5
      - 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:
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/HttpValidationProblemDetails'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtractionHistoryResponse'
        '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
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '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
      operationId: getApiV1ExtractionHistory
      x-operation-id-source: derived
    servers:
    - url: /policyagent
  /api/v1/extraction/version:
    get:
      tags:
      - Extraction
      summary: Get extraction record schema version
      description: Returns ExtractionVersions.Current — the extraction record schema version. Legacy records may omit version; consumers should treat null as version 1.
      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:
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/HttpValidationProblemDetails'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtractionVersionResponse'
        '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
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '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
      operationId: getApiV1ExtractionVersion
      x-operation-id-source: derived
    servers:
    - url: /policyagent
  /api/v1/extraction/{id}/status:
    put:
      tags:
      - Extraction
      summary: Update Extraction Status
      description: Endpoint for updating policy agent extraction status
      parameters:
      - name: id
        in: path
        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:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateExtractionStatusApiRequest'
        required: true
      responses:
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/HttpValidationProblemDetails'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/HttpValidationProblemDetails'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/HttpValidationProblemDetails'
        '404':
          description: Not Found
        '409':
          description: Conflict
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/HttpValidationProblemDetails'
        '500':
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/HttpValidationProblemDetails'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateExtractionStatusResponse'
      operationId: putApiV1ExtractionByIdStatus
      x-operation-id-source: derived
    servers:
    - url: /policyagent
  /api/extraction/entitydata/{entityId}/{journeyInstanceId}/{documentModelId}:
    get:
      tags:
      - Extraction
      summary: Get individual document model entity data extraction
      description: 'Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch'
      parameters:
      - name: journeyInstanceId
        in: path
        description: Journey Instance Id
        required: true
        schema:
          type: string
          format: uuid
      - name: documentModelId
        in: path
        description: Document Model Id
        required: true
        schema:
          type: string
          format: uuid
      - name: entityId
        in: path
        description: Entity Id
        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
      responses:
        '200':
          description: Success. Data Extraction for document returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentEntityDataExtractionServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_2'
              example:
                data: {}
                messages:
                - message: Not Found. Extraction not found
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '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_2'
              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_2'
              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
      operationId: getApiExtractionEntitydataByEntityIdByJourneyInstanceIdByDocumentModelId
      x-operation-id-source: derived
    servers:
    - url: /smartdocs
  /api/extraction/entitydata/{entityId}/{journeyInstanceId}/grouped:
    get:
      tags:
      - Extraction
      summary: Get list of document model entity data extractions for given journey instance
      description: 'Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch'
      parameters:
      - name: journeyInstanceId
        in: path
        description: Journey Instance Id
        required: true
        schema:
          type: string
          format: uuid
      - name: entityId
        in: path
        description: Entity Id
        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
      responses:
        '200':
          description: Success. Data Extraction for documents returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupedDocumentDataExtractionServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '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_2'
              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_2'
              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
      operationId: getApiExtractionEntitydataByEntityIdByJourneyInstanceIdGrouped
      x-operation-id-source: derived
    servers:
    - url: /smartdocs
  /api/extraction/entitydata/{entityId}/{journeyInstanceId}:
    get:
      tags:
      - Extraction
      summary: Get list of document model entity data extractions for given journey instance
      description: 'Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch'
      parameters:
      - name: journeyInstanceId
        in: path
        description: Journey Instance Id
        required: true
        schema:
          type: string
          format: uuid
      - name: entityId
        in: path
        description: Entity Id
        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
      responses:
        '200':
          description: Success. Data Extraction for documents returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentEntityDataExtractionIEnumerableServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '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_2'
              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_2'
              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
      operationId: getApiExtractionEntitydataByEntityIdByJourneyInstanceId
      x-operation-id-source: derived
    servers:
    - url: /smartdocs
  /api/extraction/state/{journeyInstanceId}/{taskId}:
    get:
      tags:
      - Extraction
      summary: Get Extraction State for a given journey and task
      description: 'Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch'
      parameters:
      - name: journeyInstanceId
        in: path
        description: Journey Instance Id
        required: true
        schema:
          type: string
          format: uuid
      - name: taskId
        in: path
        description: Task Id
        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
      responses:
        '200':
          description: Success. Extraction State returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtractionStateServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '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_2'
              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_2'
              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
      operationId: getApiExtractionStateByJourneyInstanceIdByTaskId
      x-operation-id-source: derived
    put:
      tags:
      - Extraction
      summary: Store Extraction State for a given journey and task
      description: 'Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch'
      parameters:
      - name: journeyInstanceId
        in: path
        description: Journey Instance Id
        required: true
        schema:
          type: string
          format: uuid
      - name: taskId
        in: path
        description: Task Id
        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: Extraction State
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ExtractionState'
      responses:
        '200':
          description: Success. Extraction State stored
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '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_2'
              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_2'
              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
      operationId: putApiExtractionStateByJourneyInstanceIdByTaskId
      x-operation-id-source: derived
    servers:
    - url: /smartdocs
  /api/extraction/status/{journeyInstanceId}:
    get:
      tags:
      - Extraction
      summary: Get Extraction Status for a given journey
      description: 'Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch'
      parameters:
      - name: journeyInstanceId
        in: path
        description: Journey Instance Id
        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
      responses:
        '200':
          description: Success. Extraction Status returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtractionStatusServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_2'
              example:
                data: {}
                messages:
                - message: Not Found
                  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_2'
              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_2'
              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
      operationId: getApiExtractionStatusByJourneyInstanceId
      x-operation-id-source: derived
    servers:
    - url: /smartdocs
components:
  schemas:
    AddExtractionResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
      additionalProperties: false
    UpdateExtractionStatusApiRequest:
      type: object
      properties:
        status:
          allOf:
          - $ref: '#/components/schemas/ExtractionStatus'
        sendWebSocketNotification:
          type:
          - boolean
          - 'null'
        errorDetails:
          allOf:
          - $ref: '#/components/schemas/ErrorDetails'
      additionalProperties: false
    ExtractionVersionResponse:
      type: object
      properties:
        current:
          type: integer
          format: int32
      additionalProperties: false
    HttpValidationProblemDetails:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
        errors:
          type:
          - object
          - 'null'
          additionalProperties:
            type: array
            items:
              type: string
      additionalProperties: {}
    DocumentStatus:
      enum:
      - 0
      - 1
      - 2
      type: integer
      format: int32
    ExtractionErrorCode:
      enum:
      - Unknown
      - PageLimitExceeded
      - KnowledgeBaseInactive
      - UnreadableDocument
      - KnowledgeBaseSyncTimeout
      type: string
    ExtractionHistoryResponse:
      type: object
      properties:
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ExtractionHistoryItemDto'
        totalCount:
          type: integer
          format: int32
        page:
          type: integer
          format: int32
        pageSize:
          type: integer
          format: int32
      additionalProperties: false
    UpdateExtractionStatusResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        status:
          allOf:
          - $ref: '#/components/schemas/ExtractionStatus'
      additionalProperties: false
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
          description: The message
          example: Success
        type:
          type:
          - string
          - 'null'
          description: 'Type of the message

            One of Info, Warning, Error, Forbidden'
          example: Info
        errorCode:
          type:
          - string
          - 'null'
          description: Error Code
          example: INTERNAL_SERVER_ERROR
      additionalProperties: false
      description: The message associated to the service response
    ExtractionHistoryDocumentDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        fileName:
          type:
          - string
          - 'null'
        jurisdictions:
          type:
          - array
          - 'null'
          items:
            type: string
        status:
          allOf:
          - $ref: '#/components/schemas/DocumentStatus'
        downloadAvailable:
          type: boolean
      additionalProperties: false
    ErrorDetails:
      required:
      - code
      type: object
      properties:
        code:
          allOf:
          - $ref: '#/components/schemas/ExtractionErrorCode'
        data:
          type:
          - object
          - 'null'
          additionalProperties:
            type: string
      additionalProperties: false
    ExtractionStatus:
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      type: integer
      format: int32
    ExtractionHistoryItemDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        createdDate:
          type: string
          format: date-time
        createdBy:
          type:
          - string
          - 'null'
        status:
          allOf:
          - $ref: '#/components/schemas/ExtractionStatus'
        documents:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ExtractionHistoryDocumentDto'
        documentName:
          type:
          - string
          - 'null'
        version:
          type:
          - integer
          - 'null'
          format: int32
        errorDetails:
          allOf:
          - $ref: '#/components/schemas/ErrorDetails'
      additionalProperties: false
    AddExtractionRequest:
      type: object
      properties:
        documentName:
          type:
          - string
          - 'null'
      additionalProperties: false
    ObjectServiceResponse:
      type: object
      properties:
        data:
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    ExtractionDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        createdDate:
          type: string
          format: date-time
        createdBy:
          type:
          - string
          - 'null'
        lastUpdatedDate:
          type: string
          format: date-time
        lastUpdatedBy:
          type:
          - string
          - 'null'
        status:
          allOf:
          - $ref: '#/components/schemas/ExtractionStatus'
        documentName:
          type:
          - string
          - 'null'
        version:
          type:
          - integer
          - 'null'
          format: int32
        errorDetails:
          allOf:
          - $ref: '#/components/schemas/ErrorDetails'
        pushBusinessProcessId:
          type:
          - string
          - 'null'
      additionalProperties: false
    GroupedDocumentDataExtractionServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/GroupedDocumentDataExtraction'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_2'
      additionalProperties: false
    DocumentEntityDataExtraction:
      type: object
      properties:
        documentModelId:
          type:
          - string
          - 'null'
        entityDataExtractions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityDataExtraction'
        entityDataCollectionExtractions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityDataCollectionExtraction'
      additionalProperties: false
    EntityDataBaseExtraction:
      type: object
      properties:
        dataKey:
          type:
          - string
          - 'null'
        explanation:
          type:
          - string
          - 'null'
        category:
          type:
          - string
          - 'null'
        documentModelId:
          type:
          - string
          - 'null'
        isSensitiveData:
          type:
          - boolean
          - 'null'
        fieldAccessLayer:
          allOf:
          - $ref: '#/components/schemas/AccessLayer'
      additionalProperties: false
    EntityDataExtraction:
      allOf:
      - $ref: '#/components/schemas/EntityDataBaseExtraction'
      - type: object
        properties:
          value:
            type:
            - string
            - 'null'
          id:
            type:
            - string
            - 'null'
          pageNumbers:
            type:
            - array
            - 'null'
            items:
              type: integer
              format: int32
        additionalProperties: false
    ExtractionState:
      type: object
      properties:
        singleValues:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/FieldState'
        collectionValues:
          type:
          - object
          - 'null'
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/CollectionState'
      additionalProperties: false
    AccessLayer:
      type: object
      properties:
        geographic:
          type:
          - array
          - 'null'
          items:
            type: string
        businessRelated:
          type:
          - array
          - 'null'
          items:
            type: string
      additionalProperties: false
    FieldState:
      allOf:
      - $ref: '#/components/schemas/BaseState'
      - type: object
        properties:
          overridenValue:
            type:
            - string
            - 'null'
        additionalProperties: false
    GroupedDocumentDataExtraction:
      type: object
      properties:
        extractedData:
          type:
          - object
          - 'null'
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/EntityDataExtraction'
        extractedCollections:
          type:
          - object
          - 'null'
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/EntityDataCollectionExtraction'
      additionalProperties: false
    EntityDataCollectionExtraction:
      allOf:
      - $ref: '#/components/schemas/EntityDataBaseExtraction'
      - type: object
        properties:
          dataGroupId:
            type:
            - string
            - 'null'
          collections:
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/EntityDataCollectionExtractionValue'
        additionalProperties: false
    ObjectServiceResponse_2:
      type: object
      properties:
        data: {}
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_2'
      additionalProperties: false
    ValidationErrorModelListServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ValidationErrorModel'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_2'
      additionalProperties: false
      example:
        data:
        - propertyName: data
          errorMessage: Data is required
          attemptedValue: ''
          errorCode: NotNullValidator
        messages:
        - message: Data is required
          type: Error
          errorCode: Error Code
    CollectionState:
      allOf:
      - $ref: '#/components/schemas/BaseState'
      - type: object
        properties:
          overridenValues:
            type:
            - object
            - 'null'
            additionalProperties:
              type: string
        additionalProperties: false
    BaseState:
      type: object
      properties:
        documentModelId:
          type:
          - string
          - 'null'
          format: uuid
        id:
          type:
          - string
          - 'null'
      additionalProperties: false
    StringServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_2'
      additionalProperties: false
    EntityDataCollectionExtractionValue:
      type: object
      properties:
        values:
          type:
          - object
          - 'null'
          additionalProperties:
            type: string
        explanations:
          type:
          - object
          - 'null'
          additionalProperties:
            type: string
        pageNumbers:
          type:
          - object
          - 'null'
          additionalProperties:
            type: array
            items:
              type: integer
              format: int32
        id:
          type:
          - string
          - 'null'
      additionalProperties: false
    ExtractionStatusServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/ExtractionStatus_2'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_2'
      additionalProperties: false
    DocumentEntityDataExtractionIEnumerableServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/DocumentEntityDataExtraction'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_2'
      additionalProperties: false
    ExtractionStateServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/ExtractionState'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_2'
      additionalProperties: false
    ValidationErrorModel:
      type: object
      properties:
        propertyName:
          type:
          - string
          - 'null'
        errorMessage:
          type:
          - string
          - 'null'
        attemptedValue: {}
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    ServiceResponseMessage_2:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    ExtractionStatus_2:
      type: object
      properties:
        journeyId:
          type:
          - string
          - 'null'
        entityId:
          type:
          - string
          - 'null'
        status:
          type:
          - string
          - 'null'
        tenant:
          type:
          - string
          - 'null'
        documentIds:
          type:
          - array
          - 'null'
          items:
            type: string
        error:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
        message:
          type:
          - string
          - 'null'
      additionalProperties: false
    DocumentEntityDataExtractionServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/DocumentEntityDataExtraction'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_2'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header
x-refined-from:
- fenergo-policyagent-v1-0-openapi.json
- fenergo-smartdocs-v1-0-openapi.json