openapi: 3.2.0
info:
  title: Fenergo Document Model API
  version: '1.0'
  description: 'Operations tagged DocumentModel across 3 of this provider''s published API definitions: fenergo-documentmanagementcommand-v1-0-openapi.json, fenergo-documentmanagementcommand-v2-0-openapi.json, fenergo-documentmanagementquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /documentmanagementcommand
- url: /documentmanagementquery
security:
- Bearer: []
tags:
- name: Document Model
paths:
  /api/documentmanagement:
    post:
      tags:
      - Document Model
      summary: Upload a document
      description: 'This method will upload the file in the AWS S3 bucket and publish an event to store the metadata related with the document.


        The method will return an object with some basic information to show the result to the user in the UI like status,

        document requirement and document type. The Id as well can be used in the query api to get the URL signed to show the document.


        Required permissions:

        Following permissions are required: DocumentManagementCreate'
      operationId: UploadDocumentModel
      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:
          multipart/form-data:
            schema:
              required:
              - Data.EntityId
              - Data.File
              type: object
              properties:
                Data.File:
                  type: string
                  description: File to be saved in the S3 storage
                  format: binary
                Data.EntityId:
                  type: string
                  description: Entity Id from FenX to link the document with the entity
                  example: e1809731-77df-4e72-98e7-0d314b7a5151
                Data.JourneyId:
                  type: string
                  description: Journey Id from FenX to link the document with the journey
                  example: 61413fc2-0381-48f5-825b-225692f4d793
                Data.DocumentType:
                  type: string
                  description: The type of the document
                  example: Driver license
                Data.FriendlyName:
                  type: string
                  description: The friendly name of the document
                Data.DocumentRequirementIds:
                  uniqueItems: true
                  type: array
                  items:
                    type: string
                  description: Hash Set of Document Requirement Ids from FenX to link the document to document requirements
                Data.DocumentDataKey:
                  type: string
                  description: The unique identifier of the document requirement that the document is linked to
                  example: identificationDocuments
                Data.Properties:
                  type: object
                  additionalProperties:
                    $ref: '#/components/schemas/PropertyDto'
                  description: Custom document properties.
                  example:
                    firstName:
                      type: Single
                      value: Tom
                    dateOfBirth:
                      type: Single
                      value: '2021-07-15'
                    address:
                      type: Collection
                      dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc
                      collections:
                        54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                          properties:
                            country: Ireland
                            city: Dublin
                            street: Mayor Street
                        47010265-3b85-4407-be61-90d04525f020:
                          properties:
                            country: Ireland
                            city: Dublin
                            street: E Wall Rd
            encoding:
              Data.File:
                style: form
              Data.EntityId:
                style: form
              Data.JourneyId:
                style: form
              Data.DocumentType:
                style: form
              Data.FriendlyName:
                style: form
              Data.DocumentRequirementIds:
                style: form
              Data.DocumentDataKey:
                style: form
              Data.Properties:
                style: form
      responses:
        '202':
          description: An instance of the Fenergo.Nebula.DocumentManagement.Command.Application.DTO.UploadDocumentResponseDto class with some metadata that represent the file uploaded
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/UploadDocumentResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/UploadDocumentResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/UploadDocumentResponseDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementcommand
  /api/documentmanagement/{id}:
    put:
      tags:
      - Document Model
      summary: Updates a document
      description: 'This method will update an existing Document Model with the data contained in the request Dto


        Required permissions:

        Following permissions are required: DocumentManagementEdit'
      operationId: UpdateDocument
      parameters:
      - name: id
        in: path
        description: The Id of the existing model to update
        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: The update document request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentDtoServiceRequest'
      responses:
        '202':
          description: Document Model updated successfully
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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
    delete:
      tags:
      - Document Model
      summary: Delete a document model
      description: 'Deletes the document model in the database, if the associated physical file is linked to multiple models it will remain in s3.

        On deletion of the last document model the physical file in s3 will also be removed.


        Required permissions:

        Following permissions are required: DocumentManagementDelete'
      operationId: DeleteDocumentModel
      parameters:
      - name: id
        in: path
        description: The id of the document existing
        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:
        '202':
          description: Document deleted successfully
        '400':
          description: Document not found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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:
      - Document Model
      summary: Get a document by id and tenant
      description: 'This method will get the document data for the document id and a tenant ID.


        Required permissions:

        Following permissions are required: DocumentManagementAccess'
      operationId: GetDocumentModelById
      parameters:
      - name: id
        in: path
        description: Id of an existing document
        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: "An instance of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentModelDto class representing the document metadata with the specified \n            id, if found; otherwise, `null`."
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DocumentModelDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentModelDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/DocumentModelDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not found. Document model 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: /documentmanagementcommand
  /api/documentmanagement/{id}/requirement-ids:
    put:
      tags:
      - Document Model
      summary: Update the requirements linked to a document
      description: 'This method will update the Document Requirement Ids linked to an existing Document Model


        Required permissions:

        At least one of the following permissions is required: DocumentManagementEdit, DocumentManagementDelete'
      operationId: UpdateRequirementIds
      parameters:
      - name: id
        in: path
        description: The Id of the existing model to update
        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: The list of requirements to update the document model with
        content:
          application/json:
            schema:
              uniqueItems: true
              type: array
              items:
                type: string
          text/json:
            schema:
              uniqueItems: true
              type: array
              items:
                type: string
          application/*+json:
            schema:
              uniqueItems: true
              type: array
              items:
                type: string
      responses:
        '202':
          description: Document Model updated successfully
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementcommand
  /api/documentmanagement/updateFile:
    put:
      tags:
      - Document Model
      summary: Update a document
      description: 'This method will generate an URL signed to upload the stream to update an existing Document File in the S3 bucket.


        Required permissions:

        At least one of the following permissions is required: DocumentManagementEdit, DocumentManagementCreate'
      operationId: UpdateDocumentFile
      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:
          multipart/form-data:
            schema:
              required:
              - Data.File
              - Data.Id
              type: object
              properties:
                Data.Id:
                  type: string
                  description: Id of the document
                  example: e8854547-40af-478f-8013-cd10c13e7f94
                Data.File:
                  type: string
                  description: File to be saved in the S3 storage
                  format: binary
            encoding:
              Data.Id:
                style: form
              Data.File:
                style: form
      responses:
        '202':
          description: Document Model updated successfully
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/UpdateDocumentFileResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateDocumentFileResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/UpdateDocumentFileResponseDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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
      deprecated: true
    servers:
    - url: /documentmanagementcommand
  /api/documentmanagement/{id}/datakey:
    put:
      tags:
      - Document Model
      summary: Update the requirement datakey linked to a document
      description: 'This method will update the Document Requirement Ids linked to an existing Document Model


        Required permissions:

        At least one of the following permissions is required: DocumentManagementEdit, DocumentManagementDelete'
      operationId: UpdateDataKey
      parameters:
      - name: id
        in: path
        description: The Id of the existing model to update
        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: The datakey of requirement to update the document model with
        content:
          application/json:
            schema:
              type: string
          text/json:
            schema:
              type: string
          application/*+json:
            schema:
              type: string
      responses:
        '202':
          description: Document Model updated successfully
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementcommand
  /api/v2/documentmanagement:
    post:
      tags:
      - Document Model
      summary: Save document metadata and generate the URL to upload the file…
      description: 'This method will create the document model metadata and generate a signed URL to allow

        the user to upload the actual file directly in the AWS S3 bucket.


        The method will return an object with some basic information to show the result to the user in the UI like status,

        document requirement and document type. The response also contains the URL to upload the file in the S3 bucket.


        Required permissions:

        At least one of the following permissions is required: DocumentManagementCreate, DocumentManagementEdit'
      operationId: CreateDocumentModel
      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: The upload document request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateSignedUrlToUploadFileRequestServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateSignedUrlToUploadFileRequestServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateSignedUrlToUploadFileRequestServiceRequest'
      responses:
        '202':
          description: An instance of the Fenergo.Nebula.DocumentManagement.Command.Application.DTO.CreateSignedUrlToUploadFileResponse class with some metadata that represent the file uploaded
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CreateSignedUrlToUploadFileResponseServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSignedUrlToUploadFileResponseServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CreateSignedUrlToUploadFileResponseServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementcommand
  /api/v2/documentmanagement/product/CreateDocumentModel:
    post:
      tags:
      - Document Model
      summary: Save document metadata and generate the URL to upload the file…
      description: 'This method will create the document model metadata and generate a signed URL to allow

        the user to upload the actual file directly in the AWS S3 bucket.


        The method will return an object with some basic information to show the result to the user in the UI like status,

        document requirement and document type. The response also contains the URL to upload the file in the S3 bucket.


        Required permissions:

        At least one of the following permissions is required: DocumentManagementCreate, DocumentManagementEdit'
      operationId: product/CreateDocumentModel
      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: The upload document request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateSignedUrlToUploadFileRequestServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateSignedUrlToUploadFileRequestServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateSignedUrlToUploadFileRequestServiceRequest'
      responses:
        '202':
          description: An instance of the Fenergo.Nebula.DocumentManagement.Command.Application.DTO.CreateSignedUrlToUploadFileResponse class with some metadata that represent the file uploaded
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CreateSignedUrlToUploadFileResponseServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSignedUrlToUploadFileResponseServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CreateSignedUrlToUploadFileResponseServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementcommand
  /api/v2/documentmanagement/deal/CreateDocumentModel:
    post:
      tags:
      - Document Model
      summary: Save document metadata and generate the URL to upload the file…
      description: 'This method will create the document model metadata and generate a signed URL to allow

        the user to upload the actual file directly in the AWS S3 bucket.


        The method will return an object with some basic information to show the result to the user in the UI like status,

        document requirement and document type. The response also contains the URL to upload the file in the S3 bucket.


        Required permissions:

        At least one of the following permissions is required: DocumentManagementCreate, DocumentManagementEdit'
      operationId: deal/CreateDocumentModel
      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: The upload document request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateSignedUrlToUploadFileRequestServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateSignedUrlToUploadFileRequestServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateSignedUrlToUploadFileRequestServiceRequest'
      responses:
        '202':
          description: An instance of the Fenergo.Nebula.DocumentManagement.Command.Application.DTO.CreateSignedUrlToUploadFileResponse class with some metadata that represent the file uploaded
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CreateSignedUrlToUploadFileResponseServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSignedUrlToUploadFileResponseServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CreateSignedUrlToUploadFileResponseServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementcommand
  /api/v2/documentmanagement/archiveAndReplace:
    post:
      tags:
      - Document Model
      summary: Archive the document and add new document with metadata and generate the URL to…
      description: 'This method will archive existing document and create the document model metadata and generate a signed URL to allow

        the user to upload the actual file directly in the AWS S3 bucket.


        The method will return an object with some basic information to show the result to the user in the UI like status,

        document requirement and document type. The response also contains the URL to upload the file in the S3 bucket.


        Required permissions:

        At least one of the following permissions is required: DocumentManagementArchive, DocumentManagementArchiveV2'
      operationId: ArchiveAndReplaceDocumentModel
      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: The upload document request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ArchiveAndReplaceDocumentRequestServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ArchiveAndReplaceDocumentRequestServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ArchiveAndReplaceDocumentRequestServiceRequest'
      responses:
        '202':
          description: An instance of the Fenergo.Nebula.DocumentManagement.Command.Application.DTO.CreateSignedUrlToUploadFileResponse class with some metadata that represent the file uploaded
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CreateSignedUrlToUploadFileResponseServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSignedUrlToUploadFileResponseServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CreateSignedUrlToUploadFileResponseServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementcommand
  /api/v2/documentmanagement/product/ArchiveAndReplaceDocumentModel:
    post:
      tags:
      - Document Model
      summary: Archive the document and add new document with metadata and generate the URL to…
      description: 'This method will archive existing document and create the document model metadata and generate a signed URL to allow

        the user to upload the actual file directly in the AWS S3 bucket.


        The method will return an object with some basic information to show the result to the user in the UI like status,

        document requirement and document type. The response also contains the URL to upload the file in the S3 bucket.


        Required permissions:

        At least one of the following permissions is required: DocumentManagementArchive, DocumentManagementArchiveV2'
      operationId: product/ArchiveAndReplaceDocumentModel
      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: The upload document request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ArchiveAndReplaceDocumentRequestServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ArchiveAndReplaceDocumentRequestServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ArchiveAndReplaceDocumentRequestServiceRequest'
      responses:
        '202':
          description: An instance of the Fenergo.Nebula.DocumentManagement.Command.Application.DTO.CreateSignedUrlToUploadFileResponse class with some metadata that represent the file uploaded
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CreateSignedUrlToUploadFileResponseServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSignedUrlToUploadFileResponseServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CreateSignedUrlToUploadFileResponseServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementcommand
  /api/v2/documentmanagement/deal/ArchiveAndReplaceDocumentModel:
    post:
      tags:
      - Document Model
      summary: Archive the document and add new document with metadata and generate the URL to…
      description: 'This method will archive existing document and create the document model metadata and generate a signed URL to allow

        the user to upload the actual file directly in the AWS S3 bucket.


        The method will return an object with some basic information to show the result to the user in the UI like status,

        document requirement and document type. The response also contains the URL to upload the file in the S3 bucket.


        Required permissions:

        At least one of the following permissions is required: DocumentManagementArchive, DocumentManagementArchiveV2'
      operationId: deal/ArchiveAndReplaceDocumentModel
      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: The upload document request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ArchiveAndReplaceDocumentRequestServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ArchiveAndReplaceDocumentRequestServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ArchiveAndReplaceDocumentRequestServiceRequest'
      responses:
        '202':
          description: An instance of the Fenergo.Nebula.DocumentManagement.Command.Application.DTO.CreateSignedUrlToUploadFileResponse class with some metadata that represent the file uploaded
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CreateSignedUrlToUploadFileResponseServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSignedUrlToUploadFileResponseServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CreateSignedUrlToUploadFileResponseServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementcommand
  /api/v2/documentmanagement/virtual:
    post:
      tags:
      - Document Model
      summary: Save document metadata including the URL to the virtual file…
      description: 'This method will create the document model metadata including URL to allow

        the user to access a file stored in an external system.


        The method will return an object with some basic information about the virtual document. The response also contains the URL to the file.


        Required permissions:

        Following permissions are required: DocumentManagementCreateVirtual'
      operationId: CreateVirtualDocumentModel
      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: The virtual document request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateVirtualDocRequestDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateVirtualDocRequestDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateVirtualDocRequestDtoServiceRequest'
      responses:
        '202':
          description: An instance of the Fenergo.Nebula.DocumentManagement.Command.Application.DTO.VirtualDocument.CreateVirtualDocResponseDto class with some metadata that represent the virtual file
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CreateVirtualDocResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CreateVirtualDocResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CreateVirtualDocResponseDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementcommand
  /api/v2/documentmanagement/product/virtual:
    post:
      tags:
      - Document Model
      summary: Save document metadata including the URL to the virtual file…
      description: 'This method will create the document model metadata including URL to allow

        the user to access a file stored in an external system.


        The method will return an object with some basic information about the virtual document. The response also contains the URL to the file.


        Required permissions:

        Following permissions are required: DocumentManagementCreateVirtual'
      operationId: product/CreateVirtualDocumentModel
      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: The virtual document request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateVirtualDocRequestDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateVirtualDocRequestDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateVirtualDocRequestDtoServiceRequest'
      responses:
        '202':
          description: An instance of the Fenergo.Nebula.DocumentManagement.Command.Application.DTO.VirtualDocument.CreateVirtualDocResponseDto class with some metadata that represent the virtual file
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CreateVirtualDocResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CreateVirtualDocResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CreateVirtualDocResponseDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementcommand
  /api/v2/documentmanagement/deal/virtual:
    post:
      tags:
      - Document Model
      summary: Save document metadata including the URL to the virtual file…
      description: 'This method will create the document model metadata including URL to allow

        the user to access a file stored in an external system.


        The method will return an object with some basic information about the virtual document. The response also contains the URL to the file.


        Required permissions:

        Following permissions are required: DocumentManagementCreateVirtual'
      operationId: deal/CreateVirtualDocumentModel
      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: The virtual document request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateVirtualDocRequestDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateVirtualDocRequestDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateVirtualDocRequestDtoServiceRequest'
      responses:
        '202':
          description: An instance of the Fenergo.Nebula.DocumentManagement.Command.Application.DTO.VirtualDocument.CreateVirtualDocResponseDto class with some metadata that represent the virtual file
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CreateVirtualDocResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CreateVirtualDocResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CreateVirtualDocResponseDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementcommand
  /api/v2/documentmanagement/updateFile:
    put:
      tags:
      - Document Model
      summary: Generate URL to upload the new document file - UpdateFile
      description: 'This method will generate an URL signed to upload the stream to update an existing Document File in the S3 bucket.


        Required permissions:

        At least one of the following permissions is required: DocumentManagementCreate, DocumentManagementEdit'
      operationId: UpdateFile
      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: The update document file request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentFileDtoV2ServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentFileDtoV2ServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentFileDtoV2ServiceRequest'
      responses:
        '202':
          description: Document Model updated successfully
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/UpdateDocumentFileResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateDocumentFileResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/UpdateDocumentFileResponseDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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
      deprecated: true
    servers:
    - url: /documentmanagementcommand
  /api/v2/documentmanagement/{id}/access-layers:
    put:
      tags:
      - Document Model
      summary: Update document model access layers - UpdateDocumentAccessLayers
      description: 'Updates access layers of the document model.


        Required permissions:

        Following permissions are required: DocumentManagementEdit'
      operationId: UpdateDocumentAccessLayers
      parameters:
      - name: id
        in: path
        description: Document model 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: Update document model access layers request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentAccessLayersDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentAccessLayersDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentAccessLayersDtoServiceRequest'
      responses:
        '202':
          description: Success. Document model access layers updated
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not found. Document model with given id does not exist
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementcommand
  /api/v2/documentmanagement/product/{id}/access-layers:
    put:
      tags:
      - Document Model
      summary: Update document model access layers - product/UpdateDocumentAccessLayers
      description: 'Updates access layers of the document model.


        Required permissions:

        Following permissions are required: DocumentManagementEdit'
      operationId: product/UpdateDocumentAccessLayers
      parameters:
      - name: id
        in: path
        description: Document model 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: Update document model access layers request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentAccessLayersDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentAccessLayersDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentAccessLayersDtoServiceRequest'
      responses:
        '202':
          description: Success. Document model access layers updated
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not found. Document model with given id does not exist
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementcommand
  /api/v2/documentmanagement/deal/{id}/access-layers:
    put:
      tags:
      - Document Model
      summary: Update document model access layers - deal/UpdateDocumentAccessLayers
      description: 'Updates access layers of the document model.


        Required permissions:

        Following permissions are required: DocumentManagementEdit'
      operationId: deal/UpdateDocumentAccessLayers
      parameters:
      - name: id
        in: path
        description: Document model 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: Update document model access layers request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentAccessLayersDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentAccessLayersDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentAccessLayersDtoServiceRequest'
      responses:
        '202':
          description: Success. Document model access layers updated
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not found. Document model with given id does not exist
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementcommand
  /api/v2/documentmanagement/CreateDocumentModelMultipleRequirements:
    post:
      tags:
      - Document Model
      summary: Save document metadata and generate the URL to upload the file for multiple…
      description: 'This method will create the document model metadata and generate a signed URL to allow

        the user to upload the actual file directly in the AWS S3 bucket. When multiple document Requirements need to be fulfilled


        The method will return an object with some basic information to show the result to the user in the UI like status,

        document requirement and document type. The response also contains the URL to upload the file in the S3 bucket.


        Required permissions:

        At least one of the following permissions is required: DocumentManagementCreate, DocumentManagementEdit'
      operationId: CreateDocumentModelMultipleRequirements
      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: The upload multiple document requirements request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateSignedUrlToUploadFileMultipleRequirementsRequestServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateSignedUrlToUploadFileMultipleRequirementsRequestServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateSignedUrlToUploadFileMultipleRequirementsRequestServiceRequest'
      responses:
        '202':
          description: An instance of the Fenergo.Nebula.DocumentManagement.Command.Application.DTO.CreateSignedUrlToUploadFileMultipleRequirementsResponse class with some metadata that represent the files uploaded
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CreateSignedUrlToUploadFileMultipleRequirementsResponseServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSignedUrlToUploadFileMultipleRequirementsResponseServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CreateSignedUrlToUploadFileMultipleRequirementsResponseServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not found. Document model or Document Requirement model 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: /documentmanagementcommand
  /api/v2/documentmanagement/product/CreateDocumentModelMultipleRequirements:
    post:
      tags:
      - Document Model
      summary: Save document metadata and generate the URL to upload the file for multiple…
      description: 'This method will create the document model metadata and generate a signed URL to allow

        the user to upload the actual file directly in the AWS S3 bucket. When multiple document Requirements need to be fulfilled


        The method will return an object with some basic information to show the result to the user in the UI like status,

        document requirement and document type. The response also contains the URL to upload the file in the S3 bucket.


        Required permissions:

        At least one of the following permissions is required: DocumentManagementCreate, DocumentManagementEdit'
      operationId: product/CreateDocumentModelMultipleRequirements
      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: The upload multiple document requirements request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateSignedUrlToUploadFileMultipleRequirementsRequestServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateSignedUrlToUploadFileMultipleRequirementsRequestServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateSignedUrlToUploadFileMultipleRequirementsRequestServiceRequest'
      responses:
        '202':
          description: An instance of the Fenergo.Nebula.DocumentManagement.Command.Application.DTO.CreateSignedUrlToUploadFileMultipleRequirementsResponse class with some metadata that represent the files uploaded
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CreateSignedUrlToUploadFileMultipleRequirementsResponseServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSignedUrlToUploadFileMultipleRequirementsResponseServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CreateSignedUrlToUploadFileMultipleRequirementsResponseServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not found. Document model or Document Requirement model 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: /documentmanagementcommand
  /api/v2/documentmanagement/deal/CreateDocumentModelMultipleRequirements:
    post:
      tags:
      - Document Model
      summary: Save document metadata and generate the URL to upload the file for multiple…
      description: 'This method will create the document model metadata and generate a signed URL to allow

        the user to upload the actual file directly in the AWS S3 bucket. When multiple document Requirements need to be fulfilled


        The method will return an object with some basic information to show the result to the user in the UI like status,

        document requirement and document type. The response also contains the URL to upload the file in the S3 bucket.


        Required permissions:

        At least one of the following permissions is required: DocumentManagementCreate, DocumentManagementEdit'
      operationId: deal/CreateDocumentModelMultipleRequirements
      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: The upload multiple document requirements request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateSignedUrlToUploadFileMultipleRequirementsRequestServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateSignedUrlToUploadFileMultipleRequirementsRequestServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateSignedUrlToUploadFileMultipleRequirementsRequestServiceRequest'
      responses:
        '202':
          description: An instance of the Fenergo.Nebula.DocumentManagement.Command.Application.DTO.CreateSignedUrlToUploadFileMultipleRequirementsResponse class with some metadata that represent the files uploaded
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CreateSignedUrlToUploadFileMultipleRequirementsResponseServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSignedUrlToUploadFileMultipleRequirementsResponseServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CreateSignedUrlToUploadFileMultipleRequirementsResponseServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not found. Document model or Document Requirement model 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: /documentmanagementcommand
  /api/v2/documentmanagement/virtual/multiple-requirements:
    post:
      tags:
      - Document Model
      summary: Save document metadata including the URL to the virtual file for multiple…
      description: 'This method will create the document model metadata including URL to allow

        the user to access a file stored in an external system. When multiple document Requirements need to be fulfilled


        The method will return an object with some basic information about the virtual document. The response also contains the URL to the file.


        Required permissions:

        Following permissions are required: DocumentManagementCreateVirtual'
      operationId: CreateVirtualDocumentModelMultipleRequirements
      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: The virtual document multiple requirements request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateVirtualDocMultipleReqsRequestDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateVirtualDocMultipleReqsRequestDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateVirtualDocMultipleReqsRequestDtoServiceRequest'
      responses:
        '202':
          description: An list of the Fenergo.Nebula.DocumentManagement.Command.Application.DTO.VirtualDocument.CreateVirtualDocResponseDto class with some metadata that represent the virtual files
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CreateVirtualDocResponseDtoListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CreateVirtualDocResponseDtoListServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CreateVirtualDocResponseDtoListServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementcommand
  /api/v2/documentmanagement/product/virtual/multiple-requirements:
    post:
      tags:
      - Document Model
      summary: Save document metadata including the URL to the virtual file for multiple…
      description: 'This method will create the document model metadata including URL to allow

        the user to access a file stored in an external system. When multiple document Requirements need to be fulfilled


        The method will return an object with some basic information about the virtual document. The response also contains the URL to the file.


        Required permissions:

        Following permissions are required: DocumentManagementCreateVirtual'
      operationId: product/CreateVirtualDocumentModelMultipleRequirements
      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: The virtual document multiple requirements request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateVirtualDocMultipleReqsRequestDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateVirtualDocMultipleReqsRequestDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateVirtualDocMultipleReqsRequestDtoServiceRequest'
      responses:
        '202':
          description: An list of the Fenergo.Nebula.DocumentManagement.Command.Application.DTO.VirtualDocument.CreateVirtualDocResponseDto class with some metadata that represent the virtual files
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CreateVirtualDocResponseDtoListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CreateVirtualDocResponseDtoListServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CreateVirtualDocResponseDtoListServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementcommand
  /api/v2/documentmanagement/deal/virtual/multiple-requirements:
    post:
      tags:
      - Document Model
      summary: Save document metadata including the URL to the virtual file for multiple…
      description: 'This method will create the document model metadata including URL to allow

        the user to access a file stored in an external system. When multiple document Requirements need to be fulfilled


        The method will return an object with some basic information about the virtual document. The response also contains the URL to the file.


        Required permissions:

        Following permissions are required: DocumentManagementCreateVirtual'
      operationId: deal/CreateVirtualDocumentModelMultipleRequirements
      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: The virtual document multiple requirements request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateVirtualDocMultipleReqsRequestDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateVirtualDocMultipleReqsRequestDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateVirtualDocMultipleReqsRequestDtoServiceRequest'
      responses:
        '202':
          description: An list of the Fenergo.Nebula.DocumentManagement.Command.Application.DTO.VirtualDocument.CreateVirtualDocResponseDto class with some metadata that represent the virtual files
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CreateVirtualDocResponseDtoListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CreateVirtualDocResponseDtoListServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CreateVirtualDocResponseDtoListServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementcommand
  /api/v2/documentmanagement/{id}/clone:
    put:
      tags:
      - Document Model
      summary: Clones Document Model which references Original Physical File…
      description: 'Clones Document Model


        Required permissions:

        At least one of the following permissions is required: DocumentManagementCreate, DocumentManagementCreateVirtual, DocumentManagementLink'
      operationId: CloneDocumentModel
      parameters:
      - name: id
        in: path
        description: Document model 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: Update document model access layers request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CloneDocumentModelRequestDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CloneDocumentModelRequestDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CloneDocumentModelRequestDtoServiceRequest'
      responses:
        '202':
          description: Success. Document model access layers updated
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CloneDocumentResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CloneDocumentResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CloneDocumentResponseDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not found. Document model or Document Requirement model 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: /documentmanagementcommand
  /api/v2/documentmanagement/product/{id}/clone:
    put:
      tags:
      - Document Model
      summary: Clones Document Model which references Original Physical File…
      description: 'Clones Document Model


        Required permissions:

        At least one of the following permissions is required: DocumentManagementCreate, DocumentManagementCreateVirtual, DocumentManagementLink'
      operationId: product/CloneDocumentModel
      parameters:
      - name: id
        in: path
        description: Document model 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: Update document model access layers request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CloneDocumentModelRequestDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CloneDocumentModelRequestDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CloneDocumentModelRequestDtoServiceRequest'
      responses:
        '202':
          description: Success. Document model access layers updated
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CloneDocumentResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CloneDocumentResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CloneDocumentResponseDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not found. Document model or Document Requirement model 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: /documentmanagementcommand
  /api/v2/documentmanagement/deal/{id}/clone:
    put:
      tags:
      - Document Model
      summary: Clones Document Model which references Original Physical File…
      description: 'Clones Document Model


        Required permissions:

        At least one of the following permissions is required: DocumentManagementCreate, DocumentManagementCreateVirtual, DocumentManagementLink'
      operationId: deal/CloneDocumentModel
      parameters:
      - name: id
        in: path
        description: Document model 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: Update document model access layers request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CloneDocumentModelRequestDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CloneDocumentModelRequestDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CloneDocumentModelRequestDtoServiceRequest'
      responses:
        '202':
          description: Success. Document model access layers updated
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CloneDocumentResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CloneDocumentResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CloneDocumentResponseDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not found. Document model or Document Requirement model 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: /documentmanagementcommand
  /api/v2/documentmanagement/error/{id}:
    put:
      tags:
      - Document Model
      summary: Update Document Model Status to 'Error' - UpdateDocumentModelStatusError
      description: 'Update Document Model to the status of error


        Required permissions:

        Following permissions are required: DocumentManagementEdit'
      operationId: UpdateDocumentModelStatusError
      parameters:
      - name: id
        in: path
        description: Document model 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:
        '202':
          description: Success. Document model status updated
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not found. Document model with given id does not exist
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementcommand
  /api/v2/documentmanagement/product/error/{id}:
    put:
      tags:
      - Document Model
      summary: Update Document Model Status to 'Error' - product/UpdateDocumentModelStatusError
      description: 'Update Document Model to the status of error


        Required permissions:

        Following permissions are required: DocumentManagementEdit'
      operationId: product/UpdateDocumentModelStatusError
      parameters:
      - name: id
        in: path
        description: Document model 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:
        '202':
          description: Success. Document model status updated
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not found. Document model with given id does not exist
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementcommand
  /api/v2/documentmanagement/deal/error/{id}:
    put:
      tags:
      - Document Model
      summary: Update Document Model Status to 'Error' - deal/UpdateDocumentModelStatusError
      description: 'Update Document Model to the status of error


        Required permissions:

        Following permissions are required: DocumentManagementEdit'
      operationId: deal/UpdateDocumentModelStatusError
      parameters:
      - name: id
        in: path
        description: Document model 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:
        '202':
          description: Success. Document model status updated
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not found. Document model with given id does not exist
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementcommand
  /api/v2/documentmanagement/custom-error/{id}:
    put:
      tags:
      - Document Model
      summary: Update Document Model Status to 'Error' with custom error code and message…
      description: 'Update Document Model to the status of error and include a custom error code and message


        Required permissions:

        Following permissions are required: DocumentManagementEdit'
      operationId: UpdateDocumentModelCustomError
      parameters:
      - name: id
        in: path
        description: Document model 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: The document status error request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentStatusErrorDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentStatusErrorDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentStatusErrorDtoServiceRequest'
      responses:
        '202':
          description: Success. Document model status updated
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not found. Document model with given id does not exist
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementcommand
  /api/v2/documentmanagement/product/custom-error/{id}:
    put:
      tags:
      - Document Model
      summary: Update Document Model Status to 'Error' with custom error code and message…
      description: 'Update Document Model to the status of error and include a custom error code and message


        Required permissions:

        Following permissions are required: DocumentManagementEdit'
      operationId: product/UpdateDocumentModelCustomError
      parameters:
      - name: id
        in: path
        description: Document model 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: The document status error request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentStatusErrorDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentStatusErrorDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentStatusErrorDtoServiceRequest'
      responses:
        '202':
          description: Success. Document model status updated
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not found. Document model with given id does not exist
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementcommand
  /api/v2/documentmanagement/deal/custom-error/{id}:
    put:
      tags:
      - Document Model
      summary: Update Document Model Status to 'Error' with custom error code and message…
      description: 'Update Document Model to the status of error and include a custom error code and message


        Required permissions:

        Following permissions are required: DocumentManagementEdit'
      operationId: deal/UpdateDocumentModelCustomError
      parameters:
      - name: id
        in: path
        description: Document model 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: The document status error request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentStatusErrorDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentStatusErrorDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentStatusErrorDtoServiceRequest'
      responses:
        '202':
          description: Success. Document model status updated
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not found. Document model with given id does not exist
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementcommand
  /api/v2/documentmanagement/{id}:
    put:
      tags:
      - Document Model
      summary: Updates a document - UpdateDocument
      description: 'This method will update an existing Document Model with the data contained in the request Dto


        Required permissions:

        Following permissions are required: DocumentManagementEdit'
      operationId: putApiV2DocumentmanagementById
      parameters:
      - name: id
        in: path
        description: The Id of the existing model to update
        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: The update document request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentDtoServiceRequest'
      responses:
        '202':
          description: Document Model updated successfully
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not found. Document model or Document Requirement model 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
      x-operation-id-source: normalized
      x-operation-id-original: UpdateDocument
    delete:
      tags:
      - Document Model
      summary: Delete a document model - DeleteDocumentModel
      description: 'Deletes the document model in the database, if the associated physical file is linked to multiple models it will remain in s3.

        On deletion of the last document model the physical file in s3 will also be removed.


        Required permissions:

        Following permissions are required: DocumentManagementDelete'
      operationId: deleteApiV2DocumentmanagementById
      parameters:
      - name: id
        in: path
        description: The id of the document existing
        required: true
        schema:
          type: string
          format: uuid
      - name: requirementModelId
        in: query
        description: The id of the requirement the document model was linked to
        schema:
          type: string
          format: uuid
      - name: skipStatusReset
        in: query
        description: Skip status reset to In Progress step after document is deleted
        schema:
          type: boolean
          default: false
      - 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:
        '202':
          description: Document deleted successfully
        '400':
          description: Document not found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not found. Document model or Document Requirement model 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
      x-operation-id-source: normalized
      x-operation-id-original: DeleteDocumentModel
    servers:
    - url: /documentmanagementcommand
  /api/v2/documentmanagement/product/{id}:
    put:
      tags:
      - Document Model
      summary: Updates a document - product/UpdateDocument
      description: 'This method will update an existing Document Model with the data contained in the request Dto


        Required permissions:

        Following permissions are required: DocumentManagementEdit'
      operationId: product/UpdateDocument
      parameters:
      - name: id
        in: path
        description: The Id of the existing model to update
        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: The update document request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentDtoServiceRequest'
      responses:
        '202':
          description: Document Model updated successfully
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not found. Document model or Document Requirement model 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
    delete:
      tags:
      - Document Model
      summary: Delete a document model - product/DeleteDocumentModel
      description: 'Deletes the document model in the database, if the associated physical file is linked to multiple models it will remain in s3.

        On deletion of the last document model the physical file in s3 will also be removed.


        Required permissions:

        Following permissions are required: DocumentManagementDelete'
      operationId: product/DeleteDocumentModel
      parameters:
      - name: id
        in: path
        description: The id of the document existing
        required: true
        schema:
          type: string
          format: uuid
      - name: requirementModelId
        in: query
        description: The id of the requirement the document model was linked to
        schema:
          type: string
          format: uuid
      - name: skipStatusReset
        in: query
        description: Skip status reset to In Progress step after document is deleted
        schema:
          type: boolean
          default: false
      - 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:
        '202':
          description: Document deleted successfully
        '400':
          description: Document not found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not found. Document model or Document Requirement model 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: /documentmanagementcommand
  /api/v2/documentmanagement/deal/{id}:
    put:
      tags:
      - Document Model
      summary: Updates a document - deal/UpdateDocument
      description: 'This method will update an existing Document Model with the data contained in the request Dto


        Required permissions:

        Following permissions are required: DocumentManagementEdit'
      operationId: deal/UpdateDocument
      parameters:
      - name: id
        in: path
        description: The Id of the existing model to update
        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: The update document request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateDocumentDtoServiceRequest'
      responses:
        '202':
          description: Document Model updated successfully
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not found. Document model or Document Requirement model 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
    delete:
      tags:
      - Document Model
      summary: Delete a document model - deal/DeleteDocumentModel
      description: 'Deletes the document model in the database, if the associated physical file is linked to multiple models it will remain in s3.

        On deletion of the last document model the physical file in s3 will also be removed.


        Required permissions:

        Following permissions are required: DocumentManagementDelete'
      operationId: deal/DeleteDocumentModel
      parameters:
      - name: id
        in: path
        description: The id of the document existing
        required: true
        schema:
          type: string
          format: uuid
      - name: requirementModelId
        in: query
        description: The id of the requirement the document model was linked to
        schema:
          type: string
          format: uuid
      - name: skipStatusReset
        in: query
        description: Skip status reset to In Progress step after document is deleted
        schema:
          type: boolean
          default: false
      - 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:
        '202':
          description: Document deleted successfully
        '400':
          description: Document not found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not found. Document model or Document Requirement model 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: /documentmanagementcommand
  /api/v2/documentmanagement/{id}/requirement-ids:
    put:
      tags:
      - Document Model
      summary: Update the requirements linked to a document - UpdateRequirementIds
      description: 'This method will update the Document Requirement Ids linked to an existing Document Model


        Required permissions:

        At least one of the following permissions is required: DocumentManagementEdit, DocumentManagementDelete'
      operationId: putApiV2DocumentmanagementByIdRequirementIds
      parameters:
      - name: id
        in: path
        description: The Id of the existing model to update
        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: The list of requirements to update the document model with
        content:
          application/json:
            schema:
              uniqueItems: true
              type: array
              items:
                type: string
          text/json:
            schema:
              uniqueItems: true
              type: array
              items:
                type: string
          application/*+json:
            schema:
              uniqueItems: true
              type: array
              items:
                type: string
      responses:
        '202':
          description: Document Model updated successfully
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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
      x-operation-id-source: normalized
      x-operation-id-original: UpdateRequirementIds
    servers:
    - url: /documentmanagementcommand
  /api/v2/documentmanagement/product/{id}/requirement-ids:
    put:
      tags:
      - Document Model
      summary: Update the requirements linked to a document - product/UpdateRequirementIds
      description: 'This method will update the Document Requirement Ids linked to an existing Document Model


        Required permissions:

        At least one of the following permissions is required: DocumentManagementEdit, DocumentManagementDelete'
      operationId: product/UpdateRequirementIds
      parameters:
      - name: id
        in: path
        description: The Id of the existing model to update
        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: The list of requirements to update the document model with
        content:
          application/json:
            schema:
              uniqueItems: true
              type: array
              items:
                type: string
          text/json:
            schema:
              uniqueItems: true
              type: array
              items:
                type: string
          application/*+json:
            schema:
              uniqueItems: true
              type: array
              items:
                type: string
      responses:
        '202':
          description: Document Model updated successfully
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementcommand
  /api/v2/documentmanagement/deal/{id}/requirement-ids:
    put:
      tags:
      - Document Model
      summary: Update the requirements linked to a document - deal/UpdateRequirementIds
      description: 'This method will update the Document Requirement Ids linked to an existing Document Model


        Required permissions:

        At least one of the following permissions is required: DocumentManagementEdit, DocumentManagementDelete'
      operationId: deal/UpdateRequirementIds
      parameters:
      - name: id
        in: path
        description: The Id of the existing model to update
        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: The list of requirements to update the document model with
        content:
          application/json:
            schema:
              uniqueItems: true
              type: array
              items:
                type: string
          text/json:
            schema:
              uniqueItems: true
              type: array
              items:
                type: string
          application/*+json:
            schema:
              uniqueItems: true
              type: array
              items:
                type: string
      responses:
        '202':
          description: Document Model updated successfully
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementcommand
  /api/v2/documentmanagement/{id}/datakey:
    put:
      tags:
      - Document Model
      summary: Update the requirement datakey linked to a document - UpdateDataKey
      description: 'This method will update the Document Requirement Ids linked to an existing Document Model


        Required permissions:

        At least one of the following permissions is required: DocumentManagementEdit, DocumentManagementDelete'
      operationId: putApiV2DocumentmanagementByIdDatakey
      parameters:
      - name: id
        in: path
        description: The Id of the existing model to update
        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: The datakey of requirement to update the document model with
        content:
          application/json:
            schema:
              type: string
          text/json:
            schema:
              type: string
          application/*+json:
            schema:
              type: string
      responses:
        '202':
          description: Document Model updated successfully
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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
      x-operation-id-source: normalized
      x-operation-id-original: UpdateDataKey
    servers:
    - url: /documentmanagementcommand
  /api/v2/documentmanagement/product/{id}/datakey:
    put:
      tags:
      - Document Model
      summary: Update the requirement datakey linked to a document - product/UpdateDataKey
      description: 'This method will update the Document Requirement Ids linked to an existing Document Model


        Required permissions:

        At least one of the following permissions is required: DocumentManagementEdit, DocumentManagementDelete'
      operationId: product/UpdateDataKey
      parameters:
      - name: id
        in: path
        description: The Id of the existing model to update
        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: The datakey of requirement to update the document model with
        content:
          application/json:
            schema:
              type: string
          text/json:
            schema:
              type: string
          application/*+json:
            schema:
              type: string
      responses:
        '202':
          description: Document Model updated successfully
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementcommand
  /api/v2/documentmanagement/deal/{id}/datakey:
    put:
      tags:
      - Document Model
      summary: Update the requirement datakey linked to a document - deal/UpdateDataKey
      description: 'This method will update the Document Requirement Ids linked to an existing Document Model


        Required permissions:

        At least one of the following permissions is required: DocumentManagementEdit, DocumentManagementDelete'
      operationId: deal/UpdateDataKey
      parameters:
      - name: id
        in: path
        description: The Id of the existing model to update
        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: The datakey of requirement to update the document model with
        content:
          application/json:
            schema:
              type: string
          text/json:
            schema:
              type: string
          application/*+json:
            schema:
              type: string
      responses:
        '202':
          description: Document Model updated successfully
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementcommand
  /api/v2/documentmanagement/{id}/updateDocumentUploadedByUserName:
    put:
      tags:
      - Document Model
      summary: Update the uploadedByUsername property of a document…
      description: This method will update the Document uploadedByUsername property of an existing Document Model
      operationId: UpdateDocumentUploadedByUserName
      parameters:
      - name: id
        in: path
        description: The Id of the existing model to update
        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:
        '202':
          description: Document Model updated successfully
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementcommand
  /api/v2/documentmanagement/{id}/archive:
    post:
      tags:
      - Document Model
      summary: Archive a document
      description: 'This method will archive an existing document by setting its status to Archived.


        Required permissions:

        At least one of the following permissions is required: DocumentManagementArchive, DocumentManagementArchiveV2'
      operationId: ArchiveDocument
      parameters:
      - name: id
        in: path
        description: The Id of the document to archive
        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: Archival Details
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ArchiveDocumentDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ArchiveDocumentDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ArchiveDocumentDtoServiceRequest'
      responses:
        '202':
          description: Document archived successfully
        '400':
          description: Bad request. The document was already archived or is linked to a mandatory requirement
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Document 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'
              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: /documentmanagementcommand
  /api/v2/documentmanagement/{id}/unarchive:
    post:
      tags:
      - Document Model
      summary: Unarchive a document
      description: 'This method will unarchive a previously archived document by restoring its status.


        Required permissions:

        At least one of the following permissions is required: DocumentManagementArchive, DocumentManagementUnarchive'
      operationId: UnarchiveDocument
      parameters:
      - name: id
        in: path
        description: The Id of the document to unarchive
        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:
        '202':
          description: Document unarchived successfully
        '400':
          description: Bad request. The document is not archived
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Document 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'
              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: /documentmanagementcommand
  /api/documentmanagement/journey/{journeyId}:
    get:
      tags:
      - Document Model
      summary: Get all documents by journey id
      description: 'This method will get the document data for the journey id and a tenant ID.


        Required permissions:

        Following permissions are required: DocumentManagementAccess'
      operationId: GetAllDocumentsByJourneyId
      parameters:
      - name: journeyId
        in: path
        description: Journey id
        required: true
        schema:
          type: string
          format: uuid
      - name: deduplicationEnabled
        in: query
        description: Indicates if the documents returned should be deduplicated.
        schema:
          type: boolean
          default: false
      - 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: "A list of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentModelDto class representing the document metadata with the specified \n            journeyId, if found; otherwise, `null`."
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DocumentModelDtoIEnumerableServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentModelDtoIEnumerableServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/DocumentModelDtoIEnumerableServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementquery
  /api/documentmanagement/entity/{entityId}:
    get:
      tags:
      - Document Model
      summary: Get all documents by entity id
      description: 'This method will get the document data for the entity id and a tenant ID.


        Required permissions:

        Following permissions are required: DocumentManagementAccess'
      operationId: GetAllDocumentsByEntityId
      parameters:
      - name: entityId
        in: path
        description: Entity id
        required: true
        schema:
          type: string
          format: uuid
      - name: deduplicationEnabled
        in: query
        description: Indicates if the documents returned should be deduplicated.
        schema:
          type: boolean
          default: false
      - 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: "A list of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentModelDto class representing the document metadata with the specified \n            entityId, if found; otherwise, `null`."
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DocumentModelDtoIEnumerableServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentModelDtoIEnumerableServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/DocumentModelDtoIEnumerableServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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
      deprecated: true
    servers:
    - url: /documentmanagementquery
  /api/documentmanagement/entity/paged:
    post:
      tags:
      - Document Model
      summary: Retrieves paginated document models based on a specific entity ID and tenant ID
      description: 'This method fetches document models in a paginated manner for a given entity ID and tenant ID


        Required permissions:

        Following permissions are required: DocumentManagementAccess'
      operationId: GetPagedDocumentsByEntityId
      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: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PagedEntityDocumentsRequestDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PagedEntityDocumentsRequestDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PagedEntityDocumentsRequestDtoServiceRequest'
      responses:
        '200':
          description: A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsResponseDto object representing the paginated list of document metadata
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse'
        '400':
          description: Bad request. The request contains invalid values.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementquery
  /api/documentmanagement/entity/paged/status/lite:
    post:
      tags:
      - Document Model
      summary: Retrieves lightened paginated document models based on a specific entity ID…
      description: 'This method fetches lightened document models in a paginated manner for a given entity ID, tenant ID and status


        Required permissions:

        Following permissions are required: DocumentManagementAccess'
      operationId: GetPagedDocumentsByEntityIdAndStatusLite
      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: Paged entity documents request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest'
      responses:
        '200':
          description: A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsResponseDto object representing the paginated list of document metadata
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse'
        '400':
          description: Bad request. The request contains invalid values.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementquery
  /api/documentmanagement/entity/paged/lite/v2:
    post:
      tags:
      - Document Model
      summary: Retrieves paginated documents by entity ID using cursor-based pagination with…
      description: 'Required permissions:

        Following permissions are required: DocumentManagementAccess'
      operationId: GetPagedDocumentsLiteByEntityIdV2
      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: Request with EntityId, PageSize, PaginationToken (for next page), and optional Status/ExcludeStatus filter
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PagedEntityDocumentsWithFilterRequestDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PagedEntityDocumentsWithFilterRequestDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PagedEntityDocumentsWithFilterRequestDtoServiceRequest'
      responses:
        '200':
          description: A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsWithTokenResponseDto with Items and NextPageToken for the next page
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/PagedEntityDocumentsWithTokenResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/PagedEntityDocumentsWithTokenResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/PagedEntityDocumentsWithTokenResponseDtoServiceResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementquery
  /api/documentmanagement/entity/paged/status:
    post:
      tags:
      - Document Model
      summary: Retrieves paginated document models based on a specific entity ID, tenant ID…
      description: 'This method fetches document models in a paginated manner for a given entity ID, tenant ID and status


        Required permissions:

        Following permissions are required: DocumentManagementAccess'
      operationId: GetPagedDocumentsByEntityIdAndStatus
      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: Paged entity documents request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest'
      responses:
        '200':
          description: A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsResponseDto object representing the paginated list of document metadata
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse'
        '400':
          description: Bad request. The request contains invalid values.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementquery
  /api/documentmanagement/entity/paged/excludeStatus/lite:
    post:
      tags:
      - Document Model
      summary: Retrieves paginated lightened document models based on a specific entity ID and…
      description: 'This method lightened fetches document models in a paginated manner for a given entity ID and tenant ID, excluding documents with the specified status


        Required permissions:

        Following permissions are required: DocumentManagementAccess'
      operationId: GetPagedDocumentsByEntityIdExcludingStatusLite
      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: Paged entity documents request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest'
      responses:
        '200':
          description: A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsResponseDto object representing the paginated list of document metadata
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse'
        '400':
          description: Bad request. The request contains invalid values.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementquery
  /api/documentmanagement/entity/paged/excludeStatus:
    post:
      tags:
      - Document Model
      summary: Retrieves paginated document models based on a specific entity ID and tenant…
      description: 'This method fetches document models in a paginated manner for a given entity ID and tenant ID, excluding documents with the specified status


        Required permissions:

        Following permissions are required: DocumentManagementAccess'
      operationId: GetPagedDocumentsByEntityIdExcludingStatus
      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: Paged entity documents request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest'
      responses:
        '200':
          description: A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsResponseDto object representing the paginated list of document metadata
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse'
        '400':
          description: Bad request. The request contains invalid values.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementquery
  /api/documentmanagement/entity/paged/lite:
    post:
      tags:
      - Document Model
      summary: Retrieves paginated lite document models based on a specific entity ID and…
      description: 'This method fetches lightened document models in a paginated manner for a given entity ID and tenant ID


        Required permissions:

        Following permissions are required: DocumentManagementAccess'
      operationId: GetPagedDocumentsLiteByEntityId
      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: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PagedEntityDocumentsRequestDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PagedEntityDocumentsRequestDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PagedEntityDocumentsRequestDtoServiceRequest'
      responses:
        '200':
          description: A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsLiteResponseDto object representing the paginated list of lightened document metadata
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/PagedEntityDocumentsLiteResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/PagedEntityDocumentsLiteResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/PagedEntityDocumentsLiteResponseDtoServiceResponse'
        '400':
          description: Bad request. The request contains invalid values.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementquery
  /api/documentmanagement/entity/{entityId}/journey/{journeyId}:
    get:
      tags:
      - Document Model
      summary: Gets all Document Models for an Entity Id and Journey Id
      description: 'Required permissions:

        Following permissions are required: DocumentManagementAccess'
      operationId: GetAllModelsByEntityIdAndJourneyId
      parameters:
      - name: entityId
        in: path
        description: The entity identifier.
        required: true
        schema:
          type: string
          format: uuid
      - name: journeyId
        in: path
        description: The journey identifier.
        required: true
        schema:
          type: string
          format: uuid
      - name: deduplicationEnabled
        in: query
        description: Indicates if the documents returned should be deduplicated.
        schema:
          type: boolean
          default: false
      - 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: "A list of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentModelDto class representing the document models if found; \n            otherwise, `null`."
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DocumentModelDtoIEnumerableServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentModelDtoIEnumerableServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/DocumentModelDtoIEnumerableServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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: /documentmanagementquery
  /api/documentmanagement/signedurl/{id}:
    get:
      tags:
      - Document Model
      summary: Method to get a signed URL from S3
      description: 'This method will generate a URL that will allow the user to open the document in the browser.


        The URL is signed by the AWS S3 service and the token will expire in a short time.


        Required permissions:

        Following permissions are required: DocumentManagementAccess'
      operationId: GetSignedUrl
      parameters:
      - name: id
        in: path
        description: Id of document
        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: "An url to access the file uploaded for the document with the specified \n            id, if found; otherwise, `null`."
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not found. If no signed url is 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'
              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: /documentmanagementquery
  /api/documentmanagement/mimeTypesAllowed:
    get:
      tags:
      - Document Model
      summary: Get all supported mime types when uploading a file in the document requirements
      description: 'This method will return a list of supported mime types when uploading a file in the document requirements.


        Required permissions:

        Following permissions are required: DocumentManagementCreate'
      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: A list of string of mime types
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/StringIEnumerableServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/StringIEnumerableServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/StringIEnumerableServiceResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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
      operationId: getApiDocumentmanagementMimeTypesAllowed
      x-operation-id-source: derived
    servers:
    - url: /documentmanagementquery
  /api/documentmanagement/supportedFileExtensions:
    get:
      tags:
      - Document Model
      summary: Get supported file extensions
      description: Returns all supported file extensions that can be uploaded.
      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 supported file extensions
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/StringListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/StringListServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/StringListServiceResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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'
              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
      operationId: getApiDocumentmanagementSupportedFileExtensions
      x-operation-id-source: derived
    servers:
    - url: /documentmanagementquery
components:
  schemas:
    ValidationErrorModelListServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ValidationErrorModel'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
      example:
        data:
        - propertyName: data
          errorMessage: Data is required
          attemptedValue: ''
          errorCode: NotNullValidator
        messages:
        - message: Data is required
          type: Error
          errorCode: Error Code
    UpdateDocumentDto:
      type: object
      properties:
        documentType:
          type:
          - string
          - 'null'
          description: The type of the document
          example: Driver license
        friendlyName:
          type:
          - string
          - 'null'
          description: The friendly name of the document
        documentRequirementIds:
          uniqueItems: true
          type:
          - array
          - 'null'
          items:
            type: string
          description: Hash Set of Document Requirement Ids from FenX to link the document to document requirements
        documentDataKey:
          type:
          - string
          - 'null'
          description: String represented Document DataKey to uniquely identity a document requirement linked with multiple document models
          example: identificationDocuments
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: Custom document properties
          example:
            firstName:
              type: Single
              value: Tom
            dateOfBirth:
              type: Single
              value: '2021-07-15'
            address:
              type: Collection
              dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Ireland
                    city: Dublin
                    street: Mayor Street
                47010265-3b85-4407-be61-90d04525f020:
                  properties:
                    country: Ireland
                    city: Dublin
                    street: E Wall Rd
        skipStatusReset:
          type:
          - boolean
          - 'null'
          description: Optional flag to skip document requirement history status reset
        documentURL:
          type:
          - string
          - 'null'
          description: URL of the virtual file
      additionalProperties: false
      description: Properties to update the metadata related to an uploaded document
    UpdateDocumentFileResponseDto:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the document
          format: uuid
          example: baee4b61-7ebb-48b2-a44b-18ce814b703b
        status:
          type:
          - string
          - 'null'
          description: The status of the uploaded document
          example: Complete
        signedUrlToUpload:
          type:
          - string
          - 'null'
          description: Url to upload the file into S3 bucket
      additionalProperties: false
      description: Basic information from the upload document api.
    ValidationErrorModel:
      type: object
      properties:
        propertyName:
          type:
          - string
          - 'null'
        errorMessage:
          type:
          - string
          - 'null'
        attemptedValue: {}
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    UploadDocumentResponseDto:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the document
          format: uuid
          example: baee4b61-7ebb-48b2-a44b-18ce814b703b
        documentRequirementIds:
          uniqueItems: true
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of Document Requirement Ids that the document is linked to
        documentType:
          type:
          - string
          - 'null'
          description: The type of the document
          example: Driver license
        status:
          type:
          - string
          - 'null'
          description: The status of the uploaded document
          example: Complete
      additionalProperties: false
      description: Basic information from the upload document api.
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    PropertyDto:
      type: object
      properties:
        value:
          type:
          - string
          - 'null'
          description: The custom property value
          example: Ireland
        type:
          type:
          - string
          - 'null'
          description: The custom property type
          example: Country
        customTypeId:
          type: string
          description: The custom property type identifier
          format: uuid
          example: baee4b61-7ebb-48b2-a44b-18ce814b703b
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            type: object
          description: Nested properties that compose our custom property
          example:
            firstName:
              type: Single
              value: Tom
            dateOfBirth:
              type: Single
              value: '2021-07-15'
            address:
              type: Collection
              dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Ireland
                    city: Dublin
                    street: Mayor Street
                47010265-3b85-4407-be61-90d04525f020:
                  properties:
                    country: Ireland
                    city: Dublin
                    street: E Wall Rd
      additionalProperties: false
      description: Contains all the attributes needed in order to add custom fields to the document metadata
    UploadDocumentResponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/UploadDocumentResponseDto'
          description: Basic information from the upload document api.
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    UpdateDocumentDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/UpdateDocumentDto'
          description: Properties to update the metadata related to an uploaded document
      additionalProperties: false
    UpdateDocumentFileResponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/UpdateDocumentFileResponseDto'
          description: Basic information from the upload document api.
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ObjectServiceResponse:
      type: object
      properties:
        data: {}
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    StringServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    CreateSignedUrlToUploadFileResponseServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/CreateSignedUrlToUploadFileResponse'
          description: Basic information from the upload document api.
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    UpdateDocumentFileDtoV2ServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/UpdateDocumentFileDtoV2'
          description: Metadata needed to update a file.
      additionalProperties: false
    CreateVirtualDocResponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/CreateVirtualDocResponseDto'
          description: Basic information from the virtual document.
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    UpdateDocumentAccessLayersDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/UpdateDocumentAccessLayersDto'
      additionalProperties: false
    CreateSignedUrlToUploadFileMultipleRequirementsRequest:
      required:
      - entityId
      - fileName
      type: object
      properties:
        fileName:
          minLength: 1
          type: string
          description: Original file name
          example: passport.pdf
        entityId:
          minLength: 1
          type: string
          description: Entity Id from FenX to link the document with the entity
          example: e1809731-77df-4e72-98e7-0d314b7a5151
        journeyId:
          type:
          - string
          - 'null'
          description: Journey Id from FenX to link the document with the journey
          example: 61413fc2-0381-48f5-825b-225692f4d793
        documentType:
          type:
          - string
          - 'null'
          description: The type of the document
          example: Driver license
        friendlyName:
          type:
          - string
          - 'null'
          description: The friendly name of the document
        documentRequirements:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/DocumentRequirementDto'
          description: List of Document Requirements to be fulfilled by this document
        isDocumentForESignature:
          type:
          - boolean
          - 'null'
          description: Is the document for eSignature
          example: false
        comesFromESignatureProvider:
          type:
          - boolean
          - 'null'
          description: Does document come from eSignature provider
          example: false
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: Custom document properties.
          example:
            firstName:
              type: Single
              value: Tom
            dateOfBirth:
              type: Single
              value: '2021-07-15'
            address:
              type: Collection
              dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Ireland
                    city: Dublin
                    street: Mayor Street
                47010265-3b85-4407-be61-90d04525f020:
                  properties:
                    country: Ireland
                    city: Dublin
                    street: E Wall Rd
        accessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto'
          description: Document access layers. Can be only additive in relation to the PolicyEnforcedAccessLayers
        policyEnforcedAccessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto'
          description: Access layers enforced by policy. The minimal set of access layers. The property is immutable
        fileSize:
          type:
          - integer
          - 'null'
          description: The size of the file in bytes. Used to validate DocuSign size limits for eSignature documents.
          format: int64
          example: 1048576
      additionalProperties: false
      description: 'Metadata needed to create Document models to fulfill multiple requirements and generate signed Url to upload file.

        Contains all properties needed to fill the metadata of the document being uploaded.'
    CloneDocumentResponseDto:
      type: object
      properties:
        Id:
          type: string
          description: Id of the document that was cloned
          format: uuid
          example: dc30fd5b-120b-4aaa-bed7-8d8508e24de5
        DocumentDataKey:
          type:
          - string
          - 'null'
          description: The unique identifier of the document requirement defined in policy configuration
          example: identificationDocuments
        EntityId:
          type:
          - string
          - 'null'
          description: Id of the Entity the document is associated to
          example: 68e88ba4-f343-4ff9-8abf-0e7a876ddd29
        JourneyId:
          type:
          - string
          - 'null'
          description: Id of the journey the document is associated to
          example: 'false'
        DocumentRequirementIds:
          uniqueItems: true
          type:
          - array
          - 'null'
          items:
            type: string
          description: Hash Set of Document Requirement Ids from FenX to link the document to document requirements
        DocumentKey:
          type:
          - string
          - 'null'
          description: The Reference key for the physical File
          example: 18036e2d-9cd9-4f00-bce0-094fa5611e6d/11b4c7f6-32b9-4025-a57f-f003a9d93262_testFile.png
        documentType:
          type:
          - string
          - 'null'
          description: The type of the document
          example: Driver license
      additionalProperties: false
      description: Contains the Document Model Attributes to return from the document clone command
    AccessLayerDto:
      type: object
      properties:
        geographic:
          uniqueItems: true
          type:
          - array
          - 'null'
          items:
            type: string
          description: Collection of geographic access layers
          example:
          - Global
        businessRelated:
          uniqueItems: true
          type:
          - array
          - 'null'
          items:
            type: string
          description: Collection of business related access layers
          example:
          - Enterprise
      additionalProperties: false
      description: DTO representing access layers attached
    CreateSignedUrlToUploadFileRequestServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/CreateSignedUrlToUploadFileRequest'
          description: 'Metadata needed to create Document model and generate signed Url to upload file..

            Contains all properties needed to fill the metadata of the document being uploaded.'
      additionalProperties: false
    CloneDocumentModelRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/CloneDocumentModelRequestDto'
          description: Contains the Document Model Attributes needed to clone a document to fulfill a requirement
      additionalProperties: false
    CreateVirtualDocResponseDtoListServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CreateVirtualDocResponseDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    CreateSignedUrlToUploadFileRequest:
      required:
      - entityId
      - fileName
      type: object
      properties:
        fileName:
          minLength: 1
          type: string
          description: Original file name
          example: passport.pdf
        entityId:
          minLength: 1
          type: string
          description: Entity Id from FenX to link the document with the entity
          example: e1809731-77df-4e72-98e7-0d314b7a5151
        journeyId:
          type:
          - string
          - 'null'
          description: Journey Id from FenX to link the document with the journey
          example: 61413fc2-0381-48f5-825b-225692f4d793
        documentType:
          type:
          - string
          - 'null'
          description: The type of the document
          example: Driver license
        friendlyName:
          type:
          - string
          - 'null'
          description: The friendly name of the document
        documentRequirementIds:
          uniqueItems: true
          type:
          - array
          - 'null'
          items:
            type: string
          description: Hash Set of Document Requirement Ids from FenX to link the document to document requirements
        documentDataKey:
          type:
          - string
          - 'null'
          description: The unique identifier of the document requirement that the document is linked to
          example: identificationDocuments
        isDocumentForESignature:
          type:
          - boolean
          - 'null'
          description: Is the document for eSignature
          example: false
        comesFromESignatureProvider:
          type:
          - boolean
          - 'null'
          description: Does document come from eSignature provider
          example: false
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: Custom document properties.
          example:
            firstName:
              type: Single
              value: Tom
            dateOfBirth:
              type: Single
              value: '2021-07-15'
            address:
              type: Collection
              dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Ireland
                    city: Dublin
                    street: Mayor Street
                47010265-3b85-4407-be61-90d04525f020:
                  properties:
                    country: Ireland
                    city: Dublin
                    street: E Wall Rd
        accessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto'
          description: Document access layers. Can be only additive in relation to the PolicyEnforcedAccessLayers
        policyEnforcedAccessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto'
          description: Access layers enforced by policy. The minimal set of access layers. The property is immutable
        autoClassify:
          type: boolean
          description: Indicates if document will be auto classified
          example: false
        metadata:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
          description: Additional Metadata in key-value form
        requirementModelId:
          type:
          - string
          - 'null'
          description: Id of the document requirement aggregate model the document is linked to
          format: uuid
          example: 4719bcc0-9a73-46ea-9857-5fe5edb97d63
        requestType:
          type:
          - string
          - 'null'
          description: 'Optional request type used to select document entity type (for example: Entity, Product, Deal, Screening)'
      additionalProperties: false
      description: 'Metadata needed to create Document model and generate signed Url to upload file..

        Contains all properties needed to fill the metadata of the document being uploaded.'
    CreateVirtualDocRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/CreateVirtualDocRequestDto'
          description: 'Metadata needed for a virtual document.

            Contains all properties needed to fill the metadata of the document.'
      additionalProperties: false
    UpdateDocumentAccessLayersDto:
      type: object
      properties:
        accessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto'
          description: Document access layers determining the access to the entity draft and related entity
      additionalProperties: false
    CreateVirtualDocMultipleReqsRequestDto:
      required:
      - documentURL
      - entityId
      - fileName
      type: object
      properties:
        fileName:
          minLength: 1
          type: string
          description: Original virtual file name
          example: passport.pdf
        entityId:
          minLength: 1
          type: string
          description: Entity Id from FenX to link the virtual document with the entity
          example: e1809731-77df-4e72-98e7-0d314b7a5151
        journeyId:
          type:
          - string
          - 'null'
          description: Journey Id from FenX to link the virtual document with the journey
          example: 61413fc2-0381-48f5-825b-225692f4d793
        documentType:
          type:
          - string
          - 'null'
          description: The type of the virtual document
          example: Driver license
        documentURL:
          minLength: 1
          type: string
          description: URL of the virtual file
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: Custom document properties.
          example:
            firstName:
              type: Single
              value: Tom
            dateOfBirth:
              type: Single
              value: '2021-07-15'
            address:
              type: Collection
              dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Ireland
                    city: Dublin
                    street: Mayor Street
                47010265-3b85-4407-be61-90d04525f020:
                  properties:
                    country: Ireland
                    city: Dublin
                    street: E Wall Rd
        accessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto'
          description: Document access layers. Can be only additive in relation to the PolicyEnforcedAccessLayers
        policyEnforcedAccessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto'
          description: Access layers enforced by policy. The minimal set of access layers. The property is immutable
        documentRequirements:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/DocumentRequirementDto'
          description: List of Document Requirements to be fulfilled by this document
      additionalProperties: false
      description: 'Metadata needed for a virtual document with multiple requirement.

        Contains all properties needed to fill the metadata of the document.'
    CloneDocumentModelRequestDto:
      type: object
      properties:
        Id:
          type: string
          description: Id of the document to be cloned
          format: uuid
          example: dc30fd5b-120b-4aaa-bed7-8d8508e24de5
        DocumentDataKey:
          type:
          - string
          - 'null'
          description: The unique identifier of the document requirement defined in policy configuration
          example: identificationDocuments
        EntityId:
          type:
          - string
          - 'null'
          description: Id of the Entity the document is associated to
          example: 68e88ba4-f343-4ff9-8abf-0e7a876ddd29
        JourneyId:
          type:
          - string
          - 'null'
          description: Id of the journey the document is associated to
          example: 9f4be7d2-7d50-4db0-86ab-750624f8ff7e
        DocumentRequirementIds:
          uniqueItems: true
          type:
          - array
          - 'null'
          items:
            type: string
          description: Hash Set of Document Requirement Ids from FenX to link the document to document requirements
        AccessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto'
          description: Document access layers determining the access to the entity draft and related entity
        requirementModelId:
          type:
          - string
          - 'null'
          description: Id of the requirement aggregate model the document is linked to
          format: uuid
          example: 4719bcc0-9a73-46ea-9857-5fe5edb97d63
        skipStatusReset:
          type:
          - boolean
          - 'null'
          description: Optional flag to skip document requirement history status reset
      additionalProperties: false
      description: Contains the Document Model Attributes needed to clone a document to fulfill a requirement
    UpdateDocumentStatusErrorDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/UpdateDocumentStatusErrorDto'
          description: Properties to update the status of an uploaded document with a custom error code and message
      additionalProperties: false
    UpdateDocumentFileDtoV2:
      required:
      - fileName
      - id
      type: object
      properties:
        id:
          minLength: 1
          type: string
          description: Id of the document
          example: e8854547-40af-478f-8013-cd10c13e7f94
        fileName:
          minLength: 1
          type: string
          description: Original file name
      additionalProperties: false
      description: Metadata needed to update a file.
    ArchiveAndReplaceDocumentRequestServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/ArchiveAndReplaceDocumentRequest'
          description: 'Metadata needed to create Document model and generate signed Url to upload file..

            Contains all properties needed to fill the metadata of the document being uploaded.'
      additionalProperties: false
    UpdateDocumentStatusErrorDto:
      type: object
      properties:
        errorCode:
          type:
          - string
          - 'null'
          description: 'The Error Code associaciated with an Error Status

            - NOT_APPLICABLE

            - INFECTED_FILE (Used along with Status Infected.Antivirus result)

            - INVALID_MIME_TYPE (Invalid file, MIME type/extension doesn''t match with the file)

            - CLIENT_SIDE_ERROR (An error happened on the client side while uploading the file)

            - SERVER_SIDE_ERROR (Internal server error during file processing)

            Fenergo.Nebula.DocumentManagement.Domain.Enum.DocumentErrorCode'
        errorMessage:
          type:
          - string
          - 'null'
          description: An Error message to be associated with an Error Status
      additionalProperties: false
      description: Properties to update the status of an uploaded document with a custom error code and message
    DocumentRequirementDto:
      type: object
      properties:
        Id:
          type: string
          description: The Id of the requirement the document requirement belongs to
          format: uuid
          example: dc30fd5b-120b-4aaa-bed7-8d8508e24de5
        RequirementId:
          type: string
          description: 'Alternative JSON property name for RequirementId to support internal generic lambda client implementations.

            Maps to the same underlying value as RequirementId.'
          format: uuid
        DocumentDataKey:
          type:
          - string
          - 'null'
          description: The unique identifier of the document requirement defined in policy configuration
          example: identificationDocuments
        DataKey:
          type:
          - string
          - 'null'
          description: 'Alternative JSON property name for DataKey to support internal generic lambda client implementations.

            Maps to the same underlying value as DataKey.'
        Name:
          type:
          - string
          - 'null'
          description: The Name of the document requirement defined in policy configuration
          example: Driver License
        RequirementName:
          type:
          - string
          - 'null'
          description: 'Alternative JSON property name for RequirementName to support internal generic lambda client implementations.

            Maps to the same underlying value as RequirementName.'
        IsMandatory:
          type: boolean
          description: IsMandatory attribute of the document requirement defined in policy configuration
          example: false
        DocumentAccessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto'
          description: Policy set access layers
        requirementModelId:
          type:
          - string
          - 'null'
          description: Id of the requirement aggregate model the document is linked to
          format: uuid
          example: 4719bcc0-9a73-46ea-9857-5fe5edb97d63
        targetEntity:
          type:
          - string
          - 'null'
          description: The target entity of the requirement
          example: Client
      additionalProperties: false
      description: Contains document requirement attributes need to be deserialized as input of Initialize Lambda
    CreateSignedUrlToUploadFileMultipleRequirementsRequestServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/CreateSignedUrlToUploadFileMultipleRequirementsRequest'
          description: 'Metadata needed to create Document models to fulfill multiple requirements and generate signed Url to upload file.

            Contains all properties needed to fill the metadata of the document being uploaded.'
      additionalProperties: false
    CloneDocumentResponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/CloneDocumentResponseDto'
          description: Contains the Document Model Attributes to return from the document clone command
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    CreateVirtualDocResponseDto:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the virtual document
          format: uuid
          example: bare4b61-7ebb-48b2-a44b-18ce814b703b
        documentRequirementIds:
          uniqueItems: true
          type:
          - array
          - 'null'
          items:
            type: string
          description: Hash Set of Document Requirement Ids from FenX to link the virtual document to document requirements
        documentDataKey:
          type:
          - string
          - 'null'
          description: The unique identifier of the document requirement that the virtual document is linked to
          example: identificationDocuments
        documentType:
          type:
          - string
          - 'null'
          description: Document type
          example: Driver license
      additionalProperties: false
      description: Basic information from the virtual document.
    DocumentRequirementBulkDto:
      type: object
      properties:
        Id:
          type: string
          description: The Id of the requirement the document requirement belongs to
          format: uuid
          example: dc30fd5b-120b-4aaa-bed7-8d8508e24de5
        RequirementId:
          type: string
          description: 'Alternative JSON property name for RequirementId to support internal generic lambda client implementations.

            Maps to the same underlying value as RequirementId.'
          format: uuid
        DocumentDataKey:
          type:
          - string
          - 'null'
          description: The unique identifier of the document requirement defined in policy configuration
          example: identificationDocuments
        DataKey:
          type:
          - string
          - 'null'
          description: 'Alternative JSON property name for DataKey to support internal generic lambda client implementations.

            Maps to the same underlying value as DataKey.'
        Name:
          type:
          - string
          - 'null'
          description: The Name of the document requirement defined in policy configuration
          example: Driver License
        RequirementName:
          type:
          - string
          - 'null'
          description: 'Alternative JSON property name for RequirementName to support internal generic lambda client implementations.

            Maps to the same underlying value as RequirementName.'
        IsMandatory:
          type: boolean
          description: IsMandatory attribute of the document requirement defined in policy configuration
          example: false
        DocumentAccessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto'
          description: Policy set access layers
        requirementModelId:
          type:
          - string
          - 'null'
          description: Id of the requirement aggregate model the document is linked to
          format: uuid
          example: 4719bcc0-9a73-46ea-9857-5fe5edb97d63
        targetEntity:
          type:
          - string
          - 'null'
          description: The target entity of the requirement
          example: Client
        DocumentId:
          type: string
          description: The Id of the document that is satisfying the requirement
          format: uuid
          example: dc30fd5b-120b-4aaa-bed7-8d8508e24de5
      additionalProperties: false
      description: Contains document requirement attributes set during the bulk upload for multiple requirements
    ArchiveDocumentDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/ArchiveDocumentDto'
          description: 'Metadata needed to archive a document.

            Contains all properties needed to fill to archive the document.'
      additionalProperties: false
    CreateSignedUrlToUploadFileMultipleRequirementsResponseServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/CreateSignedUrlToUploadFileMultipleRequirementsResponse'
          description: Basic information from the upload document api for multiple requirements
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    CreateVirtualDocMultipleReqsRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/CreateVirtualDocMultipleReqsRequestDto'
          description: 'Metadata needed for a virtual document with multiple requirement.

            Contains all properties needed to fill the metadata of the document.'
      additionalProperties: false
    CreateVirtualDocRequestDto:
      required:
      - documentURL
      - entityId
      - fileName
      type: object
      properties:
        fileName:
          minLength: 1
          type: string
          description: Original virtual file name
          example: passport.pdf
        entityId:
          minLength: 1
          type: string
          description: Entity Id from FenX to link the virtual document with the entity
          example: e1809731-77df-4e72-98e7-0d314b7a5151
        journeyId:
          type:
          - string
          - 'null'
          description: Journey Id from FenX to link the virtual document with the journey
          example: 61413fc2-0381-48f5-825b-225692f4d793
        documentType:
          type:
          - string
          - 'null'
          description: The type of the virtual document
          example: Driver license
        documentURL:
          minLength: 1
          type: string
          description: URL of the virtual file
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: Custom document properties.
          example:
            firstName:
              type: Single
              value: Tom
            dateOfBirth:
              type: Single
              value: '2021-07-15'
            address:
              type: Collection
              dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Ireland
                    city: Dublin
                    street: Mayor Street
                47010265-3b85-4407-be61-90d04525f020:
                  properties:
                    country: Ireland
                    city: Dublin
                    street: E Wall Rd
        accessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto'
          description: Document access layers. Can be only additive in relation to the PolicyEnforcedAccessLayers
        policyEnforcedAccessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto'
          description: Access layers enforced by policy. The minimal set of access layers. The property is immutable
        documentDataKey:
          type:
          - string
          - 'null'
          description: String represented Document DataKey to uniquely identity a document requirement linked with multiple document models
          example: identificationDocuments
        documentRequirementIds:
          uniqueItems: true
          type:
          - array
          - 'null'
          items:
            type: string
          description: Hash Set of Document Requirement Ids from FenX to link the document to document requirements
      additionalProperties: false
      description: 'Metadata needed for a virtual document.

        Contains all properties needed to fill the metadata of the document.'
    ArchiveAndReplaceDocumentRequest:
      required:
      - archivalReason
      - documentToArchiveId
      - entityId
      - fileName
      type: object
      properties:
        fileName:
          minLength: 1
          type: string
          description: Original file name
          example: passport.pdf
        entityId:
          minLength: 1
          type: string
          description: Entity Id from FenX to link the document with the entity
          example: e1809731-77df-4e72-98e7-0d314b7a5151
        journeyId:
          type:
          - string
          - 'null'
          description: Journey Id from FenX to link the document with the journey
          example: 61413fc2-0381-48f5-825b-225692f4d793
        documentType:
          type:
          - string
          - 'null'
          description: The type of the document
          example: Driver license
        friendlyName:
          type:
          - string
          - 'null'
          description: The friendly name of the document
        documentRequirementIds:
          uniqueItems: true
          type:
          - array
          - 'null'
          items:
            type: string
          description: Hash Set of Document Requirement Ids from FenX to link the document to document requirements
        documentDataKey:
          type:
          - string
          - 'null'
          description: The unique identifier of the document requirement that the document is linked to
          example: identificationDocuments
        isDocumentForESignature:
          type:
          - boolean
          - 'null'
          description: Is the document for eSignature
          example: false
        comesFromESignatureProvider:
          type:
          - boolean
          - 'null'
          description: Does document come from eSignature provider
          example: false
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: Custom document properties.
          example:
            firstName:
              type: Single
              value: Tom
            dateOfBirth:
              type: Single
              value: '2021-07-15'
            address:
              type: Collection
              dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Ireland
                    city: Dublin
                    street: Mayor Street
                47010265-3b85-4407-be61-90d04525f020:
                  properties:
                    country: Ireland
                    city: Dublin
                    street: E Wall Rd
        accessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto'
          description: Document access layers. Can be only additive in relation to the PolicyEnforcedAccessLayers
        policyEnforcedAccessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto'
          description: Access layers enforced by policy. The minimal set of access layers. The property is immutable
        autoClassify:
          type: boolean
          description: Indicates if document will be auto classified
          example: false
        metadata:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
          description: Additional Metadata in key-value form
        requirementModelId:
          type:
          - string
          - 'null'
          description: Id of the document requirement aggregate model the document is linked to
          format: uuid
          example: 4719bcc0-9a73-46ea-9857-5fe5edb97d63
        requestType:
          type:
          - string
          - 'null'
          description: 'Optional request type used to select document entity type (for example: Entity, Product, Deal, Screening)'
        documentToArchiveId:
          minLength: 1
          type: string
          description: The Id of the document to archive and replace
          example: dc30fd5b-120b-4aaa-bed7-8d8508e24de5
        archivalReason:
          minLength: 1
          type: string
          description: The reason of the archival and replacement of the document. This reason will be stored in the metadata of the archived document.
          example: Document Expired
      additionalProperties: false
      description: 'Metadata needed to create Document model and generate signed Url to upload file..

        Contains all properties needed to fill the metadata of the document being uploaded.'
    CreateSignedUrlToUploadFileResponse:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the document
          format: uuid
          example: baee4b61-7ebb-48b2-a44b-18ce814b703b
        documentRequirementIds:
          uniqueItems: true
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of Document Requirement Ids that the document is linked to
        documentDataKey:
          type:
          - string
          - 'null'
          description: The unique identifier of the document requirement that the document is linked to
          example: identificationDocuments
        documentType:
          type:
          - string
          - 'null'
          description: The type of the document
          example: Driver license
        status:
          type:
          - string
          - 'null'
          description: The status of the uploaded document
          example: Complete
        signedUrlToUpload:
          type:
          - string
          - 'null'
          description: Url to upload the file into S3 bucket
      additionalProperties: false
      description: Basic information from the upload document api.
    ArchiveDocumentDto:
      required:
      - archivalReason
      type: object
      properties:
        archivalReason:
          minLength: 1
          type: string
          description: The reason of the archival
      additionalProperties: false
      description: 'Metadata needed to archive a document.

        Contains all properties needed to fill to archive the document.'
    CreateSignedUrlToUploadFileMultipleRequirementsResponse:
      type: object
      properties:
        DocumentRequirements:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/DocumentRequirementBulkDto'
          description: List of Document Requirement properties that the document Models are linked to
        documentType:
          type:
          - string
          - 'null'
          description: The type of the document
          example: Driver license
        status:
          type:
          - string
          - 'null'
          description: The status of the uploaded document
          example: Complete
        signedUrlToUpload:
          type:
          - string
          - 'null'
          description: 'Presigned URL to upload the file into S3 bucket.

            When this response originates from the temporary document endpoint, the URL''s signature includes

            the `x-amz-tagging` header. The caller must include `x-amz-tagging: TTL=enabled` as an

            HTTP header in the PUT request, otherwise the upload will fail with a 403 error.'
        warnings:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of warnings generated during document upload (e.g., DocuSign size limit warnings)
      additionalProperties: false
      description: Basic information from the upload document api for multiple requirements
    PagedEntityDocumentsResponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/PagedEntityDocumentsResponseDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    PagedEntityDocumentsWithTokenResponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/PagedEntityDocumentsWithTokenResponseDto'
          description: Response DTO for cursor-based paginated document results
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    AccessLayerDto_2:
      type: object
      properties:
        geographic:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Collection of geographic access layers
          example:
          - Global
        businessRelated:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Collection of business related access layers
          example:
          - Enterprise
      additionalProperties: false
      description: DTO representing access layers attached
    DocumentModelDtoIEnumerableServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/DocumentModelDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    PagedEntityDocumentsWithFilterRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/PagedEntityDocumentsWithFilterRequestDto'
          description: 'Request DTO for paginated documents by entity ID with optional status filter.

            Uses DynamoDB cursor-based pagination via PaginationToken.'
      additionalProperties: false
    PagedEntityDocumentsLiteResponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/PagedEntityDocumentsLiteResponseDto'
          description: Represents a paginated response containing simplified document models for an entity
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    PagedEntityDocumentsResponseDto:
      type: object
      properties:
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/DocumentModelDto'
          description: The items result set
        itemsCount:
          type: integer
          description: The count of the items result set
          format: int32
        totalPagedItemsReturned:
          type: integer
          description: The number of items returned collectively
          format: int32
        hasMoreItems:
          type: boolean
          description: Indicates if there is any more items to retrieve
      additionalProperties: false
    DocumentModelLiteDto:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the document
          format: uuid
          example: baee4b61-7ebb-48b2-a44b-18ce814b703b
        fileName:
          type:
          - string
          - 'null'
          description: File name
        documentRequirementIds:
          uniqueItems: true
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of Document Requirement Ids that the document is linked to
        documentDataKey:
          type:
          - string
          - 'null'
          description: The unique identifier of the document requirement that the document is linked to
          example: identificationDocuments
        documentType:
          type:
          - string
          - 'null'
          description: Document type
          example: Driver license
        documentKey:
          type:
          - string
          - 'null'
          description: The Reference key for the physical File
          example: 18036e2d-9cd9-4f00-bce0-094fa5611e6d/11b4c7f6-32b9-4025-a57f-f003a9d93262_testFile.png
        status:
          type:
          - string
          - 'null'
          description: The status of the uploaded document
          example: Complete
        errorCode:
          type:
          - string
          - 'null'
          description: 'The Error Code associated with an Error Status

            Fenergo.Nebula.DocumentManagement.Domain.Enum.DocumentErrorCode<example>INVALID_MIME_TYPE</example>'
        errorMessage:
          type:
          - string
          - 'null'
          description: An Error message to be associated with an Error Status
        journeyId:
          type:
          - string
          - 'null'
          description: The Id of the journey the Document is uploaded against
          example: 69f0009b-d80d-4469-997f-708147190e1d
        entityId:
          type:
          - string
          - 'null'
          description: The Id of the entity the Document is uploaded against
          example: 69f0009b-d80d-4469-997f-708147190e1d
        accessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto_2'
          description: Document access layers. Can be only additive in relation to the PolicyEnforcedAccessLayers
        policyEnforcedAccessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto_2'
          description: Access layers enforced by policy. The minimal set of access layers. The property is immutable
        hasRequiredAccessLayers:
          type: boolean
          description: 'Flag indicating if current user has required access layers to access document model

            If false, the sensitive properties with be masked by replacing with null or empty values'
        uploadedBy:
          type:
          - string
          - 'null'
          description: Identifier of user who uploaded the document
          example: 9dee5f0c-08a3-4cb2-83bf-514c75d324ef
        uploadedByUserName:
          type:
          - string
          - 'null'
          description: UserName of user who uploaded the document
          example: user@fenergo.com
        uploadedOn:
          type:
          - string
          - 'null'
          description: Date and time the document was uploaded on
          format: date-time
          example: '2023-04-03T14:30:00.000Z'
        lastUpdatedOn:
          type:
          - string
          - 'null'
          description: Date and time the document was last updated on
          format: date-time
          example: '2023-04-03T14:30:00.000Z'
        lastUpdatedBy:
          type:
          - string
          - 'null'
          description: Identifier of user who last updated the document
          example: 9dee5f0c-08a3-4cb2-83bf-514c75d324ef
        documentURL:
          type:
          - string
          - 'null'
          description: URL of the virtual file
        isVirtual:
          type: boolean
          description: Flag indicating whether the document is virtual
          readOnly: true
        additionalDocumentMetadata:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
          description: 'Additional document metadata columns with their values

            List of tuples containing column name and its value'
        archivalReason:
          type:
          - string
          - 'null'
          description: The reason of the archival
        preArchivalStatus:
          type:
          - string
          - 'null'
          description: The status before the archival
        deletionRequestedBy:
          type:
          - string
          - 'null'
          description: Identifier of user who requested deletion
        deletionRequestedReason:
          type:
          - string
          - 'null'
          description: Reason provided when deletion was requested
        deletionRequestedOn:
          type:
          - string
          - 'null'
          description: Date and time when deletion was requested
          format: date-time
        expiredDate:
          type:
          - string
          - 'null'
          description: The document expiration date
          format: date-time
        explanation:
          type:
          - string
          - 'null'
          description: The explanation
      additionalProperties: false
      description: Represents a simplified version of document model data transfer object
    PagedEntityDocumentsWithFilterRequestDto:
      type: object
      properties:
        entityId:
          type: string
          description: The entity ID that the documents are associated with
          format: uuid
        pageSize:
          type: integer
          description: The size of the page (number of items to return)
          format: int32
        paginationToken:
          type:
          - string
          - 'null'
          description: The pagination token from the previous response. Omit for the first page.
        additionalColumns:
          type:
          - array
          - 'null'
          items:
            type: string
          description: 'Additional columns to be fetched. When omitted from the request body, defaults to an empty list.

            An explicit JSON `null` value is treated as empty by the query handler.

            These are merged (case-insensitive, deduplicated) with the tenant-level

            AdditionalDocumentMetadataColumnsDataKeys from DocumentConfiguration.'
      additionalProperties: false
      description: 'Request DTO for paginated documents by entity ID with optional status filter.

        Uses DynamoDB cursor-based pagination via PaginationToken.'
    PagedEntityDocumentsStatusRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/PagedEntityDocumentsStatusRequestDto'
          description: Represents options for setting up the results page
      additionalProperties: false
    PagedEntityDocumentsLiteResponseDto:
      type: object
      properties:
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/DocumentModelLiteDto'
          description: Gets or sets the collection of simplified document models
        itemsCount:
          type: integer
          description: Gets or sets the number of items in the current page
          format: int32
        totalPagedItemsReturned:
          type: integer
          description: Gets or sets the total number of paged items returned
          format: int32
        hasMoreItems:
          type: boolean
          description: Gets or sets a value indicating whether there are more items available
      additionalProperties: false
      description: Represents a paginated response containing simplified document models for an entity
    DocumentModelDto:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the document
          format: uuid
          example: baee4b61-7ebb-48b2-a44b-18ce814b703b
        fileName:
          type:
          - string
          - 'null'
          description: File name
        documentRequirementIds:
          uniqueItems: true
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of Document Requirement Ids that the document is linked to
        documentDataKey:
          type:
          - string
          - 'null'
          description: The unique identifier of the document requirement that the document is linked to
          example: identificationDocuments
        documentType:
          type:
          - string
          - 'null'
          description: Document type
          example: Driver license
        documentKey:
          type:
          - string
          - 'null'
          description: The Reference key for the physical File
          example: 18036e2d-9cd9-4f00-bce0-094fa5611e6d/11b4c7f6-32b9-4025-a57f-f003a9d93262_testFile.png
        status:
          type:
          - string
          - 'null'
          description: The status of the uploaded document
          example: Complete
        errorCode:
          type:
          - string
          - 'null'
          description: 'The Error Code associated with an Error Status

            Fenergo.Nebula.DocumentManagement.Domain.Enum.DocumentErrorCode<example>INVALID_MIME_TYPE</example>'
        errorMessage:
          type:
          - string
          - 'null'
          description: An Error message to be associated with an Error Status
        journeyId:
          type:
          - string
          - 'null'
          description: The Id of the journey the Document is uploaded against
          example: 69f0009b-d80d-4469-997f-708147190e1d
        entityId:
          type:
          - string
          - 'null'
          description: The Id of the entity the Document is uploaded against
          example: 69f0009b-d80d-4469-997f-708147190e1d
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/Property'
          description: Custom document properties.
          example:
            firstName:
              type: Single
              value: Tom
            dateOfBirth:
              type: Single
              value: '2021-07-15'
            address:
              type: Collection
              dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Ireland
                    city: Dublin
                    street: Mayor Street
                47010265-3b85-4407-be61-90d04525f020:
                  properties:
                    country: Ireland
                    city: Dublin
                    street: E Wall Rd
        accessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto_2'
          description: Document access layers. Can be only additive in relation to the PolicyEnforcedAccessLayers
        policyEnforcedAccessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto_2'
          description: Access layers enforced by policy. The minimal set of access layers. The property is immutable
        hasRequiredAccessLayers:
          type: boolean
          description: 'Flag indicating if current user has required access layers to access document model

            If false, the sensitive properties with be masked by replacing with null or empty values'
        documentEntityType:
          allOf:
          - $ref: '#/components/schemas/DocumentEntityType'
          description: The type of the Entity.
        uploadedBy:
          type:
          - string
          - 'null'
          description: Identifier of user who uploaded the document
          example: 9dee5f0c-08a3-4cb2-83bf-514c75d324ef
        uploadedByUserName:
          type:
          - string
          - 'null'
          description: UserName of user who uploaded the document
          example: user@fenergo.com
        uploadedOn:
          type:
          - string
          - 'null'
          description: Date and time the document was uploaded on
          format: date-time
          example: '2023-04-03T14:30:00.000Z'
        lastUpdatedOn:
          type:
          - string
          - 'null'
          description: Date and time the document was last updated on
          format: date-time
          example: '2023-04-03T14:30:00.000Z'
        lastUpdatedBy:
          type:
          - string
          - 'null'
          description: Identifier of user who last updated the document
          example: 9dee5f0c-08a3-4cb2-83bf-514c75d324ef
        metadata:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
          description: Additional Metadata in key-value form
        explanation:
          type:
          - string
          - 'null'
          description: Explains why given category has been assigned to document
        documentURL:
          type:
          - string
          - 'null'
          description: URL of the virtual file
        isVirtual:
          type: boolean
          description: Flag indicating whether the document is virtual
          readOnly: true
        archivalReason:
          type:
          - string
          - 'null'
          description: The reason of the archival
        preArchivalStatus:
          type:
          - string
          - 'null'
          description: The status before the archival
        deletionRequestedBy:
          type:
          - string
          - 'null'
          description: Identifier of user who requested deletion
        deletionRequestedReason:
          type:
          - string
          - 'null'
          description: Reason provided when deletion was requested
        deletionRequestedOn:
          type:
          - string
          - 'null'
          description: Date and time when deletion was requested
          format: date-time
        isCloned:
          type: boolean
          description: Indicates whether the document was brought forward (cloned) from a prior journey
        clonedFromDocumentModelId:
          type:
          - string
          - 'null'
          description: The Id of the document model this was cloned from, if applicable
          format: uuid
      additionalProperties: false
      description: Document metadata
    DocumentEntityType:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          readOnly: true
        id:
          type: integer
          format: int32
          readOnly: true
      additionalProperties: false
    PagedEntityDocumentsStatusRequestDto:
      type: object
      properties:
        entityId:
          type: string
          description: Gets or sets the entity ID that the documents are associated with
          format: uuid
          example: 8e7c1e5d-3875-2c81-a2ae-5506f9a98b75
        startIndex:
          type: integer
          description: Gets or sets the starting index for pagination or sublist operations
          format: int32
          example: 0
        pageSize:
          type: integer
          description: Gets or sets the size of the page (result set)
          format: int32
          example: 1000
        deduplicationEnabled:
          type: boolean
          description: Gets or sets a flag indicating whether deduplication of document models is to be applied
          example: false
        status:
          type:
          - string
          - 'null'
          description: Gets or sets a document status to be either excluded or included based on the query type
          example: Processing | Completed | Auto Classifying
      additionalProperties: false
      description: Represents options for setting up the results page
    Property:
      type: object
      properties:
        value:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        customTypeId:
          type: string
          format: uuid
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/Property'
          example:
            firstName:
              type: Single
              value: Tom
            dateOfBirth:
              type: Single
              value: '2021-07-15'
            address:
              type: Collection
              dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Ireland
                    city: Dublin
                    street: Mayor Street
                47010265-3b85-4407-be61-90d04525f020:
                  properties:
                    country: Ireland
                    city: Dublin
                    street: E Wall Rd
      additionalProperties: false
    DocumentModelDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/DocumentModelDto'
          description: Document metadata
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    PagedEntityDocumentsWithTokenResponseDto:
      type: object
      properties:
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/DocumentModelLiteDto'
          description: The items result set
        itemsCount:
          type: integer
          description: The count of items in this page
          format: int32
        nextPageToken:
          type:
          - string
          - 'null'
          description: Token to use for requesting the next page. Null when no more pages available.
        hasMoreItems:
          type: boolean
          description: Indicates if there are more items to retrieve
          readOnly: true
        errorMessage:
          type:
          - string
          - 'null'
          description: Error message if the query failed. Null when successful.
      additionalProperties: false
      description: Response DTO for cursor-based paginated document results
    StringIEnumerableServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            type: string
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    PagedEntityDocumentsRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/PagedEntityDocumentsRequestDto'
          description: Represents options for setting up the results page
      additionalProperties: false
    StringListServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            type: string
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    PagedEntityDocumentsRequestDto:
      type: object
      properties:
        entityId:
          type: string
          description: Gets or sets the entity ID that the documents are associated with
          format: uuid
          example: 8e7c1e5d-3875-2c81-a2ae-5506f9a98b75
        startIndex:
          type: integer
          description: Gets or sets the starting index for pagination or sublist operations
          format: int32
          example: 0
        pageSize:
          type: integer
          description: Gets or sets the size of the page (result set)
          format: int32
          example: 1000
        deduplicationEnabled:
          type: boolean
          description: Gets or sets a flag indicating whether deduplication of document models is to be applied
          example: false
      additionalProperties: false
      description: Represents options for setting up the results page
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header
x-refined-from:
- fenergo-documentmanagementcommand-v1-0-openapi.json
- fenergo-documentmanagementcommand-v2-0-openapi.json
- fenergo-documentmanagementquery-v1-0-openapi.json